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. 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.

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.",
      "source": {
        "pointer": "/data/attributes/service"
      }
    },
    {
      "title": "The connection externalid was not provided.",
      "source": {
        "pointer": "/data/attributes/externalid"
      }
    }
  ]
}

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://:account.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://:account.api-us1.com/api/3/addresses/id
curl --request GET \
  --url https:///:account.api-us1.com/api/3/addresses/id
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/addresses/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.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://:account.api-us1.com/api/3/addresses/id
curl --request DELETE \
  --url https:///:account.api-us1.com/api/3/addresses/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/addresses/id");

xhr.send(data);
import requests

url = "https:///:account.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

 

Remove address associated with a specific user group

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

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/addressGroups/id");

xhr.send(data);
import requests

url = "https:///:account.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

 

Remove address associated with a specific list

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

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/addressLists/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/addresses
curl --request GET \
  --url https:///:account.api-us1.com/api/3/addresses
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/addresses");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/automations
curl --request GET \
  --url https:///:account.api-us1.com/api/3/automations
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/automations");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/brandings/id
curl --request GET \
  --url https:///:account.api-us1.com/api/3/brandings/id
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/brandings/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/brandings/id
curl --request PUT \
  --url https:///:account.api-us1.com/api/3/brandings/1
var request = require("request");

var options = { method: 'PUT',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/brandings/1");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/brandings
curl --request GET \
  --url https:///:account.api-us1.com/api/3/brandings
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/brandings");

xhr.send(data);
import requests

url = "https:///:account.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

 

Campaigns

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

 

List all campaigns

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

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/campaigns");

xhr.send(data);
import requests

url = "https:///:account.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"
    }
}
 

Messages

 

Create a new message

 
posthttps://:account.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://:account.api-us1.com/api/3/messages/id
curl --request GET \
  --url https:///:account.api-us1.com/api/3/messages/id
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/messages/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.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://:account.api-us1.com/api/3/messages/id
curl --request DELETE \
  --url https:///:account.api-us1.com/api/3/messages/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/messages/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/messages
curl --request GET \
  --url https:///:account.api-us1.com/api/3/messages
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/messages");

xhr.send(data);
import requests

url = "https:///:account.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 new contact

Retrieve an existing contact

 
posthttps://:account.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
contact.firstName
string
contact.lastName
string
contact.deleted
int32

Boolean

contact.orgid
int32
contact.phone
int32
 

Create or update contact

 
posthttps://:account.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
contact.deleted
boolean
 

Retrieve a contact

Retrieve an existing contact

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

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contacts/id");

xhr.send(data);
import requests

url = "https:///:account.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"
    ],
    "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

 

Update list status for a contact

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

 
posthttps://:account.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.

 

Update a contact

 
puthttps://:account.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
 

Delete a contact

Delete an existing contact

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

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contacts/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/contacts
curl --request GET \
  --url https:///:account.api-us1.com/api/3/contacts
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contacts");

xhr.send(data);
import requests

url = "https:///:account.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":[

         ],
         "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

fields
string

Array of fields and values to filter by. You can filter using personalization tags or tag IDs. E.g. filters[fields][12]=value

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

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

since_datetime
date

Contacts since a specified date in the past

until_datetime
date

Contacts until a specified date

created_before
date

Filter contacts that were created prior to this date

created_after
date

Filter contacts that were created after this date

updated_before
date

Filter contacts that were updated before this date

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.

 

List all automations the contact is in

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

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contacts/id/contactAutomations");

xhr.send(data);
import requests

url = "https:///:account.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

 

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://:account.api-us1.com/api/3/contactAutomations
curl --request POST \
  --url https:///:account.api-us1.com/api/3/contactAutomations
var request = require("request");

var options = { method: 'POST',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contactAutomations");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/contactAutomations/id
curl --request GET \
  --url https:///:account.api-us1.com/api/3/contactAutomations/id
var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contactAutomations/id");

xhr.send(data);
import requests

url = "https:///:account.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://:account.api-us1.com/api/3/contactAutomation/id
curl --request DELETE \
  --url https:///:account.api-us1.com/api/3/contactAutomation/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https:///:account.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:///:account.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:///:account.api-us1.com/api/3/contactAutomation/id");

xhr.send(data);
import requests

url = "https:///:account.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

 

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://:account.api-us1.com/api/3/fields
{
	"field": {
		"type": "textarea",
		"title": "Field Title",
		"descript": "Field  description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "Defaut Value",
		"show_in_list": 1,
		"rows": 2,
		"cols": 2,
		"visible": 1,
		"service": "google",
		"ordernum": 3
    }
}
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",
            "source": {
                "pointer": "/data/attributes/title"
            }
        }
    ]
}
{
    "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",
            "source": {
                "pointer": "/data/attributes/perstag"
            }
        }
    ]
}
{
    "errors": [
        {
            "title": "There is already a field with this title",
            "detail": "There is already a field named 'Test Title' -- choose another name",
            "code": "duplicate",
            "source": {
                "pointer": "/data/attributes/title"
            }
        }
    ]
}

Body Params

field
object
field.title
string
required

Title of the field being created

field.type
string

Possible Values: dropdown, hidden, checkbox, date, text, textarea, NULL, listbox, radio

field.descript
string

Description of field being created

field.isrequired
boolean

Dictates whether the field being created, is required or not

field.perstag
string

The perstag that represents the field being created

field.defval
string

Default value of the field being created

field.show_in_list
boolean

Show this field in the contact list view (No longer Used)

field.visible
int32
field.service
string

Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook

field.ordernum
int32

Order of appearance in ‘My Fields’ tab.

 

Retrieve a custom field

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/fields/: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:///:account.api-us1.com/api/3/fields/:id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/fields/:id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "fieldOptions": [],
    "fieldRels": [
        {
            "field": "1",
            "relid": "0",
            "dorder": "0",
            "cdate": "2018-08-17T11:09:43-05:00",
            "links": [],
            "id": "1"
        }
    ],
    "field": {
        "title": "test",
        "descript": "",
        "type": "text",
        "isrequired": "0",
        "perstag": "TEST",
        "defval": "",
        "show_in_list": "0",
        "rows": "0",
        "cols": "0",
        "visible": "1",
        "service": "",
        "ordernum": "1",
        "cdate": "2018-08-17T11:09:43-05:00",
        "udate": "2018-08-17T11:09:43-05:00",
        "options": [],
        "relations": [
            "1"
        ],
        "links": {
            "options": "https://:account.api-us1.com/api/3/fields/1/options",
            "relations": "https://:account.api-us1.com/api/3/fields/1/relations"
        },
        "id": "1"
    }
}

Path Params

ID
int32
required

ID of the field to retrieve

 

Update a custom field

 
puthttps://:account.api-us1.com/api/3/fields/id
{
	"field": {
		"type": "textarea",
		"title": "Title",
		"descript": "Field  description",
		"isrequired": 1,
		"perstag": "Personalized Tag",
		"defval": "Defaut Value",
		"show_in_list": 1,
		"rows": 2,
		"cols": 2,
		"visible": 1,
		"service": "google",
		"ordernum": 3
    }
}
A binary file was returned

You couldn't be authenticated

{
    "field": {
        "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-09-25T16:06:08-05:00",
        "udate": "2018-09-29T18:23:20-05:00",
        "links": {
            "options": "https://:account.api-us1.com/api/:version/fields/3/options",
            "relations": "https://:account.api-us1.com/api/:version/fields/3/relations"
        },
        "id": "3"
    }
}
{
    "message": "Forbidden"
}

Path Params

ID
int32
required

ID of the field to update

Body Params

field
object
field.type
string

Possible Values: dropdown, hidden, checkbox, date, text, textarea, NULL, listbox, radio

field.title
string

Title of the field being updated

field.descript
string

Description of field being updated

field.isrequired
boolean

Dictates whether the field being created, is required or not

field.perstag
string

The perstag that represents the field being created

field.defval
string

Default value of the field being created

field.show_in_list
boolean

Show this field in the contact list view (No longer Used)

field.visible
boolean

Setting to show/hide field

field.service
string

Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook

field.ordernum
string

Order of appearance in ‘My Fields’ tab.

 

Delete a custom field

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/fields/: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:///:account.api-us1.com/api/3/fields/:id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/fields/:id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "Forbidden"
}

Path Params

ID
int32
required

ID of the field option to delete

 

List all custom fields

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/fields")

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:///:account.api-us1.com/api/3/fields");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/fields"

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

print(response.text)
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"
    }
}
 

Custom Field Values

The API enables you to add, update, delete, and get custom field values for contacts. To create or remove custom fields, please see the "Custom Fields" section.

 

Create a custom field value

 
posthttps://:account.api-us1.com/api/3/fieldValues
{
    "fieldValue": {
        "contact": 2,
        "field": 3,
        "value": "Blue"
    }
}
A binary file was returned

You couldn't be authenticated

{
    "contacts": [
        {
            "cdate": "2018-08-06T16:26:04-05:00",
            "email": "ikreimont+2@activecampaign.com",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": null,
            "ip": "0",
            "ua": null,
            "hash": "14d8c4418ae944c68e9dde4a975854cc",
            "socialdata_lastcheck": null,
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": null,
            "gravatar": "0",
            "deleted": "0",
            "anonymized": "0",
            "adate": null,
            "udate": "2018-10-01T17:18:40-05:00",
            "edate": null,
            "deleted_at": null,
            "created_utc_timestamp": "2018-09-21 12:04:40",
            "updated_utc_timestamp": "2018-10-01 17:18:40",
            "links": {
                "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/2/bounceLogs",
                "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/2/contactAutomations",
                "contactData": "https://:account.api-us1.com/api/:version/contacts/2/contactData",
                "contactGoals": "https://:account.api-us1.com/api/:version/contacts/2/contactGoals",
                "contactLists": "https://:account.api-us1.com/api/:version/contacts/2/contactLists",
                "contactLogs": "https://:account.api-us1.com/api/:version/contacts/2/contactLogs",
                "contactTags": "https://:account.api-us1.com/api/:version/contacts/2/contactTags",
                "contactDeals": "https://:account.api-us1.com/api/:version/contacts/2/contactDeals",
                "deals": "https://:account.api-us1.com/api/:version/contacts/2/deals",
                "fieldValues": "https://:account.api-us1.com/api/:version/contacts/2/fieldValues",
                "geoIps": "https://:account.api-us1.com/api/:version/contacts/2/geoIps",
                "notes": "https://:account.api-us1.com/api/:version/contacts/2/notes",
                "organization": "https://:account.api-us1.com/api/:version/contacts/2/organization",
                "plusAppend": "https://:account.api-us1.com/api/:version/contacts/2/plusAppend",
                "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/2/trackingLogs",
                "scoreValues": "https://:account.api-us1.com/api/:version/contacts/2/scoreValues"
            },
            "id": "2",
            "organization": null
        }
    ],
    "fieldValue": {
        "contact": 2,
        "field": 3,
        "value": "Blue",
        "cdate": "2018-10-01T17:18:40-05:00",
        "udate": "2018-10-01T17:18:40-05:00",
        "links": {
            "owner": "https://:account.api-us1.com/api/:version/fieldValues/15/owner",
            "field": "https://:account.api-us1.com/api/:version/fieldValues/15/field"
        },
        "owner": 2,
        "id": "15"
    }
}
{
    "message": "Forbidden"
}

Body Params

fieldValue
object
fieldValue.contact
string
required

ID of the contact whose field value you're updating

fieldValue.field
string
required

ID of the custom field whose value you're updating for the contact

fieldValue.value
string
required

Value for the field that you're updating

 

Retrieve a custom field value

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/fieldValues/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:///:account.api-us1.com/api/3/fieldValues/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/fieldValues/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "fieldValue": {
        "contact": "0",
        "field": null,
        "value": null,
        "cdate": "2018-09-18T10:30:31-05:00",
        "udate": "2018-09-18T10:30:31-05:00",
        "links": {
            "owner": "https://:account.api-us1.com/api/3/fieldValues/2/owner",
            "field": "https://:account.api-us1.com/api/3/fieldValues/2/field"
        },
        "id": "2",
        "owner": null
    }
}
{
    "message": "No Result found for FieldValue with id 10"
}

Path Params

id
string
required

ID of the fieldValue to retrieve

 

Update a custom field value for contact

 
puthttps://:account.api-us1.com/api/3/fieldValues/:id
{
    "fieldValue": {
        "contact": 4,
        "field": 24,
        "value": "Blue"
    }
}
A binary file was returned

You couldn't be authenticated

{
    "contacts": [
        {
            "cdate": "2018-08-06T16:56:43-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": "4",
            "ua": "",
            "hash": "867d56644591991f6b50e1cb913f038b",
            "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-10-24T13:33:06-05:00",
            "udate": "2018-10-24T13:33:11-05:00",
            "edate": "2018-10-24T13:33:07-05:00",
            "deleted_at": "0000-00-00 00:00:00",
            "created_utc_timestamp": "2018-09-21 12:04:48",
            "updated_utc_timestamp": "2018-10-24 13:33:11",
            "links": {
                "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/24/bounceLogs",
                "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/24/contactAutomations",
                "contactData": "https://:account.api-us1.com/api/:version/contacts/24/contactData",
                "contactGoals": "https://:account.api-us1.com/api/:version/contacts/24/contactGoals",
                "contactLists": "https://:account.api-us1.com/api/:version/contacts/24/contactLists",
                "contactLogs": "https://:account.api-us1.com/api/:version/contacts/24/contactLogs",
                "contactTags": "https://:account.api-us1.com/api/:version/contacts/24/contactTags",
                "contactDeals": "https://:account.api-us1.com/api/:version/contacts/24/contactDeals",
                "deals": "https://:account.api-us1.com/api/:version/contacts/24/deals",
                "fieldValues": "https://:account.api-us1.com/api/:version/contacts/24/fieldValues",
                "geoIps": "https://:account.api-us1.com/api/:version/contacts/24/geoIps",
                "notes": "https://:account.api-us1.com/api/:version/contacts/24/notes",
                "organization": "https://:account.api-us1.com/api/:version/contacts/24/organization",
                "plusAppend": "https://:account.api-us1.com/api/:version/contacts/24/plusAppend",
                "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/24/trackingLogs",
                "scoreValues": "https://:account.api-us1.com/api/:version/contacts/24/scoreValues"
            },
            "id": "24",
            "organization": null
        }
    ],
    "fieldValue": {
        "contact": 4,
        "field": 24,
        "value": "Blue",
        "cdate": "2018-10-24T13:32:52-05:00",
        "udate": "2018-10-24T13:33:11-05:00",
        "links": {
            "owner": "https://:account.api-us1.com/api/:version/fieldValues/15/owner",
            "field": "https://:account.api-us1.com/api/:version/fieldValues/15/field"
        },
        "owner": 4,
        "id": "15"
    }
}

Body Params

fieldValue
object
fieldValue.contact
string
required

ID of the contact whose field value you're updating

fieldValue.field
string
required

ID of the custom field whose value you're updating for the contact

fieldValue.value
string
required

Value for the field that you're updating

 

Delete a custom field value

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/fieldValues/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:///:account.api-us1.com/api/3/fieldValues/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/fieldValues/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "message": "Forbidden"
}

Path Params

id
int32
required

ID of the fieldValue to delete

 

Tags

A contact can have any number of tags applied to them. The API enables you to add or remove a tag from a contact and see all the tags that have been applied to a specific contact.

 

The contactTags API endpoint is used to assign existing tags to existing contacts. If either the tag or the contact does not exist you must create them before trying to assign a tag to a contact. Refer to the links below for documentation on how to create contacts and tags.

How to create a Contact

How to create a Tag

Add a tag to contact

Create a contact tag object

 
posthttps://:account.api-us1.com/api/3/contactTags
{
	"contactTag": {
		"contact": "1",
		"tag": "20"
	}
}
{
	"contactTag": {
		"contact": "test@example.com",
		"tag": "Test"
	}
}
A binary file was returned

You couldn't be authenticated

{
	"contactTag": {
		"cdate": "2017-06-08T16:11:53-05:00",
		"contact":"1",
		"id":"1",
		"links":{
			"contact":"/1/contact",
			"tag":"/1/tag"
		},
		"tag":"20"
	}
}
{
  "errors":[
    {
      "status":404,
      "title":"Not Found",
      "detail":"Contact not found"
    }
  ]
}
{
  "errors":[
    {
      "status":422,
      "title":"Missing attribute",
      "source":{
        "pointer":"/data/attributes/contact"
      }
    }
  ]
}

Query Params

contact
string
required

Contact's id

tag
string
required

Tag's id

 

Remove a tag from a contact

Delete a contact tag object

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/contactTags/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:///:account.api-us1.com/api/3/contactTags/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/contactTags/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "message":"No Result found for SubscriberTag with id 1"
}

Path Params

id
int32
required

The contactTag id

 

Deals

Deals are a way to represent opportunities in the ActiveCampaign platform. A deal requires a primary contact to be assigned to the deal and any number of secondary contacts can be assigned as well. Deals can be moved between pipelines and stages.

 

In order to make requests to the Deals related API endpoints, the user should belong to a user group that has the Deals permission turned on.

Deals parameters available values

For following parameters:

  • search_field

Use following values:

Parameter value
Meaning

all

All three fields: title, contact, and org

title

Deal's title

contact

Deal's primary contact's first name and last name. If search parameter has more than one word, first word is used for matching first name of contacts and rest of the words are used for matching last name of contacts.

org

Deal's primary contact's organization name

For following parameters:

  • status
  • deal.status

Use following values:

Parameter value
Meaning

0

Open

1

Won

2

Lost

For following parameters:

  • nextdate_range

Use following values:

Parameter value
Meaning

upcoming

Deals with tasks that are due within 24 hours.

scheduled

Deals with tasks that are due in more than 24 hours

overdue

Deals with tasks that are past due dates.

no-task

Deals without any task.

For following parameters:

  • tag

Use following values:

Parameter value
Meaning

greater than 0

Deals with primary contacts that have the tag with given id

-1

Deals with primary contacts that have any tag

-2

Deals with primary contacts that have no tag

Create a deal

Create a new deal

 
posthttps://:account.api-us1.com/api/3/deals
{
  "deal": {
    "contact": "51",
    "description": "This deal is an important deal",
    "currency": "usd",
    "group": "1",
    "owner": "1",
    "percent": null,
    "stage": "1",
    "status": 0,
    "title": "AC Deal",
    "value": 45600,
  }
}
A binary file was returned

You couldn't be authenticated

{
  "contacts": [
    {
      "adate": "2017-02-06 15:50:11",
      "bounced_date": "0000-00-00",
      "bounced_hard": "0",
      "bounced_soft": "0",
      "cdate": "2017-02-03T11:26:41-06:00",
      "deleted": "0",
      "edate": "0000-00-00 00:00:00",
      "email": "johndoe@example.com",
      "email_domain": "",
      "email_local": "",
      "firstName": "",
      "gravatar": "1",
      "hash": "e1705a92f24edf5313ed21df44d6ff5f",
      "id": "51",
      "ip": "0",
      "lastName": "",
      "links": {
        "bounceLogs": "/api/3/contacts/51/bounceLogs",
        "contactAutomations": "/api/3/contacts/51/contactAutomations",
        "contactData": "/api/3/contacts/51/contactData",
        "contactDeals": "/api/3/contacts/51/contactDeals",
        "contactGoals": "/api/3/contacts/51/contactGoals",
        "contactLists": "/api/3/contacts/51/contactLists",
        "contactLogs": "/api/3/contacts/51/contactLogs",
        "contactTags": "/api/3/contacts/51/contactTags",
        "deals": "/api/3/contacts/51/deals",
        "fieldValues": "/api/3/contacts/51/fieldValues",
        "geoIps": "/api/3/contacts/51/geoIps",
        "notes": "/api/3/contacts/51/notes",
        "organization": "/api/3/contacts/51/organization",
        "plusAppend": "/api/3/contacts/51/plusAppend",
        "scoreValues": "/api/3/contacts/51/scoreValues",
        "trackingLogs": "/api/3/contacts/51/trackingLogs"
      },
      "organization": null,
      "orgid": "0",
      "phone": "",
      "rating_tstamp": "0000-00-00",
      "segmentio_id": "",
      "sentcnt": "0",
      "socialdata_lastcheck": "0000-00-00 00:00:00",
      "ua": "",
      "udate": "2017-02-03T11:26:41-06:00"
    }
  ],
  "deal": {
    "cdate": "2017-03-31T11:28:26-05:00",
    "contact": "51",
    "currency": "usd",
    "group": "1",
    "hash": "acd136f3",
    "id": "7",
    "isDisabled": "",
    "links": {
      "dealActivities": "/api/3/deals/7/dealActivities",
      "contact": "/api/3/deals/7/contact",
      "contactDeals": "/api/3/deals/7/contactDeals",
      "group": "/api/3/deals/7/group",
      "nextTask": "/api/3/deals/7/nextTask",
      "notes": "/api/3/deals/7/notes",
      "organization": "/api/3/deals/7/organization",
      "owner": "/api/3/deals/7/owner",
      "scoreValues": "/api/3/deals/7/scoreValues",
      "stage": "/api/3/deals/7/stage",
      "tasks": "/api/3/deals/7/tasks"
    },
    "mdate": "2017-03-31T11:28:26-05:00",
    "nextTask": null,
    "organization": null,
    "owner": "1",
    "percent": null,
    "stage": "1",
    "status": 1,
    "title": "AC Deal",
    "value": 45600,
    "description": "This deal is an important deal"
  },
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-01-20T09:27:32-06:00",
      "color": "C481DF",
      "dealOrder": "next-action DESC",
      "group": "1",
      "id": "1",
      "links": {
        "group": "/api/3/dealStages/1/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": "2017-01-20T09:27:32-06:00",
      "width": "280"
    }
  ]
}

Body Params

deal
object

deal.description

deal.title
string
required

Deal's title.

deal.description
string

Deal's description

deal.contact
string
required

Deal's primary contact's id.

deal.value
int32
required

Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

deal.currency
string
required

Deal's currency in 3-digit ISO format, lowercased.

deal.group
string
required

Deal's pipeline id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.

deal.stage
string
required

Deal's stage id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.

deal.owner
string
required

Deal's owner id. Required if pipeline's auto-assign option is disabled.

deal.percent
int32

Deal's percentage.

deal.status
int32

Deal's status. See available values.

 

To create a deal, following permissions are required.

  • Deal permission: the user should have a permission to manage deals.
  • Pipeline-specific permission: the user should have a permission to manage the pipeline a new deal belongs to.

By default, primary contact and deal stage are also returned in the response.

Retrieve a deal

Retrieve an existing deal

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/deals/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:///:account.api-us1.com/api/3/deals/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/deals/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "deal": {
    "hash": "b107ee7e",
    "owner": "1",
    "contact": "45",
    "organization": null,
    "group": "2",
    "stage": "3",
    "title": "Demo Requested",
    "description": "This is an important deal",
    "percent": "0",
    "cdate": "2017-01-31T08:23:52-06:00",
    "mdate": "2017-02-28T16:11:29-06:00",
    "nextdate": "2017-03-01T12:00:00-06:00",
    "value": "34500",
    "currency": "usd",
    "status": "0",
    "activitycount": "12",
    "nextdealid": "1",
    "edate": "0000-00-00 00:00:00",
    "nexttaskid": "10",
    "links": {
      "dealActivities": "/api/3/deals/2/dealActivities",
      "contact": "/api/3/deals/2/contact",
      "contactDeals": "/api/3/deals/2/contactDeals",
      "group": "/api/3/deals/2/group",
      "nextTask": "/api/3/deals/2/nextTask",
      "notes": "/api/3/deals/2/notes",
      "organization": "/api/3/deals/2/organization",
      "owner": "/api/3/deals/2/owner",
      "scoreValues": "/api/3/deals/2/scoreValues",
      "stage": "/api/3/deals/2/stage",
      "tasks": "/api/3/deals/2/tasks"
    },
    "id": "2",
    "nextTask": "10"
  }
}
{
  "deal": {
    "id": "2",
    "isDisabled": 1,
    "title": "Demo Requested"
  }
}

Path Params

id
int32
required

Deal's id

 

To retrieve a deal, 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 deal

Update an existing deal

 
puthttps://:account.api-us1.com/api/3/deals/id
{
  "deal": {
    "contact": "51",
    "description": "This deal is an important deal",
    "currency": "usd",
    "group": "1",
    "owner": "3",
    "percent": 0,
    "stage": "1",
    "status": 1,
    "title": "New Deal",
    "value": 10000
  }
}
A binary file was returned

You couldn't be authenticated

{
  "contacts": [
    {
      "adate": "2017-02-06 15:50:11",
      "bounced_date": "0000-00-00",
      "bounced_hard": "0",
      "bounced_soft": "0",
      "cdate": "2017-02-03T11:26:41-06:00",
      "deleted": "0",
      "edate": "0000-00-00 00:00:00",
      "email": "abc@acb.com",
      "email_domain": "",
      "email_local": "",
      "firstName": "",
      "gravatar": "1",
      "hash": "e1705a92f24edf5313ed21df44d6ff5f",
      "id": "51",
      "ip": "0",
      "lastName": "",
      "links": {
        "bounceLogs": "/api/3/contacts/51/bounceLogs",
        "contactAutomations": "/api/3/contacts/51/contactAutomations",
        "contactData": "/api/3/contacts/51/contactData",
        "contactDeals": "/api/3/contacts/51/contactDeals",
        "contactGoals": "/api/3/contacts/51/contactGoals",
        "contactLists": "/api/3/contacts/51/contactLists",
        "contactLogs": "/api/3/contacts/51/contactLogs",
        "contactTags": "/api/3/contacts/51/contactTags",
        "deals": "/api/3/contacts/51/deals",
        "fieldValues": "/api/3/contacts/51/fieldValues",
        "geoIps": "/api/3/contacts/51/geoIps",
        "notes": "/api/3/contacts/51/notes",
        "organization": "/api/3/contacts/51/organization",
        "plusAppend": "/api/3/contacts/51/plusAppend",
        "scoreValues": "/api/3/contacts/51/scoreValues",
        "trackingLogs": "/api/3/contacts/51/trackingLogs"
      },
      "organization": null,
      "orgid": "0",
      "phone": "",
      "rating_tstamp": "0000-00-00",
      "segmentio_id": "",
      "sentcnt": "0",
      "socialdata_lastcheck": "0000-00-00 00:00:00",
      "ua": "",
      "udate": "2017-02-03T11:26:41-06:00"
    }
  ],
  "deal": {
    "activitycount": "4",
    "cdate": "2017-03-31T11:28:26-05:00",
    "contact": "51",
    "currency": "usd",
    "edate": "0000-00-00 00:00:00",
    "group": "1",
    "hash": "acd136f3",
    "id": "7",
    "links": {
      "dealActivities": "/api/3/deals/7/dealActivities",
      "contact": "/api/3/deals/7/contact",
      "contactDeals": "/api/3/deals/7/contactDeals",
      "group": "/api/3/deals/7/group",
      "nextTask": "/api/3/deals/7/nextTask",
      "notes": "/api/3/deals/7/notes",
      "organization": "/api/3/deals/7/organization",
      "owner": "/api/3/deals/7/owner",
      "scoreValues": "/api/3/deals/7/scoreValues",
      "stage": "/api/3/deals/7/stage",
      "tasks": "/api/3/deals/7/tasks"
    },
    "mdate": "2017-03-31T11:52:02-05:00",
    "nextTask": null,
    "nextdealid": "6",
    "nexttaskid": "0",
    "organization": null,
    "owner": "3",
    "percent": 0,
    "stage": "1",
    "status": 1,
    "title": "New Deal",
    "value": 10000,
    "description": "This deal is an important deal"
  },
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-01-20T09:27:32-06:00",
      "color": "C481DF",
      "dealOrder": "next-action DESC",
      "group": "1",
      "id": "1",
      "links": {
        "group": "/api/3/dealStages/1/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": "2017-01-20T09:27:32-06:00",
      "width": "280"
    }
  ]
}

Path Params

id
int32
required

Deal's id

Body Params

deal
object

deal.description

deal.title
string

Deal's title.

deal.description
string

Deal's description

deal.contact
string

Deal's primary contact id.

deal.value
int32

Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

deal.currency
string

Deal's currency in 3-digit ISO format, lowercased.

deal.group
string

Deal's pipeline id. Deal's stage or deal.stage should belong to deal.group.

deal.stage
string

Deal's stage id. deal.stage should belong to Deal's pipeline or deal.group.

deal.owner
string

Deal's owner id.

deal.percent
int32

Deal's percentage.

deal.status
int32

Deal's status. See available values.

 

To update a deal, following permissions are required.

  • Deal permission: the user should have a permission to manage deals.
  • Pipeline-specific permission: the user should have a permission to manage the pipeline the updating deal belongs to.
  • Deal reassign permission: if assigning the deal to another user, this permission is required.

By default, the deal stage is also returned in the response. If deal.contact was provided in the request, the primary contact is also returned in the response.

Delete a deal

Delete an existing deal

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/deals/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:///:account.api-us1.com/api/3/deals/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/deals/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

Deal's id

 

To delete a deal, the following permissions are required:

  • Deal permission: the user should have permission to manage deals.
  • Deal delete permission: the user should have permission to delete deals.

List all deals

Retrieve all existing deals

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/deals")

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:///:account.api-us1.com/api/3/deals");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/deals"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "deals": [
    {
      "activitycount": "4",
      "cdate": "2017-02-06T12:25:20-06:00",
      "contact": "51",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "4a5ba52d",
      "id": "3",
      "links": {
        "dealActivities": "/api/3/deals/3/dealActivities",
        "contact": "/api/3/deals/3/contact",
        "contactDeals": "/api/3/deals/3/contactDeals",
        "group": "/api/3/deals/3/group",
        "nextTask": "/api/3/deals/3/nextTask",
        "notes": "/api/3/deals/3/notes",
        "organization": "/api/3/deals/3/organization",
        "owner": "/api/3/deals/3/owner",
        "scoreValues": "/api/3/deals/3/scoreValues",
        "stage": "/api/3/deals/3/stage",
        "tasks": "/api/3/deals/3/tasks"
      },
      "mdate": "2017-03-01T09:15:53-06:00",
      "nextTask": "3",
      "nextdate": "2017-02-06T12:00:00-06:00",
      "nextdealid": "3",
      "nexttaskid": "3",
      "organization": null,
      "owner": "3",
      "percent": "0",
      "stage": "1",
      "status": "0",
      "title": "New Deal",
      "description": "This is an important deal",
      "value": "10000"
    },
    {
      "activitycount": "62",
      "cdate": "2017-01-20T09:28:02-06:00",
      "contact": "44",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "2",
      "hash": "d6ca7d0b",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-02-06T12:21:12-06:00",
      "nextTask": "2",
      "nextdate": "2017-02-06T12:00:00-06:00",
      "nextdealid": "1",
      "nexttaskid": "2",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "1",
      "title": "Test Deal",
      "description": "A deal that will make a big difference",
      "value": "10000"
    },
    {
        "id": "2",
        "isDisabled": 1,
        "title": "Demo Requested"
    }
  ],
  "meta": {
    "currencies": {
      "USD": {
        "currency": "USD",
        "total": "3",
        "value": "30000"
      }
    },
    "total": 3
  }
}

Query Params

filters[search]
string

Search text to use with search_field parameter.

filters[search_field]
string

Field to search for. See available values.

filters[title]
string

Filter by deal's title

filters[stage]
int32

Filter by deal's stage

filters[group]
int32

Filter by deal's pipeline

filters[status]
int32

Filter by deal's status. See available values.

filters[owner]
int32

Filter by deal's owner

filters[nextdate_range]
string

Filter by deal's tasks due dates. See available values.

filters[tag]
string

Filter by tag names associated with deal's primary contact. See available values.

filters[tasktype]
string

Filter by deals that have tasks with given type

filters[created_before]
date

Returns deals that are created less than given date

filters[created_after]
date

Returns deals that are created greater than or equal to given date

filters[updated_before]
date

Returns deals that are updated less than given date

filters[updated_after]
date

Returns deals that are updated greater than or equal to given date

filters[organization]
int32

Filter by deal's primary contact's organization's id

filters[minimum_value]
int32

In USD with dollar portion. Returns deals whose values are greater than or equal to given value

filters[maximum_value]
int32

In USD with dollar portion. Returns deals whose values are less than or equal to given value

filters[score_greater_than]
string

In a format of <score_id>:<score_value>. Returns deals whose score value is greater than given value

filters[score_less_than]
string

In a format of <score_id>:<score_value>. Returns deals whose score value is less than given value

filters[score]
string

In a format of <score_id>:<score_value>. Returns deals whose score value is equal to given value

orders[title]
string

Order by deal's title.

orders[value]
string

Order by deal's value.

orders[cdate]
string

Order by deal's created date.

orders[contact_name]
string

Order by deal's primary contact's first name.

orders[contact_orgname]
string

Order by deal's primary contact's organization name.

orders[next-action]
string

Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id.

 

To list all deals, 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 deals belong 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. If the response contains both permitted pipeline deals and non-permitted pipeline deals, full deal data are returned for deals belonging to permitted pipelines and limited data for deals belonging to non-permitted pipelines.

Create a deal note

Create a new note for a deal

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

You couldn't be authenticated

{
  "deals": [
    {
      "activitycount": "2",
      "cdate": "2017-05-25T12:01:01-05:00",
      "contact": "1",
      "currency": "usd",
      "edate": null,
      "group": "1",
      "hash": "e42436fc",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-05-25T12:17:23-05:00",
      "nextdate": null,
      "nextdealid": "1",
      "nexttaskid": null,
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "1",
      "status": "0",
      "title": "New Deal",
      "value": "10000"
    }
  ],
  "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 deal",
    "owner": {
      "id": "1",
      "type": "deal"
    },
    "relid": "1",
    "reltype": "Deal",
    "user": "1",
    "userid": "1"
  }
}

Path Params

id
string
required

Deal's id to assign new note to

Body Params

note
object
note.note
string
required

Deal note's content

 

To create a deal note, following permissions are required.

  • Deal permission: the user should have a permission to manage deals.
  • Pipeline-specific permission: the user should have a permission to manage the pipeline the deal belongs to.

Update a deal note

Update an existing note for a deal

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

You couldn't be authenticated

{
  "deals": [
    {
      "activitycount": "3",
      "cdate": "2017-06-01T13:40:04-05:00",
      "contact": "1",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "5604d5b5",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-06-01T13:41:57-05:00",
      "nextTask": "1",
      "nextdate": "2017-06-02T12:00:00-05:00",
      "nextdealid": "1",
      "nexttaskid": "1",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "1",
      "status": "0",
      "title": "New deal",
      "value": "10000"
    }
  ],
  "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": "deal"
    },
    "relid": "1",
    "reltype": "Deal",
    "user": "1",
    "userid": "1"
  }
}

Path Params

id
string
required

Deal's id to assign new note to

noteid
string
required

Deal note's id to update

Body Params

note
object
note.note
string
required

Deal note's content

 

To update a deal note, following permissions are required.

  • Deal permission: the user should have a permission to manage deals.
  • Pipeline-specific permission: the user should have a permission to manage the pipeline the deal belongs to.

Pipelines

A pipeline is a group of stages. A newly created pipeline comes with 3 default stages and no deals.

 

Deal Group is an alias of Pipeline. DealGroup is used in the request and response of pipeline API requests.

Create a pipeline

Create a new pipeline

 
posthttps://:account.api-us1.com/api/3/dealGroups
{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "currency": "eur",
    "title": "Qualifications",
    "users": ["3", "4"]
  }
}
A binary file was returned

You couldn't be authenticated

{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "cdate": "2017-03-30T12:12:41-05:00",
    "currency": "eur",
    "dealGroupGroups": [],
    "dealGroupUsers": [
      "6",
      "7"
    ],
    "id": "5",
    "links": {
      "dealGroupGroups": "/api/3/dealGroups/5/dealGroupGroups",
      "dealGroupUsers": "/api/3/dealGroups/5/dealGroupUsers",
      "stages": "/api/3/dealGroups/5/stages"
    },
    "stages": [
      "12",
      "13",
      "14"
    ],
    "title": "Qualifications",
    "udate": "2017-03-30T12:12:41-05:00"
  },
  "dealGroupGroups": [],
  "dealGroupUsers": [
    {
      "cdate": null,
      "dealGroup": "5",
      "id": "6",
      "links": {
        "dealGroup": "/api/3/dealGroupUsers/6/dealGroup",
        "user": "/api/3/dealGroupUsers/6/user"
      },
      "user": "3"
    },
    {
      "cdate": null,
      "dealGroup": "5",
      "id": "7",
      "links": {
        "dealGroup": "/api/3/dealGroupUsers/7/dealGroup",
        "user": "/api/3/dealGroupUsers/7/user"
      },
      "user": "4"
    }
  ],
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "18D499",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "12",
      "links": {
        "group": "/api/3/dealStages/12/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "13",
      "links": {
        "group": "/api/3/dealStages/13/group"
      },
      "order": "2",
      "title": "In Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "E6CE4B",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "14",
      "links": {
        "group": "/api/3/dealStages/14/group"
      },
      "order": "3",
      "title": "Follow Up",
      "udate": null,
      "width": "280"
    }
  ]
}

Body Params

dealGroup
object
dealGroup.title
string
required

Pipeline's title.

dealGroup.currency
string
required

Default currency to assign to new deals that belong to this deal group.

dealGroup.allgroups
int32

Whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.

dealGroup.allusers
int32

Whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.

dealGroup.autoassign
int32

Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.

dealGroup.users
array of strings

List of user ids to auto-assign new deals to unless auto-assign option is disabled.

dealGroup.groups
array of strings

List of user group ids to allow managing this pipeline.

 

Creating a new pipeline will also create three default deal stages named "To Contact", "In Contact", and "Follow Up".
By providing user ids with dealGroup.users and enabling the auto-assign option with dealGroup.autoassign: 1, a new pipeline can control how new deals are assigned to the owners.
By providing user group ids with dealGroup.groups, a new pipeline can control which user groups are allowed to manage the pipeline.

Retrieve a pipeline

Retrieve an existing pipeline

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/pipelines/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:///:account.api-us1.com/api/3/pipelines/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/pipelines/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "dealGroup": {
    "allgroups": "1",
    "allusers": "0",
    "autoassign": "1",
    "cdate": "2017-03-30T12:11:30-05:00",
    "currency": "eur",
    "id": "4",
    "links": {
      "dealGroupGroups": "/api/3/dealGroups/4/dealGroupGroups",
      "dealGroupUsers": "/api/3/dealGroups/4/dealGroupUsers",
      "stages": "/api/3/dealGroups/4/stages"
    },
    "stages": [
      "9",
      "10",
      "11"
    ],
    "title": "Qualifications",
    "udate": "2017-03-30T13:44:32-05:00"
  },
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "18D499",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "9",
      "links": {
        "group": "/api/3/dealStages/9/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "10",
      "links": {
        "group": "/api/3/dealStages/10/group"
      },
      "order": "2",
      "title": "In Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "E6CE4B",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "11",
      "links": {
        "group": "/api/3/dealStages/11/group"
      },
      "order": "3",
      "title": "Follow Up",
      "udate": null,
      "width": "280"
    }
  ]
}

Path Params

id
string
required

Pipeline's id

 

By default, deal stages for the pipeline are also returned in the response.

Update a pipeline

Update an existing pipeline

 
puthttps://:account.api-us1.com/api/3/dealGroups/id
{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "currency": "eur",
    "title": "Qualifications",
    "users": ["3"],
    "groups": []
  }
}
A binary file was returned

You couldn't be authenticated

{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "cdate": "2017-03-30T12:11:30-05:00",
    "currency": "eur",
    "dealGroupGroups": [],
    "dealGroupUsers": [
      "4"
    ],
    "id": "4",
    "links": {
      "dealGroupGroups": "/api/3/dealGroups/4/dealGroupGroups",
      "dealGroupUsers": "/api/3/dealGroups/4/dealGroupUsers",
      "stages": "/api/3/dealGroups/4/stages"
    },
    "title": "Qualifications",
    "udate": "2017-03-30T13:44:32-05:00"
  },
  "dealGroupGroups": [],
  "dealGroupUsers": [
    {
      "cdate": null,
      "dealGroup": "4",
      "id": "4",
      "links": {
        "dealGroup": "/api/3/dealGroupUsers/4/dealGroup",
        "user": "/api/3/dealGroupUsers/4/user"
      },
      "user": "3"
    }
  ]
}

Path Params

id
int32
required

Pipeline's id

Body Params

dealGroup
object
dealGroup.title
string

Pipeline's title

dealGroup.currency
string

Default currency to assign to new deals that belong to this deal group.

dealGroup.allgroups
int32

Whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.

dealGroup.allusers
int32

Whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.

dealGroup.autoassign
int32

Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.

dealGroup.users
array of strings

List of user ids to auto-assign new deals to unless auto-assign option is disabled.

dealGroup.groups
array of strings

List of user group ids to allow managing this pipeline.

 

By providing user ids with dealGroup.users and enabling the auto-assign option with dealGroup.autoassign: 1, the pipeline can control how new deals are assigned to the owners.
By providing user group ids with dealGroup.groups, the pipeline can control which user groups are allowed to manage the pipeline.

Delete a pipeline

Delete an existing pipeline

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/dealGroups/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:///:account.api-us1.com/api/3/dealGroups/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/dealGroups/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "message": "Unable to delete dealGroup. You have deals belonging to dealGroup."
}
{
  "message": "Unable to delete dealGroup. You have stages belonging to dealGroup."
}

Path Params

id
int32
required

Pipeline's id

 

To delete a pipeline, 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.
  • Pipeline delete permission: the user should have permission to delete a pipeline.

If trying to delete a pipeline that still has existing deals and stages associated with it, the DELETE request is rejected and an error message is returned in the response.

List all pipelines

Retrieve all existing pipelines

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/dealGroups")

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:///:account.api-us1.com/api/3/dealGroups");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/dealGroups"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "dealGroups": [
    {
      "allgroups": "1",
      "allusers": "1",
      "autoassign": "1",
      "cdate": "2017-01-16T14:51:57-06:00",
      "currency": "usd",
      "id": "1",
      "links": {
        "dealGroupGroups": "/api/3/dealGroups/1/dealGroupGroups",
        "dealGroupUsers": "/api/3/dealGroups/1/dealGroupUsers",
        "stages": "/api/3/dealGroups/1/stages"
      },
      "stages": [
        "1",
        "2"
      ],
      "title": "Pipeline A",
      "udate": "2017-03-01T11:06:32-06:00"
    },
    {
      "allgroups": "1",
      "allusers": "1",
      "autoassign": "0",
      "cdate": "2017-03-01T14:45:16-06:00",
      "currency": "usd",
      "id": "5",
      "links": {
        "dealGroupGroups": "/api/3/dealGroups/5/dealGroupGroups",
        "dealGroupUsers": "/api/3/dealGroups/5/dealGroupUsers",
        "stages": "/api/3/dealGroups/5/stages"
      },
      "stages": [
        "12",
        "13",
        "14"
      ],
      "title": "Pipeline Yesterday",
      "udate": "2017-03-01T15:07:18-06:00"
    }
  ],
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-01-20T09:27:32-06:00",
      "color": "C481DF",
      "dealOrder": "next-action DESC",
      "group": "1",
      "id": "1",
      "links": {
        "group": "/api/3/dealStages/1/group"
      },
      "order": "1",
      "title": "Stage 1",
      "udate": "2017-03-01T11:06:14-06:00",
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-01-20T09:27:34-06:00",
      "color": "00ECC5",
      "dealOrder": "next-action DESC",
      "group": "1",
      "id": "2",
      "links": {
        "group": "/api/3/dealStages/2/group"
      },
      "order": "2",
      "title": "Stage 2",
      "udate": "2017-03-01T11:06:20-06:00",
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "18D499",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "12",
      "links": {
        "group": "/api/3/dealStages/12/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "13",
      "links": {
        "group": "/api/3/dealStages/13/group"
      },
      "order": "2",
      "title": "In Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "E6CE4B",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "14",
      "links": {
        "group": "/api/3/dealStages/14/group"
      },
      "order": "3",
      "title": "Follow Up",
      "udate": null,
      "width": "280"
    }
  ],
  "meta": {
    "total": "2"
  }
}

Query Params

filters[title]
string

Filter by pipeline's title. The filter matches any pipeline titles that contain the provided title (i.e. "Contact" matches all of "In Contact", "To Contact", and "Contact Pipeline").

filters[have_stages]
int32

Filter by whether pipelines have deal stages. Can be either 1 or 0. If 1, only pipelines with at least one stage will be returned.

orders[title]
string

Order by Pipeline's title

orders[popular]
string

Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines' created dates are used to determine the order.

 

By default, deal stages for the pipelines are also returned in the response.

Stages

Stages are a way to group deals within a pipeline. A pipeline can have any number of stages within it and each stage can have any number of deals within it.

 

Deal stage parameters available values

For following parameters:

  • dealStage.cardRegion1
  • dealStage.cardRegion2
  • dealStage.cardRegion4
  • dealStage.cardRegion5

Use following values:

Parameter value
Meaning

contact-fullname

Deal's primary contact's full name

contact-fullname-orgname

Deal's primary contact's full name and organization name

contact-orgname

Deal's primary contact's organization name

next-action

Deal's next task due date

title

Deal's title

value

Deal's value

hide

Do not show anything

For following parameters:

  • dealStage.dealOrder

Use following values:

Parameter value
Meaning

cdate

Deal's created date

contact-score

Deal's primary contact's score value

contact_name

Deal's primary contact's name

contact_orgname

Deal's primary contact's organization name

next-action

If the direction is "ASC", deals with overdue tasks will be displayed the first, deals with no tasks will be displayed the second, and deals with upcoming tasks will be displayed the last. If the direction is "DESC", this order will be reversed.

score

Deal's score

title

Deal's title

value

Deal's value

Create a stage

Create a new stage for a pipeline

 
posthttps://:account.api-us1.com/api/3/dealStages
{
  "dealStage": {
    "cardRegion1": "title",
    "cardRegion2": "next-action",
    "cardRegion3": "show-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "color": "32B0FC",
    "dealOrder": "next-action DESC",
    "group": "4",
    "order": 1,
    "title": "Initial Contact",
    "width": 360
  }
}
A binary file was returned

You couldn't be authenticated

{
  "dealStage": {
    "cardRegion1": "title",
    "cardRegion2": "next-action",
    "cardRegion3": "show-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "cdate": "2017-03-01T15:55:58-06:00",
    "color": "32B0FC",
    "dealOrder": "next-action DESC",
    "group": "4",
    "id": "16",
    "links": {
      "group": "/api/3/dealStages/16/group"
    },
    "order": 1,
    "title": "Initial Contact",
    "udate": "2017-03-01T15:55:58-06:00",
    "width": 280
  }
}

Query Params

reorder
int32

Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order

Body Params

dealStage
object
dealStage.title
string
required

Deal stage's title

dealStage.group
string
required

Deal stage's pipeline id

dealStage.order
int32

Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same. If dealStage.order is not provided, the order is assigned with (the highest order of deal stages within the same pipeline) + 1

dealStage.dealOrder
string

Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either "ASC" or "DESC". See available options

dealStage.cardRegion1
string

What to show in upper-left corner of Deal Cards. See available values

dealStage.cardRegion2
string

What to show in upper-right corner of Deal Cards. See available values

dealStage.cardRegion3
string

Whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars

dealStage.cardRegion4
string

What to show next to the avatar in Deal Cards. See available values

dealStage.cardRegion5
string

What to show in lower-right corner of Deal Cards. See available values

dealStage.color
string

Deal Stage's color. 6-character HEX color code without the hashtag. e.g. "434343" to assign the hex color value "#434343"

dealStage.width
int32

Deal stage's width in pixels, without px unit

 

To create a deal stage, the following permissions are required.

  • Deal permission: the user should have permission to manage deals.
  • Edit Pipeline permission: the user should have permission to edit pipelines.
  • Pipeline-specific permission: the user should have permission to manage the pipeline that the stage belongs to.

Retrieve a stage

Retrieve an existing stage

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/dealStages/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:///:account.api-us1.com/api/3/dealStages/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/dealStages/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "dealStage": {
    "cardRegion1": "title",
    "cardRegion2": "next-action",
    "cardRegion3": "show-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "cdate": "2017-01-20T09:27:32-06:00",
    "color": "C481DF",
    "dealOrder": "score DESC",
    "group": "1",
    "id": "1",
    "links": {
      "group": "/api/3/dealStages/1/group"
    },
    "order": "1",
    "title": "Stage 1",
    "udate": "2017-03-02T11:41:01-06:00",
    "width": "280"
  }
}

Path Params

id
int32
required

Deal stage's id

 

To retrieve a deal stage, 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 stage belongs to.

Update a stage

Update an existing stage

 
puthttps://:account.api-us1.com/api/3/dealStages/id
{
  "dealStage": {
    "cardRegion1": "contact-orgname",
    "cardRegion2": "next-action",
    "cardRegion3": "hide-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "color": "696969",
    "dealOrder": "title ASC",
    "group": "4",
    "order": 1,
    "title": "Qualifications - Low",
    "width": 270
  }
}
A binary file was returned

You couldn't be authenticated

{
  "dealStage": {
    "cardRegion1": "contact-orgname",
    "cardRegion2": "next-action",
    "cardRegion3": "hide-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "cdate": "2017-03-01T15:55:58-06:00",
    "color": "696969",
    "dealOrder": "title ASC",
    "group": "4",
    "id": "16",
    "links": {
      "group": "/api/3/dealStages/16/group"
    },
    "order": 1,
    "title": "Qualifications - Low",
    "udate": "2017-03-01T16:03:57-06:00",
    "width": 270
  }
}

Path Params

id
int32
required

Deal stage's id

Query Params

reorder
int32

Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order

Body Params

dealStage
object
dealStage.title
string

Deal stage's title

dealStage.group
string

Deal stage's pipeline id

dealStage.order
int32

Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same

dealStage.dealOrder
string

Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either "ASC" or "DESC". See available options

dealStage.cardRegion1
string

What to show in upper-left corner of Deal Cards. See available values

dealStage.cardRegion2
string

What to show in upper-right corner of Deal Cards. See available values

dealStage.cardRegion3
string

Whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars

dealStage.cardRegion4
string

What to show next to the avatar in Deal Cards. See available values

dealStage.cardRegion5
string

What to show in lower-right corner of Deal Cards. See available values

dealStage.color
string

Deal Stage's color. 6-character HEX color code without the hashtag. e.g. "434343" to assign the hex color value "#434343"

dealStage.width
int32

Deal stage's width in pixels, without px unit

 

To update a deal stage, the following permissions are required.

  • Deal permission: the user should have permission to manage deals.
  • Edit Pipeline permission: the user should have permission to edit pipelines.
  • Pipeline-specific permission: the user should have permission to manage the pipeline that the stage belongs to.

Delete a stage

Delete an existing stage

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/dealStages/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:///:account.api-us1.com/api/3/dealStages/id");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/dealStages/id"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "status": 409,
      "title": "Conflict",
      "detail": "The stage has existing deals. Please delete or move existing deals and try again."
    }
  ]
}

Path Params

id
int32
required

Deal stage's id

 

To delete a deal stage, the following permissions are required.

  • Deal permission: the user should have permission to manage deals.
  • Edit Pipeline permission: the user should have permission to edit pipelines.
  • Pipeline-specific permission: the user should have permission to manage the pipeline that the stage belongs to.

If the deal stage has existing deals, the request will be rejected with a HTTP response code 409. Before this deal stage can be deleted, all deals under this deal stage must be either moved to another deal stage or deleted. To move deals under the deal stage to another deal stage, please see Move deals to another deal stage.

List all stages

Retrieve all existing stages

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

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

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

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

url = URI("https:///:account.api-us1.com/api/3/dealStages")

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:///:account.api-us1.com/api/3/dealStages");

xhr.send(data);
import requests

url = "https:///:account.api-us1.com/api/3/dealStages"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-03-01T15:52:42-06:00",
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "15",
      "links": {
        "group": "/api/3/dealStages/15/group"
      },
      "order": "1",
      "title": "Initial Contact",
      "udate": "2017-03-01T15:52:42-06:00",
      "width": "280"
    },
    {
      "cardRegion1": "contact-orgname",
      "cardRegion2": "next-action",
      "cardRegion3": "hide-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-03-01T15:55:58-06:00",
      "color": "696969",
      "dealOrder": "title ASC",
      "group": "4",
      "id": "16",
      "links": {
        "group": "/api/3/dealStages/16/group"
      },
      "order": "1",
      "title": "Qualifications - Low",
      "udate": "2017-03-01T16:03:57-06:00",
      "width": "270"
    }
  ],
  "meta": {
    "total": "2"
  }
}

Query Params

filters[title]
string

Filter by deal stages' titles. Any stages whose titles partial-match the filter value are returned

filters[d_groupid]
string

Filter by pipeline's id

orders[title]
string

Order by deal stage's title

 

To list all deal stages, 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 pipelines that the stages belong to. Stages that belong to pipelines that the user doesn't have permission to manage will not be returned in the response.

Move deals to another stage

Move all deals in one stage to another stage

 
puthttps://:account.api-us1.com/api/3/dealStages/id/deals
{
  "deal": {
    "stage": "3"
  }
}
A binary file was returned

You couldn't be authenticated

{
  "deals": [
    {
      "activitycount": "1",
      "cdate": "2017-05-19T16:21:47-05:00",
      "contact": "1",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "6faccb2d",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-05-19T16:21:47-05:00",
      "nextTask": null,
      "nextdealid": "2",
      "nexttaskid": "0",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "0",
      "title": "Another Deal",
      "value": "10000"
    },
    {
      "activitycount": "1",
      "cdate": "2017-05-19T16:23:01-05:00",
      "contact": "2",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "fe7cc4f3",
      "id": "2",
      "links": {
        "dealActivities": "/api/3/deals/2/dealActivities",
        "contact": "/api/3/deals/2/contact",
        "contactDeals": "/api/3/deals/2/contactDeals",
        "group": "/api/3/deals/2/group",
        "nextTask": "/api/3/deals/2/nextTask",
        "notes": "/api/3/deals/2/notes",
        "organization": "/api/3/deals/2/organization",
        "owner": "/api/3/deals/2/owner",
        "scoreValues": "/api/3/deals/2/scoreValues",
        "stage": "/api/3/deals/2/stage",
        "tasks": "/api/3/deals/2/tasks"
      },
      "mdate": "2017-05-19T16:23:01-05:00",
      "nextTask": null,
      "nextdealid": "1",
      "nexttaskid": "0",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "0",
      "title": "Urgent Deal",
      "value": "10000"
    }
  ]
}
{
  "errors": [
    {
      "detail": "Target stage does not belong to same pipeline",
      "source": {
        "pointer": "/data/attributes/stage"
      },
      "status": 422,
      "title": "Invalid attribute"
    }
  ]
}

Path Params

id
int32
required

Deal stage's id whose deals are to be moved to another deal stage

Body Params

deal