Let's build something great together

When you build integrations with ActiveCampaign, you can have a positive impact on small businesses across the world. This is where you can find ActiveCampaign API documentation, SDKs, support, and a community of developers like you.

Get Started    

Overview

 

Version 3 of the ActiveCampaign API is structured around REST, HTTP, and JSON. API endpoint URLs are organized around resources, such as contacts or deals. It uses HTTP methods for indicating the action to take on a resource, and HTTP status codes for expressing error states. Resources are represented in JSON following a conventional schema.

Version 1 of our API is still available here. We have no plans to sunset version 1 of our API at this time and if we ever do, we will provide plenty of advance notice to our community.

Base URL

 

The API is accessed using a base URL that is specific to your account. In the examples provided in this documentation, we use the URL youraccountname.api-us1.com as a stand-in for your real account API URL. Your API URL can be found in your account on the My Settings page under the "Developer" tab. In addition, URL paths should begin with /api/3 to specify version 3 of the API. Generally, the URL will be in the form https://<your-account>.api-us1.com/api/3/<resource>. All API calls should be made over HTTPS.

Authentication

 

All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Api-Token.

curl -H "Api-Token: YOUR_TOKEN" https://account.api-us1.com/api/3/

Your API key can be found in your account on the Settings page under the "Developer" tab. Each user in your ActiveCampaign account has their own unique API key.

Remember to keep your API key secret. Do not share it and take care not to expose it publicly in client-side code.

HTTP Methods

 

The v3 API uses standard HTTP methods for indicating the action to take on a resource.

Method
Action

GET

Retrieve a resource.

POST

Create a new resource.

PUT

Update a resource (including partial updates).

DELETE

Remove a resource.

Schema

 

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Single Resources

Individual resources are represented by top level member named after the resource in the singular form. Below is a representation of a single contact. This could be used in the body of a PUT request and it’s what would be returned in the body of a GET request.

{
    "contact": {
        "email": "jsmith@example.com",
        "firstName": "John",
        "lastName": "Smith"
    }
}

Collections

Collections of resources are represented by a top level member named after the resource in the plural form. Below is a representation of a collection of contacts.

{
    "contacts": [
        {
            "email": "jsmith@example.com",
            "firstName": "John",
            "lastName": "Smith"
        },
        {
            "email": "alice@example.com",
            "firstName": "Alice",
            "lastName": "Jones"
        }
    ],
    "meta": {
        "total": "2"
    }
}

Relationships

A resource may define relationships to other resources. The name of a relationship generally reflects the type of the related resource. The name will be singular if there is only one related resource or plural if there are many related resources.

Links

Resources may provide links to related resources by defining a member named “links” within the resource’s object representation. Links are defined as an object where the key name represents the name of the relationship and the value is a URL to the related resource(s). For example, here is a representation of a contact with links to the contact’s contact lists and the contact’s organization.

{
   "contact": {
       "id": 1,
       "email": "jsmith@example.com",
       "firstName": "John",
       "lastName": "Smith"
       "links": {
           "contactLists": "https://:account.api-us1.com/api/3/contacts/1/contactLists",
           "organization": "https://:account.api-us1.com/api/3/contacts/1/organization"
       }
   }
}

Sideloading

Related resources can be included in a response by setting the include query parameter to a comma delimited list of relationships. Nested relationships may also be included by using a period to chain together relationships. The resulting JSON will include collections for each type of resource and resources will have properties identifying their related resources. This is referred to as “sideloading”. Below is an example of request for contacts including related contact lists, lists and organization.

GET api/3/contacts?include=contactLists.list,organization

{
   "contacts": [
       {
           "id": 1,
           "email": "jsmith@example.com",
           "firstName": "John",
           "lastName": "Smith",
           "contactLists": [3,5],
           "organization": 7,
       }
   ],
   "contactLists": [
       {
           "id": 3,
           "list": 5
       },
       {
           "id": 6,
           "list": 10
       }
   ],
   "lists": [
       {
           "id": 5,
           "name": "Monthly Newsletter"
       },
       {
           "id": 10,
           "name": "Daily Deals"
       }
   ],
   "organization": [
       {
           "id": 7,
           "name": "ActiveCampaign"
       }
   ]
}

Meta

Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.

GET api/3/contacts?limit=2

{
   "contacts": [
       {
           "id": 1,
           "email": "jsmith@example.com",
           "firstName": "John",
           "lastName": "Smith"
       },
       {
           "id": 2,
           "email": "alice@example.com",
           "firstName": "Alice",
           "lastName": "Jones"
       }
 ],
 "meta": {
    "total": 36
  }
}

Pagination, Ordering, and Filtering

 

Pagination

Endpoints that return collections of resources must limit the number of records returned in a given response. The query parameter limit can be used to alter the number of records returned. A typical endpoint will return 20 records by default and will allow a maximum of 100 records to be returned. The query parameter offset can be used to offset the result set. These query parameters can be combined to recover all records in a collection through a series of requests by incrementing the offset by the value of limit with each request.

Parameter
Description

limit

The number of results to display in each page (default = 20; max = 100).

offset

The starting point for the result set of a page. This is a zero-based index. For example, if there are 39 total records and the limit is the default of 20, use offset=20 to get the second page of results.

The total number of results in a collection can be found in the meta.total property of the response.

Ordering

The orders parameter is available to apply multiple sorting criteria to a request. The parameter is set as an array where the key is the field to be sorted by and the value is the direction of sort, either ASC or DESC. Not all fields are available for ordering. The order in which sorting criteria is applied reflects the order in which the parameters are set in the query string. In the example below the results are first sorted by the contacts last name, and then sorted by the contacts email address.

GET api/3/contacts?orders[lastName]=ASC&orders[email]=DESC

{
   "contacts": [
       {
           "email": "janderson@example.com",
           "firstName": "John",
           "lastName": "Anderson"
       },
       {
           "email": "banderson@example.com",
           "firstName": "Brian",
           "lastName": "Anderson"
       },
       {
           "email": "alice@example.com",
           "firstName": "Alice",
           "lastName": "Jones"
       }
 ]
}

Filtering

The filters query parameter is available to apply multiple, convention oriented filters to a request. The parameter is set as an array where the key is the field to be filtered by and the value is the value to filter by. Not all fields are available for filtering in this way. Field filters will match on “equals” or “contains” on a case by case basis, as configured in the API endpoint. In the example below the results are filtered to goals in automation 5 with a name that contains “ecom”.

GET api/3/goals?filters[seriesid]=5&filters[name]=ecom

{
   "goals": [
       {
           "name": "Recommended to Friend",
           "automation": "5"
       },
       {
           "name": "Power Ecom User",
           "automation": "5"
       }
   ]
}

Errors

 

The API uses HTTP status codes to indicate an error has occurred while processing a request. There are three main error status codes used by the API:

Code
Description

403

The request could not be authenticated or the authenticated user is not authorized to access the requested resource.

404

The requested resource does not exist.

422

The request could not be processed, usually due to a missing or invalid parameter.

In the case of 422 errors the response will also include an error object with an explanation of fields that are missing or invalid. Here is an example:

HTTP/1.1 422 Unprocessable Entity

{
  "errors": [
    {
      "title": "The connection service was not provided."
    },
    {
      "title": "The connection externalid was not provided."
    }
  ]
}

Rate Limits

 

Our API has a rate limit of 5 requests per second per account.

Accounts

 

Create an account

Create a new account

 
posthttps://youraccountname.api-us1.com/api/3/accounts
{
  "account": {
    "name": "Exmaple Account",
    "accountUrl": "https://www.example.com"
  }
}
A binary file was returned

You couldn't be authenticated

{
    "account": {
        "name": "Example Account",
        "accountUrl": "https://www.example.com",
        "createdTimestamp": "2019-06-12T16:52:16-05:00",
        "updatedTimestamp": "2019-06-12T16:52:16-05:00",
        "links": [],
        "id": "1"
    }
}
{
    "errors": [
        {
            "title": "The account name was not provided.",
            "detail": "",
            "code": "field_missing",
            "source": {
                "pointer": "/data/attributes/name"
            }
        }
    ]
}
{
    "errors": [
        {
            "title": "An account named \"Example Account\" already exists. Please choose a new name.",
            "detail": "",
            "code": "duplicate",
            "source": {
                "pointer": "/data/attributes/name"
            }
        }
    ]
}

Body Params

account
object
account.name
string
required

Account's name

account.accountUrl
string

Account's website

 

Retrieve an account

Retrieve an existing account

 
gethttps://youraccountname.api-us1.com/api/3/accounts/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accounts/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accounts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accounts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accounts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accounts/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "account": {
        "name": "Example Account",
        "accountUrl": "https://www.example.com",
        "createdTimestamp": "2019-05-15T15:58:16-05:00",
        "updatedTimestamp": "2019-05-15T15:58:16-05:00",
        "links": [],
        "id": "1"
    }
}

Path Params

id
int32
required

Account's ID

 

Update an account

Update an existing account

 
puthttps://youraccountname.api-us1.com/api/3/accounts/id
{
  "account": {
    "name": "Exmaple Account",
    "accountUrl": "https://www.example.com"
  }
}
A binary file was returned

You couldn't be authenticated

{
    "account": {
        "name": "Exmaple Account",
        "accountUrl": "https://www.example.com",
        "createdTimestamp": "2019-04-03T13:57:31-05:00",
        "updatedTimestamp": "2019-06-12T16:55:32-05:00",
        "links": [],
        "id": "1"
    }
}

Path Params

id
int32
required

Account's id

Body Params

account
object
account.name
string

Account's name

account.accountUrl
string

Account's website

 

Delete an account

Delete an existing account

 
deletehttps://youraccountname.api-us1.com/api/3/accounts/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/accounts/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/accounts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accounts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/accounts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accounts/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

id
int32
required

Account's id

 

List all accounts

Retrieve all existing account

 
gethttps://youraccountname.api-us1.com/api/3/accounts
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accounts
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accounts");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accounts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accounts": [
        {
            "name": "First Example Account",
            "accountUrl": null,
            "createdTimestamp": "2019-04-29T07:51:31-05:00",
            "updatedTimestamp": "2019-04-29T07:51:31-05:00",
            "contactCount": "1",
            "dealCount": "3",
            "links": [
                "notes": "https://:account.api-us1.com/api/:version/accounts/1/notes",
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accounts/1/accountCustomFieldData",
                "accountContacts": "https://:account.api-us1.com/api/:version/accounts/1/accountContacts"],
            "id": "1"
        },
        {
            "name": "Second Example Account",
            "accountUrl": null,
            "createdTimestamp": "2019-04-29T07:51:32-05:00",
            "updatedTimestamp": "2019-04-29T07:51:32-05:00",
            "contactCount": "2",
            "dealCount": "5",
            "links": [
                "notes": "https://:account.api-us1.com/api/:version/accounts/2/notes",
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accounts/2/accountCustomFieldData",
                "accountContacts": "https://:account.api-us1.com/api/:version/accounts/2/accountContacts"],
            "id": "2"
        }
    ]
}

Query Params

search
string

Search by name

 

Create an account note

Create a new note for an account

 
posthttps://youraccountname.api-us1.com/api/3/accounts/id/notes
{
  "note": {
    "note": "Note for the account"
  }
}
A binary file was returned

You couldn't be authenticated

{
  "accounts": [
    {
      "name": "Museuem of Science and Industry",
      "accountUrl": "www.msi.com",
      "createdTimestamp": "2019-04-03T13:29:35-05:00",
      "updatedTimestamp": "2019-06-12T16:59:54-05:00",
      "id": "1"
    }
  ],
  "note": {
    "cdate": "2017-05-31T09:54:30-05:00",
    "id": "2",
    "links": {
      "activities": "/api/3/notes/2/activities",
      "mentions": "/api/3/notes/2/mentions",
      "notes": "/api/3/notes/2/notes",
      "owner": "/api/3/notes/2/owner",
      "user": "/api/3/notes/2/user"
    },
    "mdate": "2017-05-31T09:54:30-05:00",
    "note": "Note for the account",
    "owner": {
      "id": "1",
      "type": "account"
    },
    "relid": "1",
    "reltype": "CustomerAccount",
    "user": "1",
    "userid": "1"
  }
}

Path Params

id
string
required

Account's id to assign new note to

Body Params

note
object
note.note
string
required

Account note's content

 

Update an account note

Update an existing note for a account

 
puthttps://youraccountname.api-us1.com/api/3/accounts/id/notes/noteid
{
  "note": {
    "note": "Update with more info"
  }
}
A binary file was returned

You couldn't be authenticated

{
  "accounts": [
    {
      "name": "Example Account",
      "accountUrl": "https://www.example.url",
      "createdTimestamp": "2019-04-03T13:29:35-05:00",
      "updatedTimestamp": "2019-06-12T16:59:54-05:00",
      "links": {
        "notes": "https://hosted.localdev/api/3/accounts/1/notes"
      },
      "id": "1"
    }
  ],
  "note": {
    "cdate": "2017-06-01T13:42:13-05:00",
    "id": "2",
    "links": {
      "activities": "/api/3/notes/2/activities",
      "mentions": "/api/3/notes/2/mentions",
      "notes": "/api/3/notes/2/notes",
      "owner": "/api/3/notes/2/owner",
      "user": "/api/3/notes/2/user"
    },
    "mdate": "2017-06-01T13:42:13-05:00",
    "note": "Update with more info",
    "owner": {
      "id": "1",
      "type": "account"
    },
    "relid": "1",
    "reltype": "CustomerAccount",
    "user": "1",
    "userid": "1"
  }
}

Path Params

id
string
required

Account's id to assign new note to

noteid
string
required

Account note's id to update

Body Params

note
object
note.note
string
required

Account note's content

 

Bulk delete accounts

Delete an existing account

 
deletehttps://youraccountname.api-us1.com/api/3/accounts/bulk_delete/
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/accounts/bulk_delete/
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/accounts/bulk_delete/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accounts/bulk_delete/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/accounts/bulk_delete/");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accounts/bulk_delete/"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

ids
array of integers
required

Array with integers representing ID's of accounts to be deleted

 

Account Contact Association

 

Create an association

Create a new account association

 
posthttps://youraccountname.api-us1.com/api/3/accountContacts
{
	"accountContact": {
		"contact": 2,
		"account": 1,
		"jobTitle": "Product Manager"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "accountContact": {
        "account": 2,
        "contact": 1,
        "jobTitle": "Product Manager",
        "createdTimestamp": "2019-06-26T10:49:10-05:00",
        "updatedTimestamp": "2019-06-26T10:49:10-05:00",
        "links": {
            "account": "http://hosted.localdev/api/3/accountContacts/2/account",
            "contact": "http://hosted.localdev/api/3/accountContacts/1/contact"
        },
        "id": "1"
    }
}
{
    "errors": [
        {
            "title": "The account attribute was not provided",
            "detail": "",
            "code": "field_missing",
            "source": {
                "pointer": "/data/attributes/account"
            }
        }
    ]
}
{
    "errors": [
        {
            "title": "This contact is already associated with an account. We currently do not support contacts on multiple accounts.",
            "detail": "",
            "code": "field_invalid",
            "source": {
                "pointer": "/data/attributes/account,contact"
            }
        }
    ]
}

Body Params

accountContact
object
accountContact.account
int32
required

Account ID

accountContact.contact
int32
required

Contact ID

accountContact.jobTitle
string

Job Title of the contact at the account

 

Please note that we currently allow single account per contact.

Retrieve an association

Retrieve an existing account association

 
gethttps://youraccountname.api-us1.com/api/3/accountContacts/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountContacts/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accountContacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountContacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountContacts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountContacts/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accountContact": {
        "account": "2",
        "contact": "1",
        "jobTitle": "Product Manager",
        "createdTimestamp": "2019-06-26T11:26:09-05:00",
        "updatedTimestamp": "2019-06-26T11:26:09-05:00",
        "links": {
            "account": "http://hosted.localdev/api/3/accountContacts/18/account",
            "contact": "http://hosted.localdev/api/3/accountContacts/18/contact"
        },
        "id": "18"
    },
    "meta": {
        "queryLog": {
            "queries": [
                {
                    "stmt": "SELECT  * FROM em_customer_account_subscriber t   WHERE 1 AND id = '18' LIMIT 0, 1",
                    "time": 0.31304359436035
                }
            ],
            "by_time": [
                {
                    "stmt": "SELECT  * FROM em_customer_account_subscriber t   WHERE 1 AND id = '18' LIMIT 0, 1",
                    "time": 0.31304359436035
                }
            ],
            "total": 0.31304359436035,
            "mode": "read/write"
        }
    }
}
{
    "message": "No Result found for CustomerAccountSubscriber with id 100"
}

Path Params

id
int32
required

Association's ID

 

Update an association

Update an existing account association

 
puthttps://youraccountname.api-us1.com/api/3/accountContacts/id
{
	"accountContact": {
		"jobTitle": "Product Manager"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "accountContact": {
        "account": "3",
        "contact": "2",
        "jobTitle": "CEO",
        "createdTimestamp": "2019-06-26T11:26:15-05:00",
        "updatedTimestamp": "2019-06-26T11:29:57-05:00",
        "links": {
            "account": "http://hosted.localdev/api/3/accountContacts/19/account",
            "contact": "http://hosted.localdev/api/3/accountContacts/19/contact"
        },
        "id": "19"
    }
}

Path Params

id
int32
required

Association's ID

Body Params

accountContact
object
accountContact.account
int32
required

Account ID

accountContact.contact
int32
required

Contact ID

accountContact.jobTitle
string

Job Title of the contact at the account

 

Please note that we currently allow single account per contact.

Delete an association

Delete an existing account association

 
deletehttps://youraccountname.api-us1.com/api/3/accountContacts/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/accountContacts/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/accountContacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountContacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/accountContacts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountContacts/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "No Result found for CustomerAccountSubscriber with id 100"
}

Path Params

id
int32
required

Association's ID

 

List all associations

Retrieve all existing account association

 
gethttps://youraccountname.api-us1.com/api/3/accountContacts
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountContacts
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/accountContacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountContacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountContacts");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountContacts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accountContacts": [
        {
            "account": "2",
            "contact": "3",
            "jobTitle": "Product Manager",
            "createdTimestamp": "2019-06-26T10:49:10-05:00",
            "updatedTimestamp": "2019-06-26T10:49:10-05:00",
            "links": {
                "account": "http://hosted.localdev/api/3/accountContacts/17/account",
                "contact": "http://hosted.localdev/api/3/accountContacts/17/contact"
            },
            "id": "17"
        },
        {
            "account": "2",
            "contact": "1",
            "jobTitle": "Product Manager",
            "createdTimestamp": "2019-06-26T11:26:09-05:00",
            "updatedTimestamp": "2019-06-26T11:26:09-05:00",
            "links": {
                "account": "http://hosted.localdev/api/3/accountContacts/18/account",
                "contact": "http://hosted.localdev/api/3/accountContacts/18/contact"
            },
            "id": "18"
        },
        {
            "account": "3",
            "contact": "2",
            "jobTitle": "Product Manager",
            "createdTimestamp": "2019-06-26T11:26:15-05:00",
            "updatedTimestamp": "2019-06-26T11:26:15-05:00",
            "links": {
                "account": "http://hosted.localdev/api/3/accountContacts/19/account",
                "contact": "http://hosted.localdev/api/3/accountContacts/19/contact"
            },
            "id": "19"
        }
    ],
    "meta": {
        "total": "3",
        "queryLog": {
            "queries": [
                {
                    "stmt": "SELECT  COUNT(DISTINCT t.id) AS `__count` FROM em_customer_account_subscriber t   WHERE 1",
                    "time": 0.3669261932373
                },
                {
                    "stmt": "SELECT  t.* FROM em_customer_account_subscriber t   WHERE 1 LIMIT 0, 20",
                    "time": 0.17809867858887
                }
            ],
            "by_time": [
                {
                    "stmt": "SELECT  COUNT(DISTINCT t.id) AS `__count` FROM em_customer_account_subscriber t   WHERE 1",
                    "time": 0.3669261932373
                },
                {
                    "stmt": "SELECT  t.* FROM em_customer_account_subscriber t   WHERE 1 LIMIT 0, 20",
                    "time": 0.17809867858887
                }
            ],
            "total": 0.54502487182617,
            "mode": "read/write"
        }
    }
}

Query Params

filters[contact]
int32

Filter by Contact ID

filters[account]
int32

Filter by Account ID

 

Custom Account Fields

 

Create a custom field

 
posthttps://youraccountname.api-us1.com/api/3/accountCustomFieldMeta
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample text field2",
		"fieldType": "text",
		"fieldDefault": "Default Text",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 1
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample textarea field",
		"fieldType": "textarea",
		"fieldDefault": "Default Text in Text Area",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 2
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample date field",
		"fieldType": "date",
		"fieldDefault": "2018-12-31 00:00:00",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 3
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample dropdown field",
		"fieldType": "dropdown",
		"fieldDefault": "option 2",
		"fieldOptions": [
			"option 1",
			"option 2",
			"option 3"
		],
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 4
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample multiselect field",
		"fieldType": "multiselect",
		"fieldDefault": [
			"option 2",
			"option 3"
		],
		"fieldOptions": [
			"option 1",
			"option 2",
			"option 3"
		],
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 5
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample radio field",
		"fieldType": "radio",
		"fieldDefault": "option 2",
		"fieldOptions": [
			"option 1",
			"option 2",
			"option 3"
		],
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 6
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample checkbox field",
		"fieldType": "checkbox",
		"fieldDefault": [
			"option 2",
			"option 3"
		],
		"fieldOptions": [
			"option 1",
			"option 2",
			"option 3"
		],
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 7
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample hidden field",
		"fieldType": "hidden",
		"fieldDefault": "Default Text in Hidden Field",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 8
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample number field",
		"fieldType": "number",
		"fieldDefault": "100.99",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 9
	}
}
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "sample money field",
		"fieldType": "currency",
		"fieldDefault": "10099",
		"fieldDefaultCurrency": "aud",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 10
	}
}

//currency default value is AUD$ 100.99
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldMetum": {
        "id": "1",
        "fieldLabel": "title",
        "fieldType": "text",
        "fieldOptions": null,
        "fieldDefault": "Default Text",
        "isFormVisible": 1,
        "isRequired": 1,
        "displayOrder": 1,
        "createdTimestamp": "2018-10-22 19:57:37",
        "updatedTimestamp": "2018-10-22 19:57:37",
        "links": {
            "accountCustomFieldData": "https://:account.api-us1.com/api/:version/3/accountCustomFieldMeta/1/accountCustomFieldData"
        }
    }
}
{
	"errors": [
  	"title": "The field type field is required.",
    "detail": "",
    "code": 422
  ]
}

Body Params

accountCustomFieldMetum
object
accountCustomFieldMetum.fieldLabel
string
required

Name of the field

accountCustomFieldMetum.fieldType
string
required

Type of field. Possible values are: text, textarea, date, dropdown, multiselect, radio, checkbox, hidden, currency, or number.

accountCustomFieldMetum.fieldOptions
array of strings

Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox.

accountCustomFieldMetum.fieldDefault
string

Default value of the field

accountCustomFieldMetum.fieldDefaultCurrency
string

The 3-letter currency code of the default currency for the field. Only necessary if field_type is currency.

accountCustomFieldMetum.isFormVisible
boolean

Whether or not the field is visible on forms

accountCustomFieldMetum.isRequired
boolean

Whether or not the field is required on forms

accountCustomFieldMetum.displayOrder
int32

Order for displaying the field on Manage Fields page and deal profiles

 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.

Retrieve a custom field

 
gethttps://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}
{
    "accountCustomFieldMetum": {
        "id": "1",
        "fieldLabel": "New Title",
        "fieldType": "text",
        "fieldOptions": null,
        "fieldDefault": "Default Text",
        "isFormVisible": 1,
        "isRequired": 1,
        "displayOrder": 1,
        "createdTimestamp": "2018-10-22 19:57:37",
        "updatedTimestamp": "2018-10-22 20:04:21",
        "links": {
            "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData"
        }
    }
}

Path Params

id
int32
required

ID of the field to retrieve

 

To retrieve a custom deal field, the following permissions are required.

  • Deal permission: the user should have permission to manage deals.
  • Pipeline-specific permission: the user should have permission to manage the pipeline that the deal belongs to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only id, title, and isDisabled set to 1.

Update a custom field

 
puthttps://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id
{	
	"accountCustomFieldMetum": {
		"fieldLabel": "New Title",
		"fieldDefault": "Default Text",
		"isFormVisible": 1,
		"isRequired": 1,
		"displayOrder": 1
	}
}
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldMetum": {
        "id": "1",
        "fieldLabel": "New Title",
        "fieldType": "text",
        "fieldOptions": null,
        "fieldDefault": "Default Text",
        "isFormVisible": 1,
        "isRequired": 1,
        "displayOrder": 1,
        "createdTimestamp": "2018-10-22 19:57:37",
        "updatedTimestamp": "2018-10-22 20:04:21",
        "links": {
            "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData"
        }
    }
}
{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

Path Params

id
int32
required

ID of the custom field to update

Body Params

accountCustomFieldMetum
object
accountCustomFieldMetum.fieldLabel
string

Name of the field

accountCustomFieldMetum.fieldOptions
array of strings

Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox.

accountCustomFieldMetum.fieldDefault
string

Default value of the field

accountCustomFieldMetum.isFormVisible
boolean

Whether or not the field is visible on forms

accountCustomFieldMetum.isRequired
boolean

Whether or not the field is required on forms

accountCustomFieldMetum.displayOrder
int32

Order for displaying the field on Manage Fields page and deal profiles

 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.

Delete a custom field

 
deletehttps://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "message": "AccountCustomFieldMeta deleted."
}
{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

Path Params

id
int32
required

ID of the field to delete

 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.

List all custom fields

 
gethttps://youraccountname.api-us1.com/api/3/accountCustomFieldMeta
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldMeta"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldMeta": [
        {
            "id": "1",
            "fieldLabel": "Text Example",
            "fieldType": "text",
            "fieldOptions": null,
            "fieldDefault": 1,
            "fieldDefaultCurrency": null,
            "isFormVisible": 0,
            "isRequired": 0,
            "displayOrder": 1,
            "personalization": "",
            "knownFieldId": null,
            "hideFieldFlag": 0,
            "createdTimestamp": "2019-04-23 15:34:00",
            "updatedTimestamp": "2019-05-03 15:16:51",
            "links": {
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData"
            }
        },
        {
            "id": "2",
            "fieldLabel": "Multiple Choice Example",
            "fieldType": "multiselect",
            "fieldOptions": [
            	"Option 1",
            	"Option 2",
            	"Option 3"
            ],
            "fieldDefault": 1,
            "fieldDefaultCurrency": null,
            "isFormVisible": 0,
            "isRequired": 0,
            "displayOrder": 2,
            "personalization": "",
            "knownFieldId": null,
            "hideFieldFlag": 0,
            "createdTimestamp": "2019-04-23 15:34:00",
            "updatedTimestamp": "2019-05-03 15:16:51",
            "links": {
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData"
            }
        }
    ]
}
 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.

Custom Account Field Values

 

Create a custom field value

 
posthttps://youraccountname.api-us1.com/api/3/accountCustomFieldData
{
	"accountCustomFieldDatum": {
		"accountId": "2",
		"customFieldId": "1",
		"fieldValue": "test title"
	}
}
{
	"accountCustomFieldDatum": {
		"customerAccountId": "2",
		"customFieldId": "2",
		"fieldValue": "option 1"
	}
}
// for multiple values
{
	"accountCustomFieldDatum": {
		"customerAccountId": "2",
		"customFieldId": "3",
		"fieldValue": [
			"option 1",
			"option 3",
			"option 4"
		]
	}
}

// for one value
{
	"accountCustomFieldDatum": {
		"customerAccountId": "2",
		"customFieldId": "3",
		"fieldValue": [
			"option 1"
		]
	}
}
{
	"accountCustomFieldDatum": {
		"customerAccountId": "1",
		"customFieldId": "4",
		"fieldValue": 9999,
		"fieldCurrency": "cad"
	}
}
{
	"accountCustomFieldDatum": {
		"customerAccountId": "1",
		"customFieldId": "5",
		"fieldValue": "100.99"
	}
}
// Allowed date formats are: YYYY-MM-DD, YYYY/MM/DD, or MM/DD/YYYY
{
	"accountCustomFieldDatum": {
		"customerAccountId": "1",
		"customFieldId": "6",
		"fieldValue": "2018-12-31"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldDatum": {
        "id": "5",
        "accountCustomFieldMetumId": 1,
        "accountId": 2,
        "customFieldId": 1,
        "createdTimestamp": "2018-11-06 02:27:05",
        "updatedTimestamp": "2018-11-06 02:27:05",
        "fieldValue": "test title",
        "links": {
            "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/5/account",
            "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/5/accountCustomFieldMetum"
        }
    }
}

Body Params

accountCustomFieldDatum
object
accountCustomFieldDatum.customerAccountId
int32
required

The ID of the account this field value relates to

accountCustomFieldDatum.customFieldId
int32
required

The ID of the custom field metum this field value relates to

accountCustomFieldDatum.fieldValue
string
required

Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)

accountCustomFieldDatum.fieldCurrency
string

Currency code for the money value

 

Bulk create a custom field value

 
posthttps://youraccountname.api-us1.com/api/3/accountCustomFieldData/bulkCreate
[
   {
       "accountId": "1",
       "customFieldId": "1",
       "fieldValue": "test title"
   },
   {
       "accountId": "1",
       "customFieldId": "2",
       "fieldValue": "test title"
   },
   {
       "accountId": "1",
       "customFieldId": "3",
       "fieldValue": [
          "option 1",
          "option 3",
          "option 4"
      ]
   },
   {
       "accountId": "1",
       "customFieldId": "4",
       "fieldValue": 9999,
       "fieldCurrency": "cad"
   },
   {
       "accountId": "1",
       "customFieldId": "5",
       "fieldValue": "100.99"
   },
   {
       "accountId": "1",
       "customFieldId": "6",
       "fieldValue": "2018-12-31"
   }
]
A binary file was returned

You couldn't be authenticated

{
    "message": "the bulk insert was successful"
}

Body Params

array
object
array.customerAccountId
int32
required

The ID of the account this field value relates to

array.customFieldId
int32
required

The ID of the custom field metum this field value relates to

array.fieldValue
string
required

Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)

array.fieldCurrency
string

Currency code for the money value

 

A note on the endpoint:
bulkCreate updates Last modified date of associated account. It is common case that collection items in bulkCreate request contains same accountId(s). So, the first item’s accountId only will be used for updating Last modified date of the account. Please note that If there are multiple different accounts provided in same bulkCreate request, not all of the account’s modified date will be updated.

Retrieve a custom field value

 
gethttps://youraccountname.api-us1.com/api/3/accountCustomFieldData/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldDatum": {
        "id": "1",
        "accountId": 2,
        "customFieldId": 5,
        "createdTimestamp": "2018-10-29 20:40:38",
        "updatedTimestamp": "2018-11-06 02:21:36",
        "fieldValue": "New title",
        "links": {
            "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account",
            "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum"
        }
    }
}
{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

Path Params

id
int32
required

ID of the dealCustomFieldData to retrieve

 

Update a custom field value

 
puthttps://youraccountname.api-us1.com/api/3/accountCustomFieldData/id
{
  "accountCustomFieldDatum" {
		"fieldValue": "New title"
  }
}
{
  "accountCustomFieldDatum" {
		"fieldValue": "option 1"
  }
}
// for multiple values
{
  "accountCustomFieldDatum" {
  	"fieldValue": [
    	"option 1",
    	"option 3",
    	"option 4"
  	]
  }
}

// for one value
{
  "accountCustomFieldDatum" {
  	"fieldValue": [
   		"option 1"
  	]
  }
}
{
  "accountCustomFieldDatum" {
  	"fieldValue": 9999,
  	"fieldCurrency": "cad"
  }
}
{
  "accountCustomFieldDatum" {
  	"fieldValue": "100.99"
  }
}
{
  "accountCustomFieldDatum" {
  	"fieldValue": "2018-12-31 00:00:00"
  }
}
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldDatum": {
        "id": "1",
        "accountId": 2,
        "customFieldId": 5,
        "createdTimestamp": "2018-10-29 20:40:38",
        "updatedTimestamp": "2018-11-06 02:21:36",
        "fieldValue": "New title",
        "links": {
            "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account",
            "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum"
        }
    }
}
{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

Path Params

id
int32
required

ID of the custom fields value to update

Body Params

accountCustomFieldDatum
object
accountCustomFieldDatum.fieldValue
string

Values for text

accountCustomFieldDatum.fieldCurrency
string

Currency code for the currency value

 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.
  • When updating a field value for a multivalued field (checkbox, multiselect), values must be strings in an array, e.g. ["Option 1", "Option 2", "Option 4"], whether one value or multiple are being set.

Delete a custom field value

 
deletehttps://youraccountname.api-us1.com/api/3/accountCustomFieldData/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldData/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "message": "AccountCustomFieldData deleted."
}
{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

Path Params

id
int32
required

ID of the dealCustomFieldData to retrieve

 

To create a custom account field, the following permissions are required.

  • Account permission: the user should have permission to manage account.

List all custom field values

 
gethttps://youraccountname.api-us1.com/api/3/accountCustomFieldData
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/accountCustomFieldData
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/accountCustomFieldData' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/accountCustomFieldData")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/accountCustomFieldData");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/accountCustomFieldData"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "accountCustomFieldData": [
        {
            "id": "3",
            "accountCustomFieldMetumId": 1,
            "accountId": 1,
            "customFieldId": 1,
            "createdTimestamp": "2018-11-06 02:26:07",
            "updatedTimestamp": "2018-11-06 02:26:07",
            "fieldValue": "test title",
            "links": {
                "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/3/account",
                "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/3/accountCustomFieldMetum"
            }
        },
        {
            "id": "4",
            "accountCustomFieldMetumId": 1,
            "accountId": 3,
            "customFieldId": 1,
            "createdTimestamp": "2018-11-06 02:26:51",
            "updatedTimestamp": "2018-11-06 02:26:51",
            "fieldValue": "test title",
            "links": {
                "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/4/account",
                "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/4/accountCustomFieldMetum"
            }
        },
        {
            "id": "5",
            "accountCustomFieldMetumId": 1,
            "accountId": 2,
            "customFieldId": 1,
            "createdTimestamp": "2018-11-06 02:27:05",
            "updatedTimestamp": "2018-11-06 02:27:05",
            "fieldValue": "test title",
            "links": {
                "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/5/account",
                "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/5/accountCustomFieldMetum"
            }
        },
        {
            "id": "1",
            "accountCustomFieldMetumId": 5,
            "accountId": 2,
            "customFieldId": 5,
            "createdTimestamp": "2018-10-29 20:40:38",
            "updatedTimestamp": "2018-11-06 02:21:36",
            "fieldValue": "New title",
            "links": {
                "account": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account",
                "accountCustomFieldMetum": "https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum"
            }
        }
    ]
}

Query Params

filters[customerAccountId]
string

Filter results by a specific account (note that Id uses a capital I)

 

Bulk update a custom field value

 
patchhttps://youraccountname.api-us1.com/api/3/accountCustomFieldData/bulkUpdate
[
   {
       "id": "1",
       "fieldValue": "test title"
   },
   {
       "id": "2",
       "fieldValue": [
          "option 1",
          "option 3",
          "option 4"
      ]
   },
   {
       "id": "3",
       "fieldValue": 9999,
       "fieldCurrency": "cad"
   },
   {
       "id": "4",
       "fieldValue": "100.99"
   },
   {
       "id": "5",
       "fieldValue": "2018-12-31"
   }
]
A binary file was returned

You couldn't be authenticated

{
    "message": "AccountCustomFieldDatas with ID(s): 1, 2, 3, 4, 5 successfully bulk updated."
}

Body Params

array
object
array.id
int32
required

ID of the dealCustomFieldData to update

array.fieldValue
string
required

Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)

array.fieldCurrency
string

Currency code for the money value

 

Addresses

Every campaign sent via ActiveCampaign is required to have a physical mailing address associated with it. The API enables you to create, update, and delete address resources, as well as associate an address with a specific list or user group.

 

Create an address

 
posthttps://youraccountname.api-us1.com/api/3/addresses
{
	"address": {
		"company_name": "TEST NAME",
		"address_1": "TEST ADDRESS",
		"country": "US"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "address": {
        "companyName": "TEST NAME",
        "address1": "TEST ADDRESS",
        "country": 3,
        "links": {
            "addressGroup": "https://:account.api-us1.com/api/3/addresses/3/addressGroup",
            "addressList": "https://:account.api-us1.com/api/3/addresses/3/addressList",
            "forms": "https://:account.api-us1.com/api/3/addresses/3/forms"
        },
        "id": "3"
    }
}

Body Params

address
object
address.groupid
int32
address.global
mixed type
address.company_name
string
required
address.address_1
string
required
address.address_2
string
address.city
string
address.state
string
address.zip
string
address.district
string

(Optional for countries that use it)

address.country
string
required

Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')

address.allgroup
int32
address.is_default
boolean

Indicates default address

 

Retrieve an address

 
gethttps://youraccountname.api-us1.com/api/3/addresses/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/addresses/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/addresses/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/addresses/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/addresses/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/addresses/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "address": {
        "companyName": "Test Company Name",
        "address1": "Test Address",
        "address2": "",
        "city": "",
        "state": "",
        "district": "",
        "zip": "",
        "country": "US",
        "allgroup": "0",
        "isDefault": "1",
        "links": {
            "addressGroup": "https://:account.api-us1.com/api/3/addresses/1/addressGroup",
            "addressList": "https://:account.api-us1.com/api/3/addresses/1/addressList",
            "forms": "https://:account.api-us1.com/api/3/addresses/1/forms"
        },
        "id": "1"
    }
}

Path Params

id
int32
required

ID of the Address to retrieve

 

Update an address

 
puthttps://youraccountname.api-us1.com/api/3/addresses/:id
{
	"address": {
        "companyName": "New Test Company Name",
        "address1": "111 New Test Address",
        "address2": "",
        "city": "New Test City",
        "state": "Florida",
        "zip": "12345",
    		"country": "US"
	}  
}
A binary file was returned

You couldn't be authenticated

{
    "address": {
        "companyName": "New Test Company Name",
        "address1": "111 New Test Address",
        "address2": "",
        "city": "New Test City",
        "state": "Florida",
        "district": "",
        "zip": "12345",
        "country": "US",
        "allgroup": "0",
        "isDefault": "1",
        "links": {
            "addressGroup": "https://:account.api-us1.com/api/3/addresses/1/addressGroup",
            "addressList": "https://:account.api-us1.com/api/3/addresses/1/addressList",
            "forms": "https://:account.api-us1.com/api/3/addresses/1/forms"
        },
        "id": "1"
    }
}
{
    "message": "No Result found for Address with id 3"
}

Path Params

ID
string
required

ID of the Address being changed

Body Params

address
object
address.groupid
int32
address.global
mixed type
address.company_name
string
required
address.address_1
string
required
address.address_2
string
address.city
string
address.state
string
address.zip
string
address.district
string

(Optional for countries that use it)

address.country
string
required

Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')

address.allgroup
int32
address.is_default
boolean

Indicates default address

 

Delete an address

 
deletehttps://youraccountname.api-us1.com/api/3/addresses/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/addresses/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/addresses/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/addresses/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/addresses/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/addresses/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "No Result found for Address with id 3"
}

Path Params

id
int32
required

ID of the Address to delete

 

Delete address associated with a specific user group

 
deletehttps://youraccountname.api-us1.com/api/3/addressGroups/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/addressGroups/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/addressGroups/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/addressGroups/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/addressGroups/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/addressGroups/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "No Result found for AddressGroup with id 19"
}

Path Params

id
int32
required

ID of the AddressGroup to delete

 

Delete address associated with a specific list

 
deletehttps://youraccountname.api-us1.com/api/3/addressLists/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/addressLists/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/addressLists/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/addressLists/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/addressLists/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/addressLists/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "No Result found for AddressList with id 6"
}

Path Params

id
int32
required

ID of the AddressList to delete

 

List all addresses

 
gethttps://youraccountname.api-us1.com/api/3/addresses
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/addresses
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/addresses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/addresses");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/addresses"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "addresses": [
        {
            "companyName": "Test Company Name",
            "address1": "Test Address",
            "address2": "",
            "city": "",
            "state": "",
            "district": "",
            "zip": "",
            "country": "US",
            "allgroup": "0",
            "isDefault": "1",
            "links": {
                "addressGroup": "https://:account.api-us1.com/api/3/addresses/1/addressGroup",
                "addressList": "https://:account.api-us1.com/api/3/addresses/1/addressList",
                "forms": "https://:account.api-us1.com/api/3/addresses/1/forms"
            },
            "id": "1"
        },
        {
            "companyName": "TEST NAME",
            "address1": "TEST ADDRESS",
            "address2": "",
            "city": "",
            "state": "",
            "district": "",
            "zip": "",
            "country": "US",
            "allgroup": "0",
            "isDefault": "0",
            "links": {
                "addressGroup": "https://:account.api-us1.com/api/3/addresses/2/addressGroup",
                "addressList": "https://:account.api-us1.com/api/3/addresses/2/addressList",
                "forms": "https://:account.api-us1.com/api/3/addresses/2/forms"
            },
            "id": "2"
        }
    ],
    "meta": {
        "total": "2"
    }
}
 

Automations

Automations allow you to automate marketing communications to your contacts, as well as business processes like deals moving between stages, tags being added/removed from contacts, notes being added/removed to deals/contacts, etc. At this time, it is not possible to create, edit, update, or delete automations via API.

 

List all automations

 
gethttps://youraccountname.api-us1.com/api/3/automations
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/automations
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/automations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/automations");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/automations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "automations": [
        {
            "name": "Email Subscription",
            "cdate": "2018-08-06T16:28:43-05:00",
            "mdate": "2018-08-06T16:33:10-05:00",
            "userid": "1",
            "status": "2",
            "entered": "0",
            "exited": "0",
            "hidden": "0",
            "defaultscreenshot": "http://img-us1.com/default-series.gif",
            "screenshot": "https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png",
            "links": {
                "campaigns": "https://:account.api-us1.com/api/3/automations/1/campaigns",
                "contactGoals": "https://:account.api-us1.com/api/3/automations/1/contactGoals",
                "contactAutomations": "https://:account.api-us1.com/api/3/automations/1/contactAutomations",
                "blocks": "https://:account.api-us1.com/api/3/automations/1/blocks",
                "goals": "https://:account.api-us1.com/api/3/automations/1/goals",
                "sms": "https://:account.api-us1.com/api/3/automations/1/sms",
                "sitemessages": "https://:account.api-us1.com/api/3/automations/1/sitemessages"
            },
            "id": "1"
        },
        {
            "name": "Test SMS Send",
            "cdate": "2018-09-18T10:46:32-05:00",
            "mdate": "2018-09-18T10:54:30-05:00",
            "userid": "1",
            "status": "1",
            "entered": "2",
            "exited": "2",
            "hidden": "0",
            "defaultscreenshot": "http://img-us1.com/default-series.gif",
            "screenshot": "https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png",
            "links": {
                "campaigns": "https://:account.api-us1.com/api/3/automations/2/campaigns",
                "contactGoals": "https://:account.api-us1.com/api/3/automations/2/contactGoals",
                "contactAutomations": "https://:account.api-us1.com/api/3/automations/2/contactAutomations",
                "blocks": "https://:account.api-us1.com/api/3/automations/2/blocks",
                "goals": "https://:account.api-us1.com/api/3/automations/2/goals",
                "sms": "https://:account.api-us1.com/api/3/automations/2/sms",
                "sitemessages": "https://:account.api-us1.com/api/3/automations/2/sitemessages"
            },
            "id": "2"
        }
    ],
    "meta": {
        "total": "2",
        "starts": [
            {
                "id": "2",
                "series": "1",
                "type": "subscribe"
            },
            {
                "id": "4",
                "series": "2",
                "type": "subscribe"
            }
        ],
        "filtered": false,
        "smsLogs": []
    }
}
 

Branding

 

Retrieve a branding

Retrieve an existing branding resource

 
gethttps://youraccountname.api-us1.com/api/3/brandings/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/brandings/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/brandings/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/brandings/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/brandings/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/brandings/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"branding": {
		"groupid": "3",
		"siteName": "ActiveCampaign Email Marketing",
		"siteLogo": "http:\/\/mysite.com\/logo.jpg",
		"siteLogoSmall": "http:\/\/mysite.com\/logo_small.jpg",
		"headerTextValue": "my custom text header",
		"headerHtmlValue": "<p>my custom HTML header<\/p>",
		"footerTextValue": "my custom text footer",
		"footerHtmlValue": "<p>my custom HTML footer<\/p>",
		"copyright": "1",
		"version": "1",
		"license": "1",
		"links": "1",
		"help": "1",
		"adminTemplateHtm": "",
		"adminTemplateCss": "",
		"publicTemplateHtm": "",
		"publicTemplateCss": "",
		"favicon": null,
		"id": "1"
	}
}

Path Params

id
int32
required
 

Update a branding

Update an existing branding resource

 
puthttps://youraccountname.api-us1.com/api/3/brandings/id
curl --request PUT \
  --url https://youraccountname.api-us1.com/api/3/brandings/1
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://youraccountname.api-us1.com/api/3/brandings/1' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/brandings/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://youraccountname.api-us1.com/api/3/brandings/1");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/brandings/1"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"branding": {
		"groupid": "3",
		"siteName": "ActiveCampaign Email Marketing",
		"siteLogo": "http:\/\/mysite.com\/logo.jpg",
		"siteLogoSmall": "http:\/\/mysite.com\/logo_small.jpg",
		"headerTextValue": "my custom text header",
		"headerHtmlValue": "<p>my custom HTML header<\/p>",
		"footerTextValue": "my custom text footer",
		"footerHtmlValue": "<p>my custom HTML footer<\/p>",
		"copyright": "1",
		"version": "1",
		"license": "1",
		"links": "1",
		"help": "1",
		"adminTemplateHtm": "",
		"adminTemplateCss": "",
		"publicTemplateHtm": "",
		"publicTemplateCss": "",
		"favicon": null,
		"id": "1"
	}
}

Path Params

id
int32
required

Branding ID

Body Params

branding
object
branding.groupid
int32

The group ID. This value will always be 3.

branding.siteName
string

Title of software. Example: 'ActiveCampaign Email Marketing'

branding.siteLogo
string
branding.siteLogoSmall
string

URL of small logo. Small logos appear in the header of the admin panel.

branding.headerTextValue
string

Content of non-removable header. Example: text header content

branding.headerHtmlValue
string

Content of non-removable header. Example:

header content here

branding.footerTextValue
string

Content of non-removeable footer. Example: text footer content

branding.footerHtmlValue
string

Content of non-removeable footer. Example:

footer content here

branding.copyright
boolean

unknown

branding.version
boolean

unknown

branding.license
boolean

unknown

branding.links
boolean

External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value.

branding.help
string
branding.adminTemplateHtm
string

The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)

branding.adminTemplateCss
string

The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)

branding.publicTemplateHtm
string

The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)

branding.publicTemplateCss
string

The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)

branding.favicon
string

URL of the favicon.

 

List all brandings

List all existing branding resources

 
gethttps://youraccountname.api-us1.com/api/3/brandings
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/brandings
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/brandings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/brandings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/brandings");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/brandings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "brandings": [
    {
		"groupid": "3",
		"siteName": "ActiveCampaign Email Marketing",
		"siteLogo": "http:\/\/mysite.com\/logo.jpg",
		"siteLogoSmall": "http:\/\/mysite.com\/logo_small.jpg",
		"headerTextValue": "my custom text header",
		"headerHtmlValue": "<p>my custom HTML header<\/p>",
		"footerTextValue": "my custom text footer",
		"footerHtmlValue": "<p>my custom HTML footer<\/p>",
		"copyright": "1",
		"version": "1",
		"license": "1",
		"links": "1",
		"help": "1",
		"adminTemplateHtm": "",
		"adminTemplateCss": "",
		"publicTemplateHtm": "",
		"publicTemplateCss": "",
		"favicon": null,
		"id": "1"
    }
  ],
  "meta": {
    "total": "1"
  }
}

Path Params

version
string
required

ActiveCampaign API version

Query Params

api_key
string

ActiveCampaign API key

 

Calendar Feeds

Calendar feeds allow users to sync ActiveCampaign tasks with Google Calendar, Apple Calendar, Microsoft Outlook, or any calendar client that supports subscription calendars. The API enables you to add, view, update, and delete calendar feeds.

 

More information on calendar feeds is available here.

Create a calendar feed

 
posthttps://youraccountname.api-us1.com/api/3/calendars
{
	"calendar": {
		"title": "Calendar Title",
		"type": "All",
		"notification": 1
	}
}
A binary file was returned

You couldn't be authenticated

{
    "calendar": {
        "title": "Calendar Title",
        "type": "All",
        "userid": "1",
        "notification": 1,
        "cdate": "2018-11-15T22:26:35-06:00",
        "mdate": "2018-11-15T22:26:35-06:00",
        "token": "5540950ac4ed4f11591db934b701aff8",
        "links": {
            "calendarRels": "https://:account.api-us1.com/api/:version/calendars/1/calendarRels",
            "calendarUsers": "https://:account.api-us1.com/api/:version/calendars/1/calendarUsers"
        },
        "id": "1"
    }
}

Body Params

calendar
object
calendar.title
string
required

Title of the calendar feed

calendar.type
string
required

Possible Values: 'All', 'Deals', or 'Contacts'

calendar.notification
boolean

Whether or not this calendar has notifications

 

Retrieve a calendar feed

 
gethttps://youraccountname.api-us1.com/api/3/calendars/:id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/calendars/:id
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/calendars/:id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/calendars/:id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/calendars/:id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/calendars/:id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "calendar": {
        "userid": "1",
        "title": "Calendar Title",
        "type": "All",
        "token": "5540950ac4ed4f11591db934b701aff8",
        "notification": "1",
        "cdate": "2018-11-15T22:26:35-06:00",
        "mdate": "2018-11-15T22:26:35-06:00",
        "links": {
            "calendarRels": "https://:account.api-us1.com/api/:version/calendars/1/calendarRels",
            "calendarUsers": "https://:account.api-us1.com/api/:version/calendars/1/calendarUsers"
        },
        "id": "1"
    }
}
{
    "message": "No Result found for Calendar with id 1"
}

Path Params

ID
int32
required

ID of the calendar feed to retrieve

 

Update a calendar feed

 
puthttps://youraccountname.api-us1.com/api/3/calendars/:id
{
	"calendar": {
		"title": "Calendar Title",
		"type": "Deals",
		"notification": 0
	}
}
A binary file was returned

You couldn't be authenticated

{
    "calendar": {
        "userid": "1",
        "title": "Calendar Title",
        "type": "Deals",
        "token": "5540950ac4ed4f11591db934b701aff8",
        "notification": 0,
        "cdate": "2018-11-15T22:26:35-06:00",
        "mdate": "2018-11-16T02:11:40-06:00",
        "links": {
            "calendarRels": "https://:account.api-us1.com/api/:version/calendars/1/calendarRels",
            "calendarUsers": "https://:account.api-us1.com/api/:version/calendars/1/calendarUsers"
        },
        "id": "1"
    }
}

Path Params

ID
int32
required

ID of the calendar feed to update

Body Params

calendar
object
calendar.title
string

Title of the calendar feed

calendar.type
string

Possible Values: 'All', 'Deals', or 'Contacts'

calendar.notification
boolean

Whether or not this calendar has notifications

 

Delete a calendar feed

 
deletehttps://youraccountname.api-us1.com/api/3/calendars/:id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/calendars/:id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://youraccountname.api-us1.com/api/3/calendars/:id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/calendars/:id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/calendars/:id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/calendars/:id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

ID
int32
required

ID of the calendar feed to delete

 

List all calendar feeds

 
gethttps://youraccountname.api-us1.com/api/3/calendars
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/calendars
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/calendars' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/calendars")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/calendars");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/calendars"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "calendars": [
        {
            "userid": "1",
            "title": "Calendar Title",
            "type": "All",
            "token": "4d9af6b9d5056ef1ca4a31c12c0e105c",
            "notification": "0",
            "cdate": "2018-11-15T22:36:05-06:00",
            "mdate": "2018-11-15T22:36:05-06:00",
            "links": {
                "calendarRels": "https://:account.api-us1.com/api/:version/calendars/2/calendarRels",
                "calendarUsers": "https://:account.api-us1.com/api/:version/calendars/2/calendarUsers"
            },
            "id": "2"
        }
    ],
    "meta": {
        "total": "1"
    }
}
 

Campaigns

Campaigns are broadcast emails sent out to a list of contacts.

 

List all campaigns

 
gethttps://youraccountname.api-us1.com/api/3/campaigns
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/campaigns
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/campaigns");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/campaigns"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "campaigns": [
        {
            "type": "single",
            "userid": "1",
            "segmentid": "0",
            "bounceid": "-1",
            "realcid": "0",
            "sendid": "0",
            "threadid": "0",
            "seriesid": "0",
            "formid": "1",
            "basetemplateid": "90a1d1ab6ad33e95708caf6472dc1724f698c694",
            "basemessageid": "0",
            "addressid": "0",
            "source": "web",
            "name": "Opt In Email",
            "cdate": "2018-08-17T13:47:31-05:00",
            "mdate": "2018-08-17T13:47:31-05:00",
            "sdate": null,
            "ldate": null,
            "send_amt": "0",
            "total_amt": "0",
            "opens": "0",
            "uniqueopens": "0",
            "linkclicks": "0",
            "uniquelinkclicks": "0",
            "subscriberclicks": "0",
            "forwards": "0",
            "uniqueforwards": "0",
            "hardbounces": "0",
            "softbounces": "0",
            "unsubscribes": "0",
            "unsubreasons": "0",
            "updates": "0",
            "socialshares": "0",
            "replies": "0",
            "uniquereplies": "0",
            "status": "0",
            "public": "1",
            "mail_transfer": "0",
            "mail_send": "0",
            "mail_cleanup": "0",
            "mailer_log_file": "0",
            "tracklinks": "all",
            "tracklinksanalytics": "0",
            "trackreads": "1",
            "trackreadsanalytics": "1",
            "analytics_campaign_name": "",
            "tweet": "0",
            "facebook": "0",
            "survey": "",
            "embed_images": "0",
            "htmlunsub": "0",
            "textunsub": "0",
            "htmlunsubdata": null,
            "textunsubdata": null,
            "recurring": "day1",
            "willrecur": "0",
            "split_type": "even",
            "split_content": "0",
            "split_offset": "2",
            "split_offset_type": "day",
            "split_winner_messageid": "0",
            "split_winner_awaiting": "0",
            "responder_offset": "0",
            "responder_type": "subscribe",
            "responder_existing": "0",
            "reminder_field": "sdate",
            "reminder_format": null,
            "reminder_type": "month_day",
            "reminder_offset": "0",
            "reminder_offset_type": "day",
            "reminder_offset_sign": "+",
            "reminder_last_cron_run": null,
            "activerss_interval": "day1",
            "activerss_url": null,
            "activerss_items": "10",
            "ip4": "643992596",
            "laststep": "designer",
            "managetext": "0",
            "schedule": "0",
            "scheduleddate": null,
            "waitpreview": "0",
            "deletestamp": null,
            "replysys": "0",
            "links": {
                "user": "https://:account.api-us1.com/api/3/campaigns/1/user",
                "automation": "https://:account.api-us1.com/api/3/campaigns/1/automation",
                "campaignMessage": "https://:account.api-us1.com/api/3/campaigns/1/campaignMessage",
                "links": "https://:account.api-us1.com/api/3/campaigns/1/links"
            },
            "id": "1",
            "user": "1",
            "automation": null
        }
    ],
    "meta": {
        "total": "1"
    }
}
 

Retrieve a campaign

 
gethttps://youraccountname.api-us1.com/api/3/campaigns/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/campaigns/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/campaigns/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/campaigns/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/campaigns/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/campaigns/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "campaign": {
        "type": "single",
        "userid": "1",
        "segmentid": "0",
        "bounceid": "-1",
        "realcid": "0",
        "sendid": "0",
        "threadid": "0",
        "seriesid": "0",
        "formid": "0",
        "basetemplateid": "13b1432dc41b75dda9ff86d84a8593d2b2b9419f",
        "basemessageid": "0",
        "addressid": "0",
        "source": "web",
        "name": "Matt Litmus test",
        "cdate": "2018-10-10T11:59:43-05:00",
        "mdate": "2018-10-10T12:00:23-05:00",
        "sdate": null,
        "ldate": null,
        "send_amt": "0",
        "total_amt": "0",
        "opens": "0",
        "uniqueopens": "0",
        "linkclicks": "0",
        "uniquelinkclicks": "0",
        "subscriberclicks": "0",
        "forwards": "0",
        "uniqueforwards": "0",
        "hardbounces": "0",
        "softbounces": "0",
        "unsubscribes": "0",
        "unsubreasons": "0",
        "updates": "0",
        "socialshares": "0",
        "replies": "0",
        "uniquereplies": "0",
        "status": "0",
        "public": "1",
        "mail_transfer": "0",
        "mail_send": "0",
        "mail_cleanup": "0",
        "mailer_log_file": "0",
        "tracklinks": "all",
        "tracklinksanalytics": "0",
        "trackreads": "1",
        "trackreadsanalytics": "1",
        "analytics_campaign_name": "",
        "tweet": "0",
        "facebook": "0",
        "survey": "",
        "embed_images": "0",
        "htmlunsub": "0",
        "textunsub": "0",
        "htmlunsubdata": null,
        "textunsubdata": null,
        "recurring": "day1",
        "willrecur": "0",
        "split_type": "even",
        "split_content": "0",
        "split_offset": "2",
        "split_offset_type": "day",
        "split_winner_messageid": "0",
        "split_winner_awaiting": "0",
        "responder_offset": "0",
        "responder_type": "subscribe",
        "responder_existing": "0",
        "reminder_field": "sdate",
        "reminder_format": null,
        "reminder_type": "month_day",
        "reminder_offset": "0",
        "reminder_offset_type": "day",
        "reminder_offset_sign": "+",
        "reminder_last_cron_run": null,
        "activerss_interval": "day1",
        "activerss_url": null,
        "activerss_items": "10",
        "ip4": "643992596",
        "laststep": "designer",
        "managetext": "0",
        "schedule": "0",
        "scheduleddate": null,
        "waitpreview": "0",
        "deletestamp": null,
        "replysys": "0",
        "links": {
            "user": "https://:account.api-us1.com/api/:version/campaigns/1/user",
            "automation": "https://:account.api-us1.com/api/:version/campaigns/1/automation",
            "campaignMessage": "https://:account.api-us1.com/api/:version/campaigns/1/campaignMessage",
            "links": "https://:account.api-us1.com/api/:version/campaigns/1/links",
            "aggregateRevenues": "https://:account.api-us1.com/api/:version/campaigns/1/aggregateRevenues"
        },
        "id": "1",
        "user": "1",
        "automation": null
    }
}

Path Params

id
int32
required

ID of campaign to retrieve

 

Messages

 

Create a message

 
posthttps://youraccountname.api-us1.com/api/3/messages
{
	"message": {
		"fromname": "AC Admin",
     "fromemail": "noreply@example.com",
     "reply2": "hello@example.com",
     "subject": "You are subscribing to %LISTNAME%",
     "preheader_text": "Pre-header Text"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "message": {
        "fromname": "AC Admin",
        "fromemail": "no_reply@example.com",
        "reply2": "hello@example.com",
        "subject": "You are subscribing to %LISTNAME%",
        "preheader_text": "Pre-header Text",
        "links": {
            "user": "https://:account.api-us1.com/api/3/messages/16/user"
        },
        "id": "16"
    }
}

Body Params

message
object
message.fromname
string
required

Name of sender

message.email
string
required

Email of sender

message.reply2
string
required

Reply email for the recipient to reply to

message.subject
string

Subject of message

message.preheader_text
string

Preheader Text

 

Retrieve a message

 
gethttps://youraccountname.api-us1.com/api/3/messages/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/messages/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/messages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/messages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/messages/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/messages/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": {
        "userid": "1",
        "ed_instanceid": "1",
        "ed_version": "2",
        "cdate": "2018-08-17T13:47:32-05:00",
        "mdate": "2018-08-17T13:47:32-05:00",
        "name": "Please confirm your subscription to %LISTNAME%",
        "fromname": "John Doe",
        "fromemail": "noreply@example.com",
        "reply2": "",
        "priority": "3",
        "charset": "utf-8",
        "encoding": "8bit",
        "format": "mime",
        "subject": "Please confirm your subscription to %LISTNAME%",
        "preheader_text": "",
        "text": " \n\nThank you for subscribing to %LISTNAME%!\n\nYou or someone has subscribed to this list on %SUBDATE% using the\naddress %EMAIL%.\n\nTo confirm that you wish to be subscribed, please click the link below:\n\nConfirm My Subscription <%CONFIRMLINK%> \n\nIf you believe that this is a mistake and you did not intend on\nsubscribing to this list,\nyou can ignore this message and nothing else will happen.",
        "html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html lang=\"en\" style=\"margin: 0; outline: none; padding: 0;\"><head><!--[if !mso]><meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"><!--<![endif]--><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"><meta http-equiv=\"Content-Language\" content=\"locale_contentlang\"><meta name=\"format-detection\" content=\"telephone=no\"><meta name=\"format-detection\" content=\"date=no\"><meta name=\"format-detection\" content=\"address=no\"><meta name=\"format-detection\" content=\"email=no\"><title>Preview</title><style data-ac-keep=\"true\">\n.ExternalClass {width:100%; background:inherit; background-color:inherit;}\n.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }\n.undoreset div p, .undoreset p { margin-bottom: 20px; }\ndiv[class^=\"aolmail_divbody\"] { overflow: auto; }\n[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }\n</style><style data-ac-keep=\"true\">\n@media only screen and (max-width: 600px) {\t/*-------------------------------------------------------------------------*\\ Abandoned Cart widget \\*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ td[height=\"10\"]{height:10px!important;font-size:10px!important;line-height:10px!important;}\ntd[height=\"13\"]{height:13px!important;font-size:13px!important;line-height:13px!important;}\ntd[height=\"14\"]{height:14px!important;font-size:14px!important;line-height:14px!important;}\ntd[height=\"12\"]{height:12px!important;font-size:12px!important;line-height:12px!important;} /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }\n</style><style data-ac-keep=\"true\"> </style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\"ac-designer\" class=\"body\" style=\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #f5f5f5; width: 100%; text-align: center;\"><div class=\"divbody\" style=\"margin: 0px; outline: none; padding: 0px; color: #000000; font-family: arial; line-height: 1.1; width: 100%; background-color: #f5f5f5; background: #f5f5f5; text-align: center;\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" align=\"left\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; background: #f5f5f5;\"><tr><td align=\"center\" valign=\"top\" width=\"100%\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"650\" bgcolor=\"#f5f5f5\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; max-width: 650px;\"><tr><td id=\"layout_table_4c01fd59953b175598dbdb0163afc56680171ae4\" valign=\"top\" align=\"center\" width=\"650\" style=\"background-color: #f5f5f5;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table root-table\" width=\"650\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5;\"><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin2\" valign=\"top\" style=\"background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row2\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding2\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin1\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row1\" class=\"layout layout-row widget _widget_text style1\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding1\" valign=\"top\" style=\"padding: 0 20px 20px 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div1\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 10px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: #000000; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">Thank you for subscribing to %LISTNAME%!</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin3\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row3\" class=\"layout layout-row widget _widget_text style3\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding3\" valign=\"top\" style=\"padding: 0 20px 20px 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div3\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: inherit; font-size: 13px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin4\" valign=\"top\" style=\"padding: 0 20px 0 20px; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row4\" class=\"layout layout-row widget _widget_text style4\" style=\"margin: 0; padding: 0; background-color: #ffffff;\"><td id=\"layout-row-padding4\" valign=\"top\" style=\"background-color: #ffffff; padding: 30px 30px 20px 30px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div4\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span class=\"\" style=\"color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\">To confirm that you wish to be subscribed, please click the link below:</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin5\" valign=\"top\" style=\"padding: 0 20px 0 20px; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row5\" class=\"layout layout-row widget _widget_button style5\" style=\"background-color: #ffffff;\"><td id=\"layout-row-padding5\" valign=\"top\" style=\"background-color: #ffffff; padding: 0px 30px 30px 30px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"td_button td_block customizable\" valign=\"top\" align=\"left\" width=\"550\"> <div class=\"button-wrapper\" style=\"margin: 0; outline: none; padding: 0; text-align: center;\">\n<!--[if mso]> <v:roundrect xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" href=\"%CONFIRMLINK%\" style=\"v-text-anchor:middle; width:202px; height:64px; \" arcsize=\"10%\" strokecolor=\"#4dcba9\" strokeweight=\"1pt\" fillcolor=\"#4dcba9\" o:button=\"true\" o:allowincell=\"true\" o:allowoverlap=\"false\" > <v:textbox inset=\"2px,2px,2px,2px\"> <center style=\"color:#ffffff;font-family:Arial; font-size:14px; line-height: 1.1;\">Confirm My Subscription</center> </v:textbox> </v:roundrect>\n<![endif]--> <a href=\"%CONFIRMLINK%\" style=\"margin: 0; outline: none; padding: 14px; color: #ffffff; background-color: #4dcba9; border: 1px solid #4dcba9; border-radius: 4px; font-family: Arial; font-size: 14px; display: inline-block; line-height: 1.1; text-align: center; text-decoration: none; mso-hide: all;\"> <span style=\"color:#ffffff;font-family:Arial;font-size:14px;\"> Confirm My Subscription </span> </a> </div>\n</td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin6\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row6\" class=\"layout layout-row widget _widget_text style6\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding6\" valign=\"top\" style=\"padding: 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div6\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">If you believe that this is a mistake and you did not intend on subscribing to this list,<br>you can ignore this message and nothing else will happen.</span></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></div></body></html>\n",
        "htmlfetch": "now",
        "textfetch": "now",
        "hidden": "0",
        "preview_mime": "",
        "preview_data": "",
        "links": {
            "user": "https://:account.api-us1.com/api/3/messages/3/user"
        },
        "id": "3",
        "user": "1"
    }
}
{
    "message": "No Result found for Message with id 10"
}

Path Params

id
string
required

ID of the message to retrieve

 

Update a message

 
puthttps://youraccountname.api-us1.com/api/3/messages/id
{
	"message": {
		"fromname": "John Doe",
    "fromemail": "noreply@example.com",
    "reply2": "hello@example.com",
    "subject": "You are subscribing to %LISTNAME%",
    "preheader_text": "Pre-header Text"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "message": {
        "userid": "1",
        "ed_instanceid": "1",
        "ed_version": "2",
        "cdate": "2018-08-06T16:31:45-05:00",
        "mdate": "2018-08-06T16:33:23-05:00",
        "name": "Hello, %FIRSTNAME%",
        "fromname": "John Doe",
        "fromemail": "noreply@example.com",
        "reply2": "hello@example.com",
        "priority": "3",
        "charset": "utf-8",
        "encoding": "8bit",
        "format": "mime",
        "subject": "You are subscribing to %LISTNAME%",
        "preheader_text": "Pre-header Text",
        "text": " \n\n \n\n \n\nUndercover \n\n**Lorem ipsum dolar sit amet, consectetur adipiscing elit.**\n\n**A**liquam finibus tempus nulla gravida tincidunt. Donec auctor a felis\nnon pulvinar. Lorem ipsum dolor sit amet, consectetur adipiscing elit.\nVestibulum at hendrerit lectus. Mauris turpis ligula, rutrum quis leo\nsit amet, finibus laoreet urna. Nullam et lacinia nunc, ac gravida\nlibero. Nunc tellus erat, ullamcorper a nulla ut, pharetra auctor justo.\n\nProin volutpat nunc at nulla consectetur suscipit. Fusce malesuada nisi\nnulla, sed ornare turpis gravida at. Nam mollis ipsum eu vestibulum\nscelerisque.\n\nSuspendisse ultrices a arcu vel cursus. Mauris quis luctus lacus.\nAliquam iaculis, augue sit amet euismod viverra, lorem nulla consequat\nleo, non congue lorem ipsum nec magna. Donec a lorem eget nunc posuere\nconvallis vitae imperdiet purus.\n\nMauris turpis ligula, rutrum quis leo sit amet, finibus laoreet urna.\nNullam et lacinia nunc, ac gravida libero. Nunc tellus erat, ullamcorper\na nulla ut, pharetra auctor justo.\n\n \n\n01 - Lorem ipsum dolar sit \n\nLorem ipsum dolor sit amet, consectetur adipiscing elit.  Donec\ntristique, tellus et sodales ornare, orci risus venenatis metus, et\nscelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed\nmetus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus\negestas.\n\n02 - Lorem ipsum dolar sit \n\n \n\n \n\n \n\n\"Lorem ipsum dolar sit amet, consectetur.\"\n\n- S. Williams\n\n \n\n \n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Donec\ntristique, tellus et sodales ornare, orci risus venenatis metus, et\nscelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed\nmetus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus\negestas.\n\nDonec tristique, tellus et sodales ornare, orci risus venenatis metus,\net scelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed\nmetus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus\negestas.\n\n \n\n%SENDER-INFO-SINGLELINE%\n\nClick here to unsubscribe <%UNSUBSCRIBELINK%>",
        "html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html lang=\"en\" style=\"margin: 0; outline: none; padding: 0;\"><head><!--[if !mso]><meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"><!--<![endif]--><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"><meta http-equiv=\"Content-Language\" content=\"locale_contentlang\"><meta name=\"format-detection\" content=\"telephone=no\"><meta name=\"format-detection\" content=\"date=no\"><meta name=\"format-detection\" content=\"address=no\"><meta name=\"format-detection\" content=\"email=no\"><style data-ac-keep=\"true\">\n.ExternalClass {width:100%; background:inherit; background-color:inherit;}\n.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }\n.undoreset div p, .undoreset p { margin-bottom: 20px; }\ndiv[class^=\"aolmail_divbody\"] { overflow: auto; }\n[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }\n</style><style data-ac-keep=\"true\">\n@media only screen and (max-width: 600px) {\t/*-------------------------------------------------------------------------*\\ Abandoned Cart widget \\*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }\n</style><style data-ac-keep=\"true\"> @media only screen and (max-width: 320px) { #layout-row1 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row3 img { width: 100% !important; height: auto !important; max-width: 184px !important; } #layout-row4 img { width: 100% !important; height: auto !important; max-width: 320px !important; } #layout-row10 .break-line { width: 100% !important; margin: auto !important; } #layout-row13 img { width: 100% !important; height: auto !important; max-width: 320px !important; } #layout-row14 img { width: 100% !important; height: auto !important; max-width: 320px !important; } #layout-row18 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row20 .break-line { width: 100% !important; margin: auto !important; } #layout-row25 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row29 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } .td_rss .rss-item img.iphone_large_image { width: auto !important; } u + .body { display: table !important; width: 100vw !important; min-width: 100vw !important; } u + .body table { display: table !important; width: 100% !important; min-width: 100% !important; } u + .body td { display: block !important; width: 100% !important; min-width: 100% !important; } u + .body img { display: inline-block !important; margin: auto !important; width: auto !important; vertical-align: bottom !important; } u + .body center { display: block !important; margin: auto !important; width: 100% !important; min-width: 100% !important; text-align: center !important; } u + .body table._ac_social_table, u + .body table._ac_social_table td, u + .body table._ac_social_table div, u + .body table._ac_social_table a { display: inline-block !important; margin: auto !important; width: auto !important; min-width: auto !important; text-align: center !important; } u + .body table._ac_social_table img { display: inline-block !important; margin: auto !important; width: 32px !important; min-width: 32px !important; max-width: 32px !important; }\n}\n@media only screen and (max-width: 375px) { #layout-row1 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row3 img { width: 100% !important; height: auto !important; max-width: 184px !important; } #layout-row4 img { width: 100% !important; height: auto !important; max-width: 375px !important; } #layout-row10 .break-line { width: 100% !important; margin: auto !important; } #layout-row13 img { width: 100% !important; height: auto !important; max-width: 375px !important; } #layout-row14 img { width: 100% !important; height: auto !important; max-width: 375px !important; } #layout-row18 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row20 .break-line { width: 100% !important; margin: auto !important; } #layout-row25 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row29 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } .td_rss .rss-item img.iphone_large_image { width: auto !important; } u + .body { display: table !important; width: 100vw !important; min-width: 100vw !important; } u + .body table { display: table !important; width: 100% !important; min-width: 100% !important; } u + .body td { display: block !important; width: 100% !important; min-width: 100% !important; } u + .body img { display: inline-block !important; margin: auto !important; width: auto !important; vertical-align: bottom !important; } u + .body center { display: block !important; margin: auto !important; width: 100% !important; min-width: 100% !important; text-align: center !important; } u + .body table._ac_social_table, u + .body table._ac_social_table td, u + .body table._ac_social_table div, u + .body table._ac_social_table a { display: inline-block !important; margin: auto !important; width: auto !important; min-width: auto !important; text-align: center !important; } u + .body table._ac_social_table img { display: inline-block !important; margin: auto !important; width: 32px !important; min-width: 32px !important; max-width: 32px !important; }\n}\n@media only screen and (max-width: 414px) { #layout-row1 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row3 img { width: 100% !important; height: auto !important; max-width: 184px !important; } #layout-row4 img { width: 100% !important; height: auto !important; max-width: 414px !important; } #layout-row10 .break-line { width: 100% !important; margin: auto !important; } #layout-row13 img { width: 100% !important; height: auto !important; max-width: 414px !important; } #layout-row14 img { width: 100% !important; height: auto !important; max-width: 414px !important; } #layout-row18 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row20 .break-line { width: 100% !important; margin: auto !important; } #layout-row25 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row29 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } .td_rss .rss-item img.iphone_large_image { width: auto !important; } u + .body { display: table !important; width: 100vw !important; min-width: 100vw !important; } u + .body table { display: table !important; width: 100% !important; min-width: 100% !important; } u + .body td { display: block !important; width: 100% !important; min-width: 100% !important; } u + .body img { display: inline-block !important; margin: auto !important; width: auto !important; vertical-align: bottom !important; } u + .body center { display: block !important; margin: auto !important; width: 100% !important; min-width: 100% !important; text-align: center !important; } u + .body table._ac_social_table, u + .body table._ac_social_table td, u + .body table._ac_social_table div, u + .body table._ac_social_table a { display: inline-block !important; margin: auto !important; width: auto !important; min-width: auto !important; text-align: center !important; } u + .body table._ac_social_table img { display: inline-block !important; margin: auto !important; width: 32px !important; min-width: 32px !important; max-width: 32px !important; }\n}\n@media only screen and (max-width: 667px) { #layout-row1 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row3 img { width: 100% !important; height: auto !important; max-width: 184px !important; } #layout-row4 img { width: 100% !important; height: auto !important; max-width: 667px !important; } #layout-row10 .break-line { width: 100% !important; margin: auto !important; } #layout-row13 img { width: 100% !important; height: auto !important; max-width: 536px !important; } #layout-row14 img { width: 100% !important; height: auto !important; max-width: 534px !important; } #layout-row18 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row20 .break-line { width: 100% !important; margin: auto !important; } #layout-row25 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } #layout-row29 { max-height: 0px!important; font-size: 0px!important; display: none!important; visibility: hidden!important; } .td_rss .rss-item img.iphone_large_image { width: auto !important; } u + .body { display: table !important; width: 100vw !important; min-width: 100vw !important; } u + .body table { display: table !important; width: 100% !important; min-width: 100% !important; } u + .body td { display: block !important; width: 100% !important; min-width: 100% !important; } u + .body img { display: inline-block !important; margin: auto !important; width: auto !important; vertical-align: bottom !important; } u + .body center { display: block !important; margin: auto !important; width: 100% !important; min-width: 100% !important; text-align: center !important; } u + .body table._ac_social_table, u + .body table._ac_social_table td, u + .body table._ac_social_table div, u + .body table._ac_social_table a { display: inline-block !important; margin: auto !important; width: auto !important; min-width: auto !important; text-align: center !important; } u + .body table._ac_social_table img { display: inline-block !important; margin: auto !important; width: 32px !important; min-width: 32px !important; max-width: 32px !important; }\n}\n</style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\"ac-designer\" class=\"body\" style=\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #343434; width: 100%; text-align: center;\"><div class=\"divbody\" style=\"margin: 0px; outline: none; padding: 0px; color: #000000; font-family: arial; line-height: 1.1; width: 100%; background-color: #343434; background: #343434; text-align: center;\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" align=\"left\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #343434; background: #343434;\"><tr><td align=\"center\" valign=\"top\" width=\"100%\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"650\" bgcolor=\"#343434\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; max-width: 650px;\"><tr><td id=\"layout_table_1021313e38e49afad28844ffa18a6c210aadc587\" valign=\"top\" align=\"center\" width=\"650\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table root-table\" width=\"650\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin31\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row31\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding31\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"25\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 25px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"25\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin3\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row3\" class=\"layout layout-row widget _widget_picture style3\" align=\"center\" style=\"background-color: #343434;\"><td id=\"layout-row-padding3\" valign=\"top\" style=\"background-color: #343434; padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"image-td\" align=\"center\" valign=\"top\" width=\"650\"><img src=\"http://test-enterprise-8./public//4f397db254489cbcc56cec456cd7b3db.png?r=871859732\" alt=\"\" width=\"184\" style=\"display: block; border: none; outline: none; width: 184px; opacity: 1; max-width: 100%;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin27\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row27\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding27\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin4\" valign=\"top\" style=\"padding: 0px 0 0 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row4\" class=\"layout layout-row widget _widget_picture style4\" align=\"left\" style=\"background-color: #343434;\"><td id=\"layout-row-padding4\" valign=\"top\" style=\"background-color: #343434; padding: 0px 0 0 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"image-td\" align=\"left\" valign=\"top\" width=\"650\"><img src=\"http://test-enterprise-8./public//714a6a68462f305dcc07900019176da9.png?r=92350116\" alt=\"\" width=\"650\" style=\"display: block; border: none; outline: none; width: 650px; opacity: 1; max-width: 100%;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin5\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row5\" class=\"layout layout-row widget _widget_spacer style5\" style=\"\"><td id=\"layout-row-padding5\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"52\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 52px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"52\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr id=\"layout-row8\" class=\"layout layout-row clear-this \"><td id=\"layout-row-padding8\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout_table_3f45c3a8c98792148cfe613227982408eef75ad2\" valign=\"top\" width=\"325\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"325\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin6\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row6\" class=\"layout layout-row widget _widget_text style6\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding6\" valign=\"top\" style=\"padding: 0 26px 10px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div6\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 100%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 100%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1;\" data-line-height=\"1\"> <span class=\"\" style=\"color: #999999; font-size: 48px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia; font-style: italic;\">Undercover</span> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div6, #text_div6 div { line-height: 100% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin9\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row9\" class=\"layout layout-row widget _widget_text style9\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding9\" valign=\"top\" style=\"padding: 0 26px 16px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div8\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 110%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.1; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div data-line-height=\"1.1\" style=\"line-height: 110%; margin: 0; outline: none; padding: 0; mso-line-height-rule: exactly; line-height: 1.1;\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><i class=\"\" style=\"margin: 0; outline: none; padding: 0; font-family: 'times new roman'; font-size: 26px; color: #999999;\">Lorem ipsum dolar sit amet, consectetur adipiscing elit.</i></p> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div8, #text_div8 div { line-height: 110% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin10\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row10\" class=\"layout layout-row widget _widget_break style10\" style=\"\"><td id=\"layout-row-padding10\" valign=\"top\" style=\"line-height: 0; mso-line-height-rule: exactly; padding: 0 26px 0 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: collapse; line-height: 0; mso-line-height-rule: exactly;\"><tr><td height=\"10\" style=\"line-height: 0; mso-line-height-rule: exactly;\"></td></tr><tr><td align=\"center\" height=\"1\" width=\"273\" style=\"line-height: 0; mso-line-height-rule: exactly;\"> <table align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"1\" width=\"273\" style=\"font-size: 13px; min-width: auto!important; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: collapse; line-height: 0; mso-line-height-rule: exactly; width: 100%; max-width: 100%;\"><tr><td class=\"break-line\" bgcolor=\"#999999\" height=\"1\" width=\"273\" style=\"line-height: 1px; mso-line-height-rule: exactly; height: 1px; width: 273px; background-color: #999999;\"> </td> </tr></table></td> </tr><tr><td height=\"10\" style=\"line-height: 0; mso-line-height-rule: exactly;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin11\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row11\" class=\"layout layout-row widget _widget_text style11\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding11\" valign=\"top\" style=\"padding: 20px 26px 26px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div10\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 140%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.4; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 140%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1.4;\" data-line-height=\"1.4\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\"><b class=\"\" style=\"margin: 0; outline: none; padding: 0; font-size: 27px; color: #999999;\">A</b>liquam finibus tempus nulla gravida tincidunt. Donec auctor a felis non pulvinar. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum at hendrerit lectus. Mauris turpis ligula, rutrum quis leo sit amet, finibus laoreet urna. Nullam et lacinia nunc, ac gravida libero. Nunc tellus erat, ullamcorper a nulla ut, pharetra auctor justo.</span></p> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div10, #text_div10 div { line-height: 140% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td><td id=\"layout_table_671b17cb4782b654db485de21cbc09bb8b42a7c1\" valign=\"top\" width=\"325\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"325\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin7\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row7\" class=\"layout layout-row widget _widget_text style7\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding7\" valign=\"top\" style=\"padding: 10px 26px 0 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div7\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 140%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.4; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div data-line-height=\"1.4\" style=\"line-height: 140%; margin: 0; outline: none; padding: 0; mso-line-height-rule: exactly; line-height: 1.4; color: #999999;\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\">Proin volutpat nunc at nulla consectetur suscipit. Fusce malesuada nisi nulla, sed ornare turpis gravida at. Nam mollis ipsum eu vestibulum scelerisque.</span></p> <p class=\"p2\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><br style=\"font-family: georgia; font-size: 16px; color: #999999;color: #999999;\"></p> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\">Suspendisse ultrices a arcu vel cursus. Mauris quis luctus lacus. Aliquam iaculis, augue sit amet euismod viverra, lorem nulla consequat leo, non congue lorem ipsum nec magna. Donec a lorem eget nunc posuere convallis vitae imperdiet purus.</span></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><br style=\"font-family: georgia; font-size: 16px; color: #999999;color: #999999;\"></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\"><span style=\"color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\">Mauris turpis ligula, rutrum quis leo sit amet, finibus laoreet urna. Nullam et lacinia nunc, ac gravida libero. Nunc tellus erat, ullamcorper a nulla ut, pharetra auctor justo.</span><br style=\"color: #999999;\"></span></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><br style=\"color: #999999;color: #999999;\"></p><br></div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div7, #text_div7 div { line-height: 140% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin12\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row12\" class=\"layout layout-row widget _widget_spacer style12\" style=\"\"><td id=\"layout-row-padding12\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr id=\"layout-row15\" class=\"layout layout-row clear-this \"><td id=\"layout-row-padding15\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout_table_fda5dd4152a83e24c40d194350d6d45090bf0979\" valign=\"top\" width=\"325\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"325\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin13\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row13\" class=\"layout layout-row widget _widget_picture style13\" align=\"left\" style=\"\"><td id=\"layout-row-padding13\" valign=\"top\" style=\"padding: 0 26px 10px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"image-td\" align=\"left\" valign=\"top\" width=\"273\"><img src=\"http://test-enterprise-8./public//a85847a4efbab68055b6ada532261c12.png?r=704215052\" alt=\"\" width=\"273\" style=\"display: block; border: none; outline: none; width: 273px; opacity: 1; max-width: 100%;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin16\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row16\" class=\"layout layout-row widget _widget_text style16\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding16\" valign=\"top\" style=\"padding: 0 26px 30px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div14\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 130%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.3; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 130%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1.3;\" data-line-height=\"1.3\"> <span class=\"\" style='color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: \"times new roman\"; font-style: italic;'><span style=\"color: #999999; font-size: inherit; font-weight: bold; line-height: inherit; text-decoration: inherit;\"> 01 -</span> Lorem ipsum dolar sit</span> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div14, #text_div14 div { line-height: 130% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin17\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row17\" class=\"layout layout-row widget _widget_text style17\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding17\" valign=\"top\" style=\"padding: 0 26px 39px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div15\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 140%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.4; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 140%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1.4;\" data-line-height=\"1.4\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.  Donec tristique, tellus et sodales ornare, orci risus venenatis metus, et scelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed metus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus egestas.</span></p> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div15, #text_div15 div { line-height: 140% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td><td id=\"layout_table_1903ee6fde2ab10b81f6790da79880e983ad0639\" valign=\"top\" width=\"325\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"325\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin14\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row14\" class=\"layout layout-row widget _widget_picture style14\" align=\"left\" style=\"\"><td id=\"layout-row-padding14\" valign=\"top\" style=\"padding: 0 26px 10px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"image-td\" align=\"left\" valign=\"top\" width=\"273\"><img src=\"http://test-enterprise-8./public//19e0532e4430dd99a6d8e3d9a69e8722.png?r=2014676670\" alt=\"\" width=\"273\" style=\"display: block; border: none; outline: none; width: 273px; opacity: 1; max-width: 100%;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin19\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row19\" class=\"layout layout-row widget _widget_text style19\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding19\" valign=\"top\" style=\"padding: 0 26px 30px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div17\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 130%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.3; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 130%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1.3;\" data-line-height=\"1.3\"> <span class=\"\" style='color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: \"times new roman\"; font-style: italic;'><span style=\"color: #999999; font-size: inherit; font-weight: bold; line-height: inherit; text-decoration: inherit;\"> 02 -</span> Lorem ipsum dolar sit</span> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div17, #text_div17 div { line-height: 130% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin18\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row18\" class=\"layout layout-row widget _widget_spacer style18\" style=\"\"><td id=\"layout-row-padding18\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin20\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row20\" class=\"layout layout-row widget _widget_break style20\" style=\"\"><td id=\"layout-row-padding20\" valign=\"top\" style=\"line-height: 0; mso-line-height-rule: exactly; padding: 0 26px 0 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: collapse; line-height: 0; mso-line-height-rule: exactly;\"><tr><td height=\"10\" style=\"line-height: 0; mso-line-height-rule: exactly;\"></td></tr><tr><td align=\"center\" height=\"1\" width=\"598\" style=\"line-height: 0; mso-line-height-rule: exactly;\"> <table align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"1\" width=\"598\" style=\"font-size: 13px; min-width: auto!important; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: collapse; line-height: 0; mso-line-height-rule: exactly; width: 100%; max-width: 100%;\"><tr><td class=\"break-line\" bgcolor=\"#999999\" height=\"1\" width=\"598\" style=\"line-height: 1px; mso-line-height-rule: exactly; height: 1px; width: 598px; background-color: #999999;\"> </td> </tr></table></td> </tr><tr><td height=\"10\" style=\"line-height: 0; mso-line-height-rule: exactly;\"></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin21\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row21\" class=\"layout layout-row widget _widget_spacer style21\" style=\"\"><td id=\"layout-row-padding21\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"43\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 43px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"43\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr id=\"layout-row23\" class=\"layout layout-row clear-this \"><td id=\"layout-row-padding23\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout_table_9929bd7219b5a483f72e371041f557266f23face\" valign=\"top\" width=\"295\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"295\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row26\" class=\"layout layout-row clear-this \"><td id=\"layout-row-padding26\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout_table_a5d42e4016ba95676c5d0c08dded0a92da76cf78\" valign=\"top\" width=\"26\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"26\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin25\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row25\" class=\"layout layout-row widget _widget_spacer style25\" style=\"\"><td id=\"layout-row-padding25\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"388\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 388px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"388\" width=\"26\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr></table></td><td id=\"layout_table_2a8bd49bfe6839890ddad1d3770bbc80e298784c\" valign=\"top\" width=\"269\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"269\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin22\" valign=\"top\" style=\"padding: 0px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row22\" class=\"layout layout-row widget _widget_text style22\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-border22\" valign=\"top\" style=\"border-color: #999999; border-style: solid; border-width: 1px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-padding22\" valign=\"top\" style=\"padding: 20px 20px 30px 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div20\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 100%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 100%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1;\" data-line-height=\"1\"> <span class=\"\" style='color: #999999; font-size: 34px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: \"times new roman\"; font-style: italic;'><span style=\"color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">\"Lorem ipsum dolar sit amet, consectetur.\"<br style=\"color: #999999;\"><br style=\"color: #999999;\"></span><span class=\"\" style=\"color: #999999; font-size: 26px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span style=\"color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">- S. Williams</span><br style=\"color: #999999;\"></span></span> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div20, #text_div20 div { line-height: 100% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin28\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row28\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding28\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"269\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td><td id=\"layout_table_07718ed3fc601a3c0d938b6fc0e27261628cdabc\" valign=\"top\" width=\"355\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"355\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row30\" class=\"layout layout-row clear-this \"><td id=\"layout-row-padding30\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout_table_8d9015d9aacd6b421019b80822dc49a7c0f795e5\" valign=\"top\" width=\"30\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"30\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin29\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row29\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding29\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"325\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 325px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"325\" width=\"30\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr></table></td><td id=\"layout_table_1b61b68595417473009d9c168031e942c5c96f11\" valign=\"top\" width=\"325\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table \" width=\"325\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"layout-row-margin24\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row24\" class=\"layout layout-row widget _widget_text style24\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding24\" valign=\"top\" style=\"padding: 0 26px 36px 26px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div21\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 140%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.4; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 140%; margin: 0; outline: none; padding: 0; color: #999999; mso-line-height-rule: exactly; line-height: 1.4;\" data-line-height=\"1.4\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tristique, tellus et sodales ornare, orci risus venenatis metus, et scelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed metus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus egestas.</span></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><br style=\"font-family: georgia; font-size: 16px; color: #999999;color: #999999;\"></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span class=\"\" style=\"color: #999999; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\"><span style=\"color: #999999; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; font-family: georgia;\" class=\"\">Donec tristique, tellus et sodales ornare, orci risus venenatis metus, et scelerisque erat quam sed est. Donec dictum fermentum feugiat. In sed metus sed eros ullamcorper cursus. Vivamus eu magna at lacus tempus egestas.</span><br style=\"color: #999999;\"></span></p> </div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div21, #text_div21 div { line-height: 140% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin1\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row1\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding1\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr><td id=\"layout-row-margin2\" valign=\"top\" style=\"padding: 0;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row2\" class=\"layout layout-row widget _widget_text style2\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding2\" valign=\"top\" style=\"padding: 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div2\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"line-height: 150%; color: inherit; font-size: 12px; font-weight: inherit; line-height: 1.5; text-decoration: inherit; font-family: Arial; mso-line-height-rule: exactly;\"> <div style=\"line-height: 150%; margin: 0; outline: none; padding: 0; text-align: center; mso-line-height-rule: exactly; line-height: 1.5;\" data-line-height=\"1.5\"> <p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><span style=\"color: #555555; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">%SENDER-INFO-SINGLELINE%</span></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><br style=\"color: #555555;\"></p><p class=\"p1\" style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"><a href=\"%UNSUBSCRIBELINK%\" target=\"_blank\" style=\"margin: 0; outline: none; padding: 0; color: #555555; text-decoration: underline;\" class=\"\"><span style=\"color: #555555; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\">Click here to unsubscribe</span></a></p></div><!--[if (gte mso 12)&(lte mso 15) ]>\n<style data-ac-keep=\"true\" data-ac-inline=\"false\"> #text_div2, #text_div2 div { line-height: 150% !important; };\n</style>\n<![endif]--></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></div></body></html>\n",
        "htmlfetch": "now",
        "textfetch": "now",
        "hidden": "0",
        "preview_mime": "",
        "preview_data": "",
        "links": {
            "user": "https://:account.api-us1.com/api/3/messages/3/user"
        },
        "id": "3",
        "user": "1"
    }
}
{
    "message": "No Result found for Message with id 10"
}

Path Params

id
string
required

ID of the message to update

Headers

message.fromname
string

Name of sender

message.email
string

Email of sender

message.reply2
string

Reply email for the recipient to reply to

message.subject
string

Subject of message

message.preheader_text
string

Preheader Text

 

Delete a message

 
deletehttps://youraccountname.api-us1.com/api/3/messages/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/messages/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/messages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/messages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/messages/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/messages/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

id
string
required

ID of the message to delete

 

List all messages

 
gethttps://youraccountname.api-us1.com/api/3/messages
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/messages
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/messages' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/messages");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/messages"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "messages": [
        {
            "userid": "1",
            "ed_instanceid": "0",
            "ed_version": "1",
            "cdate": "2018-08-17T09:47:38-05:00",
            "mdate": "2018-08-17T09:47:38-05:00",
            "name": "",
            "fromname": "John Doe",
            "fromemail": "noreply@example.com",
            "reply2": "hello@example.com",
            "priority": "3",
            "charset": "utf-8",
            "encoding": "quoted-printable",
            "format": "mime",
            "subject": "Update your subscription to %LISTNAME%",
            "preheader_text": "",
            "text": " \n\n**Update your subscription details for %LISTNAME%** \n\n \n\nYou or someone entering your email has requested to update your\nsubscription details for the address %EMAIL%.\n\n**To update your subscription details click the link below.**\n\nUpdate My Subscription <%LINK%> \n\n \n\n{\"If you believe that this is a mistake and you did not intend on\nupdating your subscription to this list, you can ignore this message and\nnothing else will happen.\"|alang\n\n ",
            "html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html lang=\"en\" style=\"margin: 0; outline: none; padding: 0;\">\n<head>\n    <!--[if !mso]><meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"><!--<![endif]-->\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n    <meta http-equiv=\"Content-Language\" content=\"en-us\">\n    <title>Preview</title>\n    <style>\n        .ExternalClass         .ExternalClass p,\n        .ExternalClass ul,\n        .ExternalClass ol         .undoreset div p,\n        .undoreset p     </style>\n    <style>\n        @media only screen and (max-width: 600px),\n        only screen and (max-device-width: 600px)             *             table             thead,\n            tbody,\n            tr             th,\n            td,\n            p         }\n    </style>\n</head>\n<body style=\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #F2F2F2; width: 100%; text-align: center;\">\n    <div class=\"divbody\" style=\"margin: 0px; outline: none; padding: 0px; font-family: arial; line-height: 1.1; width: 100%; background-color: #F2F2F2; background: #F2F2F2; text-align: center;\">\n        <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"font-size: 16px;\">\n            <tr>\n                <td valign=\"top\" height=\"40\" align=\"center\">&nbsp;</td>\n            </tr>\n            <tr>\n                <td align=\"center\" valign=\"top\" width=\"100%\">\n                    <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" bgcolor=\"#F2F2F2\" style=\"font-size: 16px; min-width: 650px;\">\n                        <tr>\n                            <td valign=\"top\" align=\"center\">\n                                <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 16px;\">\n                                    <tr>\n                                        <td valign=\"top\" style=\"padding: 0;\">\n                                            <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                                                <tr style=\"margin: 0; padding: 0;\">\n                                                    <td valign=\"top\">\n                                                        <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                                                            <tr>\n                                                                <td valign=\"top\" align=\"center\" style=\"Margin:0; padding:0; font-size:20px; font-family:Arial,Helvetica; line-height:26px; text-align:center!important;\"><strong style=\"font-weight:bold;\">Update your subscription details for %LISTNAME%</strong>\n                                                                </td>\n                                                            </tr>\n                                                        </table>\n                                                    </td>\n                                                </tr>\n                                            </table>\n                                        </td>\n                                    </tr>\n                                    <tr>\n                                        <td height=\"20\">&nbsp;</td>\n                                    </tr>\n                                    <tr>\n                                        <td valign=\"top\" style=\"padding: 0;\">\n                                            <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                                                <tr style=\"margin: 0; padding: 0;\">\n                                                    <td valign=\"top\">\n                                                        <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                                                            <tr>\n                                                                <td valign=\"top\" align=\"center\" width=\"610\" style=\"color: inherit; font-size: inherit; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\">You or someone entering your email has requested to update your subscription details for the address %EMAIL%.</td>\n                                                            </tr>\n                                                        </table>\n                                                    </td>\n                                                </tr>\n                                            </table>\n                                        </td>\n                                    </tr>\n                                    <tr>\n                                        <td valign=\"top\" style=\"padding: 20px;\">\n                                            <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; border-collapse: initial !important;\">\n                                                <tr style=\"background-color: #ffffff;\">\n                                                    <td valign=\"top\" style=\"border-color: #c2c2c2; border-style: solid; border-width: 1px;\">\n                                                        <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px;\">\n                                                            <tr>\n                                                                <td valign=\"top\" align=\"center\" style=\"padding:20px; font-size:16px; font-family:Arial,Helvetica; text-align:center;\"><strong style=\"font-weight:bold;\">To update your subscription details click the link below.</strong></td> </tr> <tr> <td valign=\"top\" align=\"center\"> <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px;\"> <tr> <td valign=\"top\" align=\"left\" width=\"558\">\n                                                                                <div class=\"button-wrapper\" style=\"margin: 0; outline: none; padding: 0; text-align: center;\">\n                                                                                    <!--[if mso]> <v:roundrect xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" href=\"%LINK%\" style=\"v-text-anchor:middle; width: 558px; height: 50px;\" arcsize=\"10%\" strokecolor=\"#4DCBA9\" strokeweight=\"1pt\" fillcolor=\"#4DCBA9\" > <w:anchorlock/> <center style=\"color:#ffffff;font-family:'Arial'; font-size:16px;\">Update My Subscription</center> </v:roundrect> <![endif]-->\n                                                                                    <a href=\"%LINK%\" style=\"margin: 0; outline: none; padding: 16px; background-color: #4DCBA9; border: 1px solid #4DCBA9; border-radius: 4px; color: #ffffff; font-family: Arial; font-size: 16px; display: inline-block; text-align: center; text-decoration: none; mso-hide: all;\"> <span style=\"color:#ffffff;\">Update My Subscription</span> </a>\n                                                                                </div>\n                                                                            </td>\n    </tr>\n    </table>\n    </td>\n    </tr>\n    <tr>\n        <td height=\"20\">&nbsp;</td>\n    </tr>\n    </table>\n    </td>\n    </tr>\n    </table>\n    </td>\n    </tr>\n    <tr>\n        <td valign=\"top\" style=\"padding: 0;\">\n            <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                <tr style=\"margin: 0; padding: 0;\">\n                    <td valign=\"top\" style=\"padding: 20px;\">\n                        <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 14px;\">\n                            <tr>\n                                <td valign=\"top\" height=\"25\" align=\"center\" style=\"Margin:0; padding:0; font-size:13px; line-height:13px; font-family:Arial,Helvetica; text-align:center!important; line-height:20px; text-align:center!important;\">{\"If you believe that this is a mistake and you did not intend on updating your subscription to this list, you can ignore this message and nothing else will happen.\"|alang</td>\n                            </tr>\n                        </table>\n                    </td>\n                </tr>\n            </table>\n        </td>\n    </tr>\n    </table>\n    </td>\n    </tr>\n    </table>\n    </td>\n    </tr>\n    <tr>\n        <td valign=\"top\" height=\"40\" align=\"center\">&nbsp;</td>\n    </tr>\n    </table>\n    </div>\n</body>\n\n</html>",
            "htmlfetch": "now",
            "textfetch": "now",
            "hidden": "0",
            "preview_mime": "",
            "preview_data": null,
            "links": {
                "user": "https://:account.api-us1.com/api/3/messages/2/user"
            },
            "id": "2",
            "user": "1"
        },
        {
            "userid": "1",
            "ed_instanceid": "1",
            "ed_version": "2",
            "cdate": "2018-08-17T13:47:32-05:00",
            "mdate": "2018-08-17T13:47:32-05:00",
            "name": "Please confirm your subscription to %LISTNAME%",
            "fromname": "AC Admin",
            "fromemail": "ac_test@activecampaign.com",
            "reply2": "",
            "priority": "3",
            "charset": "utf-8",
            "encoding": "8bit",
            "format": "mime",
            "subject": "Please confirm your subscription to %LISTNAME%",
            "preheader_text": "",
            "text": " \n\nThank you for subscribing to %LISTNAME%!\n\nYou or someone has subscribed to this list on %SUBDATE% using the\naddress %EMAIL%.\n\nTo confirm that you wish to be subscribed, please click the link below:\n\nConfirm My Subscription <%CONFIRMLINK%> \n\nIf you believe that this is a mistake and you did not intend on\nsubscribing to this list,\nyou can ignore this message and nothing else will happen.",
            "html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html lang=\"en\" style=\"margin: 0; outline: none; padding: 0;\"><head><!--[if !mso]><meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"><!--<![endif]--><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"><meta http-equiv=\"Content-Language\" content=\"locale_contentlang\"><meta name=\"format-detection\" content=\"telephone=no\"><meta name=\"format-detection\" content=\"date=no\"><meta name=\"format-detection\" content=\"address=no\"><meta name=\"format-detection\" content=\"email=no\"><title>Preview</title><style data-ac-keep=\"true\">\n.ExternalClass {width:100%; background:inherit; background-color:inherit;}\n.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }\n.undoreset div p, .undoreset p { margin-bottom: 20px; }\ndiv[class^=\"aolmail_divbody\"] { overflow: auto; }\n[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }\n</style><style data-ac-keep=\"true\">\n@media only screen and (max-width: 600px) {\t/*-------------------------------------------------------------------------*\\ Abandoned Cart widget \\*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ td[height=\"10\"]{height:10px!important;font-size:10px!important;line-height:10px!important;}\ntd[height=\"13\"]{height:13px!important;font-size:13px!important;line-height:13px!important;}\ntd[height=\"14\"]{height:14px!important;font-size:14px!important;line-height:14px!important;}\ntd[height=\"12\"]{height:12px!important;font-size:12px!important;line-height:12px!important;} /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }\n</style><style data-ac-keep=\"true\"> </style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\"ac-designer\" class=\"body\" style=\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #f5f5f5; width: 100%; text-align: center;\"><div class=\"divbody\" style=\"margin: 0px; outline: none; padding: 0px; color: #000000; font-family: arial; line-height: 1.1; width: 100%; background-color: #f5f5f5; background: #f5f5f5; text-align: center;\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" align=\"left\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; background: #f5f5f5;\"><tr><td align=\"center\" valign=\"top\" width=\"100%\"><table class=\"template-table\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"650\" bgcolor=\"#f5f5f5\" style=\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; max-width: 650px;\"><tr><td id=\"layout_table_4c01fd59953b175598dbdb0163afc56680171ae4\" valign=\"top\" align=\"center\" width=\"650\" style=\"background-color: #f5f5f5;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"layout layout-table root-table\" width=\"650\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5;\"><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin2\" valign=\"top\" style=\"background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr id=\"layout-row2\" class=\"layout layout-row widget _widget_spacer \"><td id=\"layout-row-padding2\" valign=\"top\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td valign=\"top\" height=\"30\"><div class=\"spacer\" style=\"margin: 0; outline: none; padding: 0; height: 30px;\"><table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tbody><tr><td class=\"spacer-body\" valign=\"top\" height=\"30\" width=\"650\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin1\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row1\" class=\"layout layout-row widget _widget_text style1\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding1\" valign=\"top\" style=\"padding: 0 20px 20px 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div1\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 10px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: #000000; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">Thank you for subscribing to %LISTNAME%!</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin3\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row3\" class=\"layout layout-row widget _widget_text style3\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding3\" valign=\"top\" style=\"padding: 0 20px 20px 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div3\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: inherit; font-size: 13px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin4\" valign=\"top\" style=\"padding: 0 20px 0 20px; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row4\" class=\"layout layout-row widget _widget_text style4\" style=\"margin: 0; padding: 0; background-color: #ffffff;\"><td id=\"layout-row-padding4\" valign=\"top\" style=\"background-color: #ffffff; padding: 30px 30px 20px 30px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div4\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span class=\"\" style=\"color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\">To confirm that you wish to be subscribed, please click the link below:</span></p></td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin5\" valign=\"top\" style=\"padding: 0 20px 0 20px; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row5\" class=\"layout layout-row widget _widget_button style5\" style=\"background-color: #ffffff;\"><td id=\"layout-row-padding5\" valign=\"top\" style=\"background-color: #ffffff; padding: 0px 30px 30px 30px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td class=\"td_button td_block customizable\" valign=\"top\" align=\"left\" width=\"550\"> <div class=\"button-wrapper\" style=\"margin: 0; outline: none; padding: 0; text-align: center;\">\n<!--[if mso]> <v:roundrect xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" href=\"%CONFIRMLINK%\" style=\"v-text-anchor:middle; width:202px; height:64px; \" arcsize=\"10%\" strokecolor=\"#4dcba9\" strokeweight=\"1pt\" fillcolor=\"#4dcba9\" o:button=\"true\" o:allowincell=\"true\" o:allowoverlap=\"false\" > <v:textbox inset=\"2px,2px,2px,2px\"> <center style=\"color:#ffffff;font-family:Arial; font-size:14px; line-height: 1.1;\">Confirm My Subscription</center> </v:textbox> </v:roundrect>\n<![endif]--> <a href=\"%CONFIRMLINK%\" style=\"margin: 0; outline: none; padding: 14px; color: #ffffff; background-color: #4dcba9; border: 1px solid #4dcba9; border-radius: 4px; font-family: Arial; font-size: 14px; display: inline-block; line-height: 1.1; text-align: center; text-decoration: none; mso-hide: all;\"> <span style=\"color:#ffffff;font-family:Arial;font-size:14px;\"> Confirm My Subscription </span> </a> </div>\n</td></tr></table></td></tr></table></td></tr><tr style=\"background-color: #f5f5f5;\"><td id=\"layout-row-margin6\" valign=\"top\" style=\"padding: 0; background-color: #f5f5f5;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\"><tr id=\"layout-row6\" class=\"layout layout-row widget _widget_text style6\" style=\"margin: 0; padding: 0;\"><td id=\"layout-row-padding6\" valign=\"top\" style=\"padding: 20px;\"><table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\"><tr><td id=\"text_div6\" class=\"td_text td_block\" valign=\"top\" align=\"left\" style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\"> <span class=\"\" style=\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\"> </span><p style=\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\"><span style=\"color: inherit; font-size: 12px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\" class=\"\">If you believe that this is a mistake and you did not intend on subscribing to this list,<br>you can ignore this message and nothing else will happen.</span></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></div></body></html>\n",
            "htmlfetch": "now",
            "textfetch": "now",
            "hidden": "0",
            "preview_mime": "",
            "preview_data": "",
            "links": {
                "user": "https://:account.api-us1.com/api/3/messages/3/user"
            },
            "id": "3",
            "user": "1"
        },
        {
            "userid": "1",
            "ed_instanceid": "0",
            "ed_version": "1",
            "cdate": "2018-08-17T13:48:45-05:00",
            "mdate": "2018-08-17T13:48:45-05:00",
            "name": "testing",
            "fromname": "John Doe",
            "fromemail": "noreply@example.com",
            "reply2": "",
            "priority": "3",
            "charset": "utf-8",
            "encoding": "8bit",
            "format": "mime",
            "subject": "testing",
            "preheader_text": "",
            "text": "testing testing testing",
            "html": "<br>\ntesting testing testing",
            "htmlfetch": "now",
            "textfetch": "now",
            "hidden": "0",
            "preview_mime": "",
            "preview_data": null,
            "links": {
                "user": "https://:account.api-us1.com/api/3/messages/4/user"
            },
            "id": "4",
            "user": "1"
        }
    ],
    "meta": {
        "total": "3"
    }
}
 

Contacts

Contacts are the center of activity in ActiveCampaign and represent the people that the owner of an ActiveCampaign account is marketing to or selling to.

 

Contact parameters available values

For following parameters:

  • status

Use following values:

Parameter value
Meaning

-1

Any

0

Unconfirmed

1

Active

2

Unsubscribed

3

Bounced

Create a contact

 
posthttps://youraccountname.api-us1.com/api/3/contacts
{
	"contact": {
		"email": "johndoe@example.com",
		"firstName": "John",
		"lastName": "Doe",
		"phone": "7223224241"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "contact": {
        "email": "johndoe@example.com",
        "cdate": "2018-09-28T13:50:41-05:00",
        "udate": "2018-09-28T13:50:41-05:00",
        "orgid": "",
        "links": {
            "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/113/bounceLogs",
            "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/113/contactAutomations",
            "contactData": "https://:account.api-us1.com/api/:version/contacts/113/contactData",
            "contactGoals": "https://:account.api-us1.com/api/:version/contacts/113/contactGoals",
            "contactLists": "https://:account.api-us1.com/api/:version/contacts/113/contactLists",
            "contactLogs": "https://:account.api-us1.com/api/:version/contacts/113/contactLogs",
            "contactTags": "https://:account.api-us1.com/api/:version/contacts/113/contactTags",
            "contactDeals": "https://:account.api-us1.com/api/:version/contacts/113/contactDeals",
            "deals": "https://:account.api-us1.com/api/:version/contacts/113/deals",
            "fieldValues": "https://:account.api-us1.com/api/:version/contacts/113/fieldValues",
            "geoIps": "https://:account.api-us1.com/api/:version/contacts/113/geoIps",
            "notes": "https://:account.api-us1.com/api/:version/contacts/113/notes",
            "organization": "https://:account.api-us1.com/api/:version/contacts/113/organization",
            "plusAppend": "https://:account.api-us1.com/api/:version/contacts/113/plusAppend",
            "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/113/trackingLogs",
            "scoreValues": "https://:account.api-us1.com/api/:version/contacts/113/scoreValues"
        },
        "id": "113",
        "organization": ""
    }
}
{
  "message":"No Result found for Subscriber with id 1"
}
{
    "errors": [
        {
            "title": "Email address already exists in the system",
            "detail": "",
            "code": "duplicate",
            "source": {
                "pointer": "/data/attributes/email"
            }
        }
    ]
}

Body Params

contact
object
contact.email
string
required

Email address of the new contact. Example: 'test@example.com'

contact.firstName
string

First name of the new contact.

contact.lastName
string

Last name of the new contact.

contact.orgid
int32

(Deprecated) Please use Account-Contact end points

contact.phone
int32

Phone number of the contact.

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

Create or update contact

 
posthttps://youraccountname.api-us1.com/api/3/contact/sync
{
	"contact": {
		"email": "jondoe@example.com",
		"firstName": "John",
		"lastName": "Doe",
		"phone": "7223224241"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "contact": {
        "cdate": "2018-09-28T17:27:21-05:00",
        "email": "jondoe@example.com",
        "phone": "7223224241",
        "firstName": "John",
        "lastName": "Doe",
        "orgid": "0",
        "segmentio_id": "",
        "bounced_hard": "0",
        "bounced_soft": "0",
        "bounced_date": "0000-00-00",
        "ip": "0",
        "ua": "",
        "hash": "",
        "socialdata_lastcheck": "0000-00-00 00:00:00",
        "email_local": "",
        "email_domain": "",
        "sentcnt": "0",
        "rating_tstamp": "0000-00-00",
        "gravatar": "0",
        "deleted": "0",
        "anonymized": "0",
        "udate": "2018-09-28T17:30:52-05:00",
        "deleted_at": "0000-00-00 00:00:00",
        "created_utc_timestamp": "2018-09-28 17:27:21",
        "updated_utc_timestamp": "2018-09-28 17:27:21",
        "links": {
            "bounceLogs": "https://:account.api-us1.com/api/3/contacts/115/bounceLogs",
            "contactAutomations": "https://:account.api-us1.com/api/3/contacts/115/contactAutomations",
            "contactData": "https://:account.api-us1.com/api/3/contacts/115/contactData",
            "contactGoals": "https://:account.api-us1.com/api/3/contacts/115/contactGoals",
            "contactLists": "https://:account.api-us1.com/api/3/contacts/115/contactLists",
            "contactLogs": "https://:account.api-us1.com/api/3/contacts/115/contactLogs",
            "contactTags": "https://:account.api-us1.com/api/3/contacts/115/contactTags",
            "contactDeals": "https://:account.api-us1.com/api/3/contacts/115/contactDeals",
            "deals": "https://:account.api-us1.com/api/3/contacts/115/deals",
            "fieldValues": "https://:account.api-us1.com/api/3/contacts/115/fieldValues",
            "geoIps": "https://:account.api-us1.com/api/3/contacts/115/geoIps",
            "notes": "https://:account.api-us1.com/api/3/contacts/115/notes",
            "organization": "https://:account.api-us1.com/api/3/contacts/115/organization",
            "plusAppend": "https://:account.api-us1.com/api/3/contacts/115/plusAppend",
            "trackingLogs": "https://:account.api-us1.com/api/3/contacts/115/trackingLogs",
            "scoreValues": "https://:account.api-us1.com/api/3/contacts/115/scoreValues"
        },
        "id": "115",
        "organization": null
    }
}

Body Params

contact
object
contact.email
string
required

Email address of the contact to sync

contact.firstName
string
contact.lastName
string
contact.phone
string
contact.orgid
int32

(Deprecated) Please use Account-Contact end points

contact.deleted
boolean

(Deprecated) Please use the DELETE endpoint

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

Retrieve a contact

Retrieve an existing contact

 
gethttps://youraccountname.api-us1.com/api/3/contacts/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contacts/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/contacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contacts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contacts/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "contactAutomations": [
    {
      "contact": "1",
      "seriesid": "1",
      "startid": "0",
      "status": "0",
      "adddate": "1976-10-16T23:23:09-05:00",
      "remdate": null,
      "timespan": null,
      "lastblock": "0",
      "lastdate": "1984-08-15T08:13:44-05:00",
      "completedElements": "0",
      "totalElements": "0",
      "completed": 0,
      "completeValue": 100,
      "links": {
        "automation": "https://:account.api-us1.com/api/:version/contactAutomations/1/automation",
        "contact": "https://:account.api-us1.com/api/:version/contactAutomations/1/contact",
        "contactGoals": "https://:account.api-us1.com/api/:version/contactAutomations/1/contactGoals"
      },
      "id": "1",
      "automation": "1"
    }
  ],
  "contactLists": [
    {
      "contact": "1",
      "list": "1",
      "form": null,
      "seriesid": "0",
      "sdate": null,
      "udate": null,
      "status": "1",
      "responder": "1",
      "sync": "0",
      "unsubreason": null,
      "campaign": null,
      "message": null,
      "first_name": "John",
      "last_name": "Doe",
      "ip4Sub": "0",
      "sourceid": "0",
      "autosyncLog": null,
      "ip4_last": "0",
      "ip4Unsub": "0",
      "unsubscribeAutomation": null,
      "links": {
        "automation": "https://:account.api-us1.com/api/:version/contactLists/1/automation",
        "list": "https://:account.api-us1.com/api/:version/contactLists/1/list",
        "contact": "https://:account.api-us1.com/api/:version/contactLists/1/contact",
        "form": "https://:account.api-us1.com/api/:version/contactLists/1/form",
        "autosyncLog": "https://:account.api-us1.com/api/:version/contactLists/1/autosyncLog",
        "campaign": "https://:account.api-us1.com/api/:version/contactLists/1/campaign",
        "unsubscribeAutomation": "https://:account.api-us1.com/api/:version/contactLists/1/unsubscribeAutomation",
        "message": "https://:account.api-us1.com/api/:version/contactLists/1/message"
      },
      "id": "1",
      "automation": null
    }
  ],
  "deals": [
    {
      "owner": "1",
      "contact": "1",
      "organization": null,
      "group": null,
      "title": "Consectetur omnis quo inventore molestiae ratione amet.",
      "nexttaskid": "0",
      "currency": "USD",
      "status": "0",
      "links": {
        "activities": "https://:account.api-us1.com/api/:version/deals/1/activities",
        "contact": "https://:account.api-us1.com/api/:version/deals/1/contact",
        "contactDeals": "https://:account.api-us1.com/api/:version/deals/1/contactDeals",
        "group": "https://:account.api-us1.com/api/:version/deals/1/group",
        "nextTask": "https://:account.api-us1.com/api/:version/deals/1/nextTask",
        "notes": "https://:account.api-us1.com/api/:version/deals/1/notes",
        "organization": "https://:account.api-us1.com/api/:version/deals/1/organization",
        "owner": "https://:account.api-us1.com/api/:version/deals/1/owner",
        "scoreValues": "https://:account.api-us1.com/api/:version/deals/1/scoreValues",
        "stage": "https://:account.api-us1.com/api/:version/deals/1/stage",
        "tasks": "https://:account.api-us1.com/api/:version/deals/1/tasks"
      },
      "id": "1",
      "nextTask": null
    }
  ],
  "fieldValues": [
    {
      "contact": "1",
      "field": "1",
      "value": null,
      "cdate": "1981-05-16T19:02:29-05:00",
      "udate": "1975-11-08T10:31:45-06:00",
      "links": {
        "owner": "https://:account.api-us1.com/api/:version/fieldValues/1/owner",
        "field": "https://:account.api-us1.com/api/:version/fieldValues/1/field"
      },
      "id": "1",
      "owner": "1"
    }
  ],
  "geoAddresses": [
    {
      "ip4": "823",
      "country2": "AS",
      "country": "Suriname",
      "state": "KY",
      "city": "North Arnoldomouth",
      "zip": "38704-6592",
      "area": "0",
      "lat": "-70.160407",
      "lon": "-102.229406",
      "tz": "Europe/Chisinau",
      "tstamp": "1972-03-16T07:26:58-06:00",
      "links": [
        
      ],
      "id": "1"
    }
  ],
  "geoIps": [
    {
      "contact": "1",
      "campaignid": "1",
      "messageid": "1",
      "geoaddrid": "1",
      "ip4": "0",
      "tstamp": "1988-08-05T11:50:51-05:00",
      "geoAddress": "1",
      "links": {
        "geoAddress": "https://:account.api-us1.com/api/:version/geoIps/1/geoAddress"
      },
      "id": "1"
    }
  ],
  "contact": {
    "cdate": "2007-05-05T12:49:09-05:00",
    "email": "selmer.koss@example.com",
    "phone": "",
    "firstName": "Charles",
    "lastName": "Reynolds",
    "orgid": "0",
    "segmentio_id": "",
    "bounced_hard": "0",
    "bounced_soft": "0",
    "bounced_date": null,
    "ip": "0",
    "ua": null,
    "hash": "",
    "socialdata_lastcheck": null,
    "email_local": "",
    "email_domain": "",
    "sentcnt": "0",
    "rating_tstamp": null,
    "gravatar": "0",
    "deleted": "0",
    "adate": null,
    "udate": null,
    "edate": null,
    "contactAutomations": [
      "1"
    ],
    "contactLists": [
      "1"
    ],
    "fieldValues": [
      "1"
    ],
    "geoIps": [
      "1"
    ],
    "deals": [
      "1"
    ],
    "accountContacts": [
      "1"
    ],
    "links": {
      "bounceLogs": "/1/bounceLogs",
      "contactAutomations": "/1/contactAutomations",
      "contactData": "/1/contactData",
      "contactGoals": "/1/contactGoals",
      "contactLists": "/1/contactLists",
      "contactLogs": "/1/contactLogs",
      "contactTags": "/1/contactTags",
      "contactDeals": "/1/contactDeals",
      "deals": "/1/deals",
      "fieldValues": "/1/fieldValues",
      "geoIps": "/1/geoIps",
      "notes": "/1/notes",
      "organization": "/1/organization",
      "plusAppend": "/1/plusAppend",
      "trackingLogs": "/1/trackingLogs",
      "scoreValues": "/1/scoreValues"
    },
    "id": "1",
    "organization": null
  }
}
{
  "message":"No Result found for Subscriber with id 1"
}

Path Params

id
int32
required

ID of the contact

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

Update list status for a contact

Subscribe a contact to a list or unsubscribe a contact from a list.

 
posthttps://youraccountname.api-us1.com/api/3/contactLists
{
    "contactList": {
        "list": 2,
        "contact": 1,
        "status": 1
    }
}
A binary file was returned

You couldn't be authenticated

{
    "contacts": [
        {
            "cdate": "2017-07-24T12:09:52-05:00",
            "email": "johndoe@example.com",
            "phone": "",
            "firstName": "John",
            "lastName": "Doe",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": "0000-00-00",
            "ip": "0",
            "ua": "",
            "hash": "1234567890",
            "socialdata_lastcheck": "0000-00-00 00:00:00",
            "email_local": "",
            "email_domain": "",
            "sentcnt": "1",
            "rating_tstamp": "0000-00-00",
            "gravatar": "0",
            "deleted": "0",
            "anonymized": "0",
            "adate": "2018-10-16T13:52:32-05:00",
            "udate": "2018-10-16T13:50:18-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "created_utc_timestamp": "2018-10-01 08:40:10",
            "updated_utc_timestamp": "2018-10-16 13:50:18",
            "links": {
                "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/1/bounceLogs",
                "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/1/contactAutomations",
                "contactData": "https://:account.api-us1.com/api/:version/contacts/1/contactData",
                "contactGoals": "https://:account.api-us1.com/api/:version/contacts/1/contactGoals",
                "contactLists": "https://:account.api-us1.com/api/:version/contacts/1/contactLists",
                "contactLogs": "https://:account.api-us1.com/api/:version/contacts/1/contactLogs",
                "contactTags": "https://:account.api-us1.com/api/:version/contacts/1/contactTags",
                "contactDeals": "https://:account.api-us1.com/api/:version/contacts/1/contactDeals",
                "deals": "https://staging-tjahn.api-us1.com/api/3/contacts/1/deals",
                "fieldValues": "https://:account.api-us1.com/api/:version/contacts/1/fieldValues",
                "geoIps": "https://:account.api-us1.com/api/:version/contacts/1/geoIps",
                "notes": "https://:account.api-us1.com/api/:version/contacts/1/notes",
                "organization": "https://:account.api-us1.com/api/:version/contacts/1/organization",
                "plusAppend": "https://:account.api-us1.com/api/:version/contacts/1/plusAppend",
                "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/1/trackingLogs",
                "scoreValues": "https://:account.api-us1.com/api/:version/contacts/1/scoreValues"
            },
            "id": "1",
            "organization": null
        }
    ],
    "contactList": {
        "contact": "1",
        "list": "2",
        "form": null,
        "seriesid": "0",
        "sdate": "2018-10-16T13:52:35-05:00",
        "status": 1,
        "responder": "1",
        "sync": "0",
        "unsubreason": "",
        "campaign": null,
        "message": null,
        "first_name": "John",
        "last_name": "Doe",
        "ip4Sub": "0",
        "sourceid": "3",
        "autosyncLog": null,
        "ip4_last": "0",
        "ip4Unsub": "0",
        "unsubscribeAutomation": null,
        "links": {
            "automation": "https://:account.api-us1.com/api/:version/contactLists/2/automation",
            "list": "https://:account.api-us1.com/api/:version/contactLists/2/list",
            "contact": "https://:account.api-us1.com/api/:version/contactLists/2/contact",
            "form": "https://:account.api-us1.com/api/:version/contactLists/2/form",
            "autosyncLog": "https://:account.api-us1.com/api/:version/contactLists/2/autosyncLog",
            "campaign": "https://:account.api-us1.com/api/:version/contactLists/2/campaign",
            "unsubscribeAutomation": "https://:account.api-us1.com/api/:version/contactLists/2/unsubscribeAutomation",
            "message": "https://:account.api-us1.com/api/:version/contactLists/2/message"
        },
        "id": "2",
        "automation": null
    }
}

Body Params

contactList
object
contactList.list
string
required

ID of the list to subscribe the contact to

contactList.contact
string
required

ID of the contact to subscribe to the list

contactList.status
string
required

Set to "1" to subscribe the contact to the list. Set to "2" to unsubscribe the contact from the list.

contactList.sourceid
int32

Set to "4" when re-subscribing a contact to a list

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

Update a contact

 
puthttps://youraccountname.api-us1.com/api/3/contacts/id
{
	"contact": {
		"email": "johndoe@example.com",
		"firstName": "John",
		"lastName": "Doe"
	}
}
A binary file was returned

You couldn't be authenticated

{
    "contact": {
        "cdate": "2018-09-28T13:50:41-05:00",
        "email": "johndoe@example.com",
        "phone": "",
        "firstName": "John",
        "lastName": "Doe",
        "orgid": "0",
        "segmentio_id": "",
        "bounced_hard": "0",
        "bounced_soft": "0",
        "bounced_date": null,
        "ip": "0",
        "ua": null,
        "hash": "8309146b50af1ed5f9cb40c7465a0315",
        "socialdata_lastcheck": null,
        "email_local": "",
        "email_domain": "",
        "sentcnt": "0",
        "rating_tstamp": null,
        "gravatar": "0",
        "deleted": "0",
        "anonymized": "0",
        "adate": null,
        "udate": "2018-09-28T13:55:59-05:00",
        "edate": null,
        "deleted_at": null,
        "created_utc_timestamp": "2018-09-28 13:50:41",
        "updated_utc_timestamp": "2018-09-28 13:50:41",
        "links": {
            "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/113/bounceLogs",
            "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/113/contactAutomations",
            "contactData": "https://:account.api-us1.com/api/:version/contacts/113/contactData",
            "contactGoals": "https://:account.api-us1.com/api/:version/contacts/113/contactGoals",
            "contactLists": "https://:account.api-us1.com/api/:version/contacts/113/contactLists",
            "contactLogs": "https://:account.api-us1.com/api/:version/contacts/113/contactLogs",
            "contactTags": "https://:account.api-us1.com/api/:version/contacts/113/contactTags",
            "contactDeals": "https://:account.api-us1.com/api/:version/contacts/113/contactDeals",
            "deals": "https://:account.api-us1.com/api/:version/contacts/113/deals",
            "fieldValues": "https://:account.api-us1.com/api/:version/contacts/113/fieldValues",
            "geoIps": "https://:account.api-us1.com/api/:version/contacts/113/geoIps",
            "notes": "https://:account.api-us1.com/api/:version/contacts/113/notes",
            "organization": "https://:account.api-us1.com/api/:version/contacts/113/organization",
            "plusAppend": "https://:account.api-us1.com/api/:version/contacts/113/plusAppend",
            "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/113/trackingLogs",
            "scoreValues": "https://:account.api-us1.com/api/:version/contacts/113/scoreValues"
        },
        "id": "113",
        "organization": null
    }
}
{
    "message": "No Result found for Subscriber with id 1"
}

Path Params

id
int32
required

ID of the contact to update

Body Params

contact
object
contact.email
string
contact.firstName
string
contact.lastName
string
contact.phone
string
contact.deleted
boolean
contact.orgid
int32

(Deprecated) Please use Account-Contact end points

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

Delete a contact

Delete an existing contact

 
deletehttps://youraccountname.api-us1.com/api/3/contacts/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/contacts/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/contacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/contacts/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contacts/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "message":"No result found for contact with id 1"
}

Path Params

id
int32
required

The contact id

 

List all contacts

View many (or all) contacts by including their ID's or various filters. This is useful for searching for contacts that match certain criteria - such as being part of a certain list, or having a specific custom field value.

 
gethttps://youraccountname.api-us1.com/api/3/contacts
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contacts
var request = require("request");

var options = { method: 'GET',
  url: 'https://youraccountname.api-us1.com/api/3/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contacts");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contacts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
   "contacts":[
      {
         "cdate":"2017-01-25T23:58:14-06:00",
         "email":"janedoe@example.com",
         "phone":"3120000000",
         "firstName":"John",
         "lastName":"Doe",
         "orgid":"0",
         "segmentio_id":"",
         "bounced_hard":"0",
         "bounced_soft":"0",
         "bounced_date":"0000-00-00",
         "ip":"0",
         "ua":"",
         "hash":"31e076c964f4262817f9ba302c96e1c6",
         "socialdata_lastcheck":"0000-00-00 00:00:00",
         "email_local":"",
         "email_domain":"",
         "sentcnt":"0",
         "rating_tstamp":"0000-00-00",
         "gravatar":"3",
         "deleted":"0",
         "adate":"2017-02-22 15:26:24",
         "udate":"2017-01-25T23:58:14-06:00",
         "edate":"2017-01-27 14:44:13",
         "scoreValues":[

         ],
         "links":{
            "bounceLogs":"https://:account.api-us1.com/api/:version/contacts/68/bounceLogs",
            "contactAutomations":"https://:account.api-us1.com/api/:version/contacts/68/contactAutomations",
            "contactData":"https://:account.api-us1.com/api/:version/contacts/68/contactData",
            "contactGoals":"https://:account.api-us1.com/api/:version/contacts/68/contactGoals",
            "contactLists":"https://:account.api-us1.com/api/:version/contacts/68/contactLists",
            "contactLogs":"https://:account.api-us1.com/api/:version/contacts/68/contactLogs",
            "contactTags":"https://:account.api-us1.com/api/:version/contacts/68/contactTags",
            "contactDeals":"https://:account.api-us1.com/api/:version/contacts/68/contactDeals",
            "deals":"https://:account.api-us1.com/api/:version/contacts/68/deals",
            "fieldValues":"https://:account.api-us1.com/api/:version/contacts/68/fieldValues",
            "geoIps":"https://:account.api-us1.com/api/:version/contacts/68/geoIps",
            "notes":"https://:account.api-us1.com/api/:version/contacts/68/notes",
            "organization":"https://:account.api-us1.com/api/:version/contacts/68/organization",
            "plusAppend":"https://:account.api-us1.com/api/:version/contacts/68/plusAppend",
            "trackingLogs":"https://:account.api-us1.com/api/:version/contacts/68/trackingLogs",
            "scoreValues":"https://:account.api-us1.com/api/:version/contacts/68/scoreValues"
         },
         "id":"68",
         "organization":null
      },
      {
         "cdate":"2017-02-09T12:14:58-06:00",
         "email":"aaronallen@example.com",
         "phone":"",
         "firstName":"Aaron",
         "lastName":"Allen",
         "orgid":"14",
         "segmentio_id":"",
         "bounced_hard":"0",
         "bounced_soft":"0",
         "bounced_date":"0000-00-00",
         "ip":"0",
         "ua":"",
         "hash":"31b92c033c3e55de6d9eb9c44ee1bfa5",
         "socialdata_lastcheck":"0000-00-00 00:00:00",
         "email_local":"",
         "email_domain":"",
         "sentcnt":"0",
         "rating_tstamp":"0000-00-00",
         "gravatar":"1",
         "deleted":"0",
         "adate":"2017-03-16 13:18:12",
         "udate":"2017-02-09T12:14:58-06:00",
         "edate":"0000-00-00 00:00:00",
         "scoreValues":[

         ],
        "accountContacts": [
            "1"
         ],
         "links":{
            "bounceLogs":"https://:account.api-us1.com/api/:version/contacts/73/bounceLogs",
            "contactAutomations":"https://:account.api-us1.com/api/:version/contacts/73/contactAutomations",
            "contactData":"https://:account.api-us1.com/api/:version/contacts/73/contactData",
            "contactGoals":"https://:account.api-us1.com/api/:version/contacts/73/contactGoals",
            "contactLists":"https://:account.api-us1.com/api/:version/contacts/73/contactLists",
            "contactLogs":"https://:account.api-us1.com/api/:version/contacts/73/contactLogs",
            "contactTags":"https://:account.api-us1.com/api/:version/contacts/73/contactTags",
            "contactDeals":"https://:account.api-us1.com/api/:version/contacts/73/contactDeals",
            "deals":"https://:account.api-us1.com/api/:version/contacts/73/deals",
            "fieldValues":"https://:account.api-us1.com/api/:version/contacts/73/fieldValues",
            "geoIps":"https://:account.api-us1.com/api/:version/contacts/73/geoIps",
            "notes":"https://:account.api-us1.com/api/:version/contacts/73/notes",
            "organization":"https://:account.api-us1.com/api/:version/contacts/73/organization",
            "plusAppend":"https://:account.api-us1.com/api/:version/contacts/73/plusAppend",
            "trackingLogs":"https://:account.api-us1.com/api/:version/contacts/73/trackingLogs",
            "scoreValues":"https://:account.api-us1.com/api/:version/contacts/73/scoreValues"
         },
         "id":"73",
         "organization":"14"
      }
   ],
   "meta":{
      "total":"2",
      "page_input":{
         "segmentid":0,
         "formid":0,
         "listid":0,
         "tagid":0,
         "limit":20,
         "offset":0,
         "search":null,
         "sort":null,
         "seriesid":0,
         "waitid":0,
         "status":-1,
         "forceQuery":0,
         "cacheid":"895202850f4ca4144513c0962812f951"
      }
   }
}
{
    "scoreValues": [],
    "contacts": [
        {
            "cdate": "2018-09-12T16:53:50-05:00",
            "email": "adam@activecampaign.com",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": "0000-00-00",
            "ip": "0",
            "ua": "",
            "hash": "0d9c41ae7a4de516313673e2341f6003",
            "socialdata_lastcheck": "0000-00-00 00:00:00",
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": "0000-00-00",
            "gravatar": "1",
            "deleted": "0",
            "anonymized": "0",
            "udate": "2018-09-12T17:00:00-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/scoreValues"
            },
            "id": "5",
            "organization": null
        },
        {
            "cdate": "2018-08-17T13:46:58-05:00",
            "email": "kconnell2@gmailc.om",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": "0000-00-00",
            "ip": "2130706433",
            "ua": "",
            "hash": "4641d20634346d27408557fde5e3ad3b",
            "socialdata_lastcheck": "0000-00-00 00:00:00",
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": "0000-00-00",
            "gravatar": "1",
            "deleted": "0",
            "anonymized": "0",
            "adate": "2018-08-31T11:58:25-05:00",
            "udate": "2018-08-17T13:46:58-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/scoreValues"
            },
            "id": "4",
            "organization": null
        },
        {
            "cdate": "2018-09-18T11:02:57-05:00",
            "email": "test@gmail.com",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": null,
            "ip": "0",
            "ua": null,
            "hash": "",
            "socialdata_lastcheck": null,
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": null,
            "gravatar": "1",
            "deleted": "0",
            "anonymized": "0",
            "adate": null,
            "udate": "2018-09-18T11:02:57-05:00",
            "edate": null,
            "deleted_at": null,
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/scoreValues"
            },
            "id": "6",
            "organization": null
        },
        {
            "cdate": "2018-08-17T09:56:33-05:00",
            "email": "test@test.com",
            "phone": "9813764",
            "firstName": "Test",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": "0000-00-00",
            "ip": "2130706433",
            "ua": "",
            "hash": "e4162c50b2edaf68b0d5012ef3cc82fd",
            "socialdata_lastcheck": "0000-00-00 00:00:00",
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": "0000-00-00",
            "gravatar": "1",
            "deleted": "0",
            "anonymized": "0",
            "adate": "2018-08-31T11:52:08-05:00",
            "udate": "2018-08-17T09:56:33-05:00",
            "edate": "2018-08-17T13:48:46-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/scoreValues"
            },
            "id": "2",
            "organization": null
        },
        {
            "cdate": "2018-08-17T13:45:23-05:00",
            "email": "test@testing.com",
            "phone": "20405938",
            "firstName": "testing",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": null,
            "ip": "2130706433",
            "ua": null,
            "hash": "e3eba337bb1ede3bd073b1832e3f3def",
            "socialdata_lastcheck": null,
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": null,
            "gravatar": "1",
            "deleted": "0",
            "anonymized": "0",
            "adate": null,
            "udate": "2018-08-17T13:45:23-05:00",
            "edate": null,
            "deleted_at": null,
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/scoreValues"
            },
            "id": "3",
            "organization": null
        },
        {
            "cdate": "2018-09-19T23:11:11-05:00",
            "email": "tjahn+test@activecampaign.com",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": "0000-00-00",
            "ip": "0",
            "ua": "",
            "hash": "853be08a2387ac13ca51dee72e586e9c",
            "socialdata_lastcheck": "0000-00-00 00:00:00",
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": "0000-00-00",
            "gravatar": "0",
            "deleted": "0",
            "anonymized": "0",
            "adate": "2018-09-19T23:24:43-05:00",
            "udate": "2018-09-19T23:11:11-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "scoreValues": [],
            "links": {
                "bounceLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/bounceLogs",
                "contactAutomations": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactAutomations",
                "contactData": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactData",
                "contactGoals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactGoals",
                "contactLists": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactLists",
                "contactLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactLogs",
                "contactTags": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactTags",
                "contactDeals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactDeals",
                "deals": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/deals",
                "fieldValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/fieldValues",
                "geoIps": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/geoIps",
                "notes": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/notes",
                "organization": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/organization",
                "plusAppend": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/plusAppend",
                "trackingLogs": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/trackingLogs",
                "scoreValues": "https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/scoreValues"
            },
            "id": "7",
            "organization": null
        }
    ],
    "meta": {
        "total": "6",
        "page_input": {
            "segmentid": 0,
            "formid": 0,
            "listid": 0,
            "tagid": 0,
            "limit": 20,
            "offset": 0,
            "search": null,
            "sort": null,
            "seriesid": 0,
            "waitid": 0,
            "status": -1,
            "forceQuery": 0,
            "cacheid": "522b5224f2007dca7483e08e7ebf5005"
        }
    }
}

Query Params

ids
string

Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42

datetime
date

Contacts created on the specified date

email
string

Email address of the contact you want to get

email_like
string

Filter contacts that contain the given value in the email address

exclude
int32

Exclude from the response the contact with the given ID

formid
int32

Filter contacts associated with the given form

id_greater
int32

Only include contacts with an ID greater than the given ID

id_less
int32

Only include contacts with an ID less than the given ID

listid
string

Filter contacts associated with the given list

organization
int32

(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID

search
string

Filter contacts that match the given value in the contact names, organization, phone or email

segmentid
int32

Return only contacts that match a list segment

seriesid
int32

Filter contacts associated with the given automation

status
int32
tagid
int32

Filter contacts associated with the given tag

filters[created_before]
date

Filter contacts that were created prior to this date

filters[created_after]
date

Filter contacts that were created after this date

filters[updated_before]
date

Filter contacts that were updated before this date

filters[updated_after]
string

Filter contacts that were updated after this date

waitid
int32

Filter by contacts in the wait queue of an automation block

orders[cdate]
string

Order contacts by creation date

orders[email]
string

Order contacts by email

orders[first_name]
string

Order contacts by first name

orders[last_name]
string

Order contacts by last name

orders[name]
string

Order contacts by full name

orders[score]
string

Order contacts by score

in_group_lists
string

Set this to "true" in order to return only contacts that the current user has permissions to see.

 

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

List all automations the contact is in

 
gethttps://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contacts/id/contactAutomations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "contactAutomations": []
}
{
    "message": "No Result found for Subscriber with id 1"
}

Path Params

id
int32
required

ID of the contact to receive automations for

 

Retrieve a contacts score value

 
gethttps://youraccountname.api-us1.com/api/3/contacts/id/scoreValues
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contacts/id/scoreValues
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/contacts/id/scoreValues' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contacts/id/scoreValues")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contacts/id/scoreValues");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contacts/id/scoreValues"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "scoreValues": [
        {
            "score": "2",
            "contact": "1",
            "deal": null,
            "cdate": "2018-03-08T14:01:16-06:00",
            "mdate": "2018-10-22T20:15:28-05:00",
            "scoreValue": "0",
            "links": {
                "score": "https://:account.api-us1.com/api/3/scoreValues/1/score",
                "contact": "https://:account.api-us1.com/api/3/scoreValues/1/contact",
                "deal": "https://:account.api-us1.com/api/3/scoreValues/1/deal"
            },
            "id": "1"
        }
    ]
}
{
    "message": "No Result found for Subscriber with id 100"
}
 

Automations

Contacts can be added to any number of automations and be at different positions in each automation. The API enables you to add a contact to an automation, learn what automations a contact is in, and remove a contact from an automation.

 

Add a contact to an automation

 
posthttps://youraccountname.api-us1.com/api/3/contactAutomations
curl --request POST \
  --url https://youraccountname.api-us1.com/api/3/contactAutomations
var request = require("request");

var options = { method: 'POST',
  url:
   'https://youraccountname.api-us1.com/api/3/contactAutomations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contactAutomations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://youraccountname.api-us1.com/api/3/contactAutomations");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contactAutomations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "contacts": [
        {
            "cdate": "2018-08-06T16:26:06-05:00",
            "email": "johndoe@example.com",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": null,
            "ip": "2130706433",
            "ua": null,
            "hash": "054aa0acede49e07a844420c879b3c30",
            "socialdata_lastcheck": null,
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": null,
            "gravatar": "0",
            "deleted": "0",
            "anonymized": "0",
            "adate": null,
            "udate": null,
            "edate": null,
            "deleted_at": null,
            "created_utc_timestamp": "2018-09-21 12:04:40",
            "updated_utc_timestamp": "2018-09-21 12:04:40",
            "links": {
                "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/64/bounceLogs",
                "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/64/contactAutomations",
                "contactData": "https://:account.api-us1.com/api/:version/contacts/64/contactData",
                "contactGoals": "https://:account.api-us1.com/api/:version/contacts/64/contactGoals",
                "contactLists": "https://:account.api-us1.com/api/:version/contacts/64/contactLists",
                "contactLogs": "https://:account.api-us1.com/api/:version/contacts/64/contactLogs",
                "contactTags": "https://:account.api-us1.com/api/:version/contacts/64/contactTags",
                "contactDeals": "https://:account.api-us1.com/api/:version/contacts/64/contactDeals",
                "deals": "https://:account.api-us1.com/api/:version/contacts/64/deals",
                "fieldValues": "https://:account.api-us1.com/api/:version/contacts/64/fieldValues",
                "geoIps": "https://:account.api-us1.com/api/:version/contacts/64/geoIps",
                "notes": "https://:account.api-us1.com/api/:version/contacts/64/notes",
                "organization": "https://:account.api-us1.com/api/:version/contacts/64/organization",
                "plusAppend": "https://:account.api-us1.com/api/:version/contacts/64/plusAppend",
                "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/64/trackingLogs",
                "scoreValues": "https://:account.api-us1.com/api/:version/contacts/64/scoreValues"
            },
            "id": "64",
            "organization": null
        }
    ],
    "contactAutomation": {
        "contact": "64",
        "seriesid": "2",
        "startid": 0,
        "status": 1,
        "lastblock": "4",
        "completedElements": "1",
        "totalElements": "2",
        "completed": 0,
        "completeValue": 50,
        "links": {
            "automation": "https://:account.api-us1.com/api/:version/contactAutomations/3/automation",
            "contact": "https://:account.api-us1.com/api/:version/contactAutomations/3/contact",
            "contactGoals": "https://:account.api-us1.com/api/:version/contactAutomations/3/contactGoals"
        },
        "id": "3",
        "automation": "2"
    }
}
{
    "message": "Could not create SubscriberSeries"
}

Body Params

contactAutomation
object
contactAutomation.contact
int32
required

Contact ID of the Contact, to be linked to the contactAutomation

contactAutomation.automation
int32
required

Automation ID of the automation, to be linked to the contactAutomation

 

Retrieve an automation a contact is in

 
gethttps://youraccountname.api-us1.com/api/3/contactAutomations/id
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contactAutomations/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/contactAutomations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contactAutomations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contactAutomations/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contactAutomations/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "contactAutomation": {
        "contact": "110",
        "seriesid": "2",
        "startid": "0",
        "status": "2",
        "batchid": null,
        "adddate": "2018-09-19T09:44:26-05:00",
        "remdate": "2018-09-19T09:44:26-05:00",
        "timespan": "0",
        "lastblock": "5",
        "lastlogid": "2",
        "lastdate": "2018-09-19T09:44:26-05:00",
        "completedElements": "1",
        "totalElements": "2",
        "completed": 1,
        "completeValue": 100,
        "links": {
            "automation": "https://:account.api-us1.com/api/:version/contactAutomations/2/automation",
            "contact": "https://:account.api-us1.com/api/:version/contactAutomations/2/contact",
            "contactGoals": "https://:account.api-us1.com/api/:version/contactAutomations/2/contactGoals"
        },
        "id": "2",
        "automation": "2"
    }
}
{
    "message": "No Result found for SubscriberSeries with id 3"
}

Path Params

id
int32
required

ID of the contactAutomation to retrieve

 

Remove a contact from an automation

 
deletehttps://youraccountname.api-us1.com/api/3/contactAutomation/id
curl --request DELETE \
  --url https://youraccountname.api-us1.com/api/3/contactAutomation/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://youraccountname.api-us1.com/api/3/contactAutomation/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contactAutomation/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://youraccountname.api-us1.com/api/3/contactAutomation/id");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contactAutomation/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "No Result found for SubscriberSeries with id 3"
}

Path Params

id
int32
required

ID of the contactAutomation to delete

 

List all automations a contact is in

 
gethttps://youraccountname.api-us1.com/api/3/contactAutomations
curl --request GET \
  --url https://youraccountname.api-us1.com/api/3/contactAutomations
var request = require("request");

var options = { method: 'GET',
  url:
   'https://youraccountname.api-us1.com/api/3/contactAutomations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://youraccountname.api-us1.com/api/3/contactAutomations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://youraccountname.api-us1.com/api/3/contactAutomations");

xhr.send(data);
import requests

url = "https://youraccountname.api-us1.com/api/3/contactAutomations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "contactAutomations": [
        {
            "contact": "10003",
            "seriesid": "1",
            "startid": "0",
            "status": "2",
            "batchid": null,
            "adddate": "2018-11-16T02:32:33-06:00",
            "remdate": "2018-11-16T02:32:33-06:00",
            "timespan": "0",
            "lastblock": "1",
            "lastlogid": "0",
            "lastdate": "2018-11-16T02:32:33-06:00",
            "completedElements": "0",
            "totalElements": "1",
            "completed": 1,
            "completeValue": 100,
            "links": {
                "automation": "https://:account.api-us1.com/api/:version/contactAutomations/1/automation",
                "contact": "https://:account.api-us1.com/api/:version/contactAutomations/1/contact",
                "contactGoals": "https://:account.api-us1.com/api/:version/contactAutomations/1/contactGoals"
            },
            "id": "1",
            "automation": "1"
        }
    ],
    "meta": {
        "total": "1",
        "showcase_stats": []
    }
}
 

Custom Fields

Custom fields enable you to attach field types to a contact that suit your needs (including but not limited to dropdowns, radio buttons, textareas, date fields, and more). The API enables you to create, update, delete, and view custom field resources.

 

Create a custom field

 
posthttps://youraccountname.api-us1.com/api/3/fields
{
	"field": {
		"type": "textarea",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "Defaut Value",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "text",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "Defaut Value",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "date",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "2019-01-01",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "dropdown",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "listbox",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "radio",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "checkbox",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"visible": 1,
		"ordernum": 1
    }
}
{
	"field": {
		"type": "hidden",
		"title": "Field Title",
		"descript": "Field description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "Defaut Value",
		"visible": 1,
		"ordernum": 1
    }
}
A binary file was returned

You couldn't be authenticated

{
    "fieldOptions": [],
    "fieldRels": [],
    "fields": [
        {
            "title": "Another Test Title",
            "descript": null,
            "type": "",
            "isrequired": "0",
            "perstag": "ANOTHER_TEST_TITLE",
            "defval": null,
            "show_in_list": "0",
            "rows": "0",
            "cols": "0",
            "visible": "1",
            "service": "",
            "ordernum": "2",
            "cdate": "2018-11-15T21:43:38-06:00",
            "udate": "2018-11-15T21:43:38-06:00",
            "options": [],
            "relations": [],
            "links": {
                "options": "https://:account.api-us1.com/api/:version/fields/2/options",
                "relations": "https://:account.api-us1.com/api/:version/fields/2/relations"
            },
            "id": "2"
        },
        {
            "title": "Title",
            "descript": "Field  description",
            "type": "textarea",
            "isrequired": "1",
            "perstag": "PERSONALIZEDTAG",
            "defval": "Defaut Value",
            "show_in_list": "1",
            "rows": "2",
            "cols": "2",
            "visible": "1",
            "service": "google",
            "ordernum": "3",
            "cdate": "2018-11-15T21:42:40-06:00",
            "udate": "2018-11-15T21:49:52-06:00",
            "options": [],
            "relations": [],
            "links": {
                "options": "https://:account.api-us1.com/api/:version/fields/1/options",
                "relations": "https://:account.api-us1.com/api/:version/fields/1/relations"
            },
            "id": "1"
        }
    ],
    "meta": {
        "total": "2"
    }
}
{
    "message": "Forbidden"
}
{
    "errors": [
        {
            "title": "The field title was not provided.",
            "detail": "",
            "code": "field_missing"
        }
    ]
}
{
    "errors": [
        {
            "title": "There is already a field with this personalization tag",
            "detail": "There is already a personalization tag named 'Perstag' -- choose another name",
            "code": "field_invalid"
        }
    ]
}
{
    "errors": [
        {
            "title": "There is already a field with this title",
            "detail": "There is already a field named 'Test Title' -- choose another name",
            "code": "dup