/automations
200
400
GET /automations
/brandings
List all existing branding resources
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| api_key | query | optional | string | ActiveCampaign API key |
200
400
GET /brandings
/calendars
200
GET /calendars
/campaigns
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| orders[sdate] | query | optional | string | Order campaigns by send date |
| orders[ldate] | query | optional | string | Order campaigns by last send date |
| filters[seriesid] | query | optional | integer | Filter to return the campaigns from the targeted automationId/seriesIds |
200
400
GET /campaigns
/connections
List all existing connection resources.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[service] | query | optional | string | Filter by the external service name. |
| filters[externalid] | query | optional | string | Filter by the external id associated with a connection. |
200
400
GET /connections
/contactAutomations
200
GET /contactAutomations
/contactLists
Subscribe a contact to a list or unsubscribe a contact from a list.
application/json
ListUpdateListStatusForContactRequest
200
400
POST /contactLists
/contacts
Use this API endpoint to list all contacts, search contacts, or filter contacts by many criteria. For example, search for specific contacts by email, list, account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ids | query | optional | string | Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42 |
| query | optional | string | Email address of the contact you want to get |
|
| email_like | query | optional | string | Filter contacts that contain the given value in the email address |
| exclude | query | optional | integer | Exclude from the response the contact with the given ID |
| formid | query | optional | integer | Filter contacts associated with the given form |
| id_greater | query | optional | integer | Only include contacts with an ID greater than the given ID |
| id_less | query | optional | integer | Only include contacts with an ID less than the given ID |
| listid | query | optional | string | Filter contacts associated with the given list |
| organization | query | optional | integer | (Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID |
| search | query | optional | string | Filter contacts that match the given value in the contact names, organization, phone or email |
| segmentid | query | optional | integer | Return only contacts that match a list segment (the first call kicks off an asynchronous query. When the query is complete, subsequent API calls will return contacts that match the segment - timeout 1hr) |
| seriesid | query | optional | integer | Filter contacts associated with the given automation |
| status | query | optional | integer | See available values |
| tagid | query | optional | integer | Filter contacts associated with the given tag |
| filters[created_before] | query | optional | string | Filter contacts that were created prior to this date |
| filters[created_after] | query | optional | string | Filter contacts that were created after this date |
| filters[updated_before] | query | optional | string | Filter contacts that were updated before this date |
| filters[updated_after] | query | optional | string | Filter contacts that were updated after this date |
| waitid | query | optional | integer | Filter by contacts in the wait queue of an automation block |
| orders[id] | query | optional | string | Order contacts by unique ID |
| orders[cdate] | query | optional | string | Order contacts by creation date |
| orders[email] | query | optional | string | Order contacts by email |
| orders[first_name] | query | optional | string | Order contacts by first name |
| orders[last_name] | query | optional | string | Order contacts by last name |
| orders[name] | query | optional | string | Order contacts by full name |
| orders[score] | query | optional | string | Order contacts by score |
| in_group_lists | query | optional | string | Set this to ”true” in order to return only contacts that the current user has permissions to see. |
200
400
GET /contacts
/contacts/{id}/contactAutomations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact to receive automations for |
200
404
GET /contacts/{id}/contactAutomations
/contacts/{id}/contactLists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact |
200
404
GET /contacts/{id}/contactLists
/contacts/{id}/geoIps
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact |
200
404
GET /contacts/{id}/geoIps
/customObjects/records/{schemaId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| schemaId | path | required | string | ID of schema |
| limit | query | optional | integer | The number of records to return for each call. Maximum value is 100. |
| offset | query | optional | integer | Offset index of records to return |
| filters | query | optional | array | Use ?filters[relationships.{your-contact-relationship}][eq]={contactId} to filter records to a specific contact. |
200
400
404
GET /customObjects/records/{schemaId}
/customObjects/schemas
Retrieve all schemas available within an account.
Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | The number of schemas to retrieve for each API call. Maximum value is 100. |
| offset | query | optional | integer | Offset index of items to return |
| orders | query | optional | array | Array of sorting criteria to fetch items |
| filters | query | optional | string | Filters schemas by different criteria |
| showFields | query | optional | string | Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default. |
200
400
GET /customObjects/schemas
/ecomCustomers
List all e-commerce customer resources.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[email] | query | optional | string | Filter by the email address of a customer. |
| filters[externalid] | query | optional | string | Filter by the id of the customer in the external service. |
| filters[connectionid] | query | optional | string | Filter by the id of the connection object for the service where the customer originates. |
200
GET /ecomCustomers
/ecomOrderProducts
200
400
GET /ecomOrderProducts
/ecomOrders
List all existing e-commerce order resources.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[connectionid] | query | optional | integer | Filter by the connection id. Must be greater than 0. |
| filters[externalid] | query | optional | integer | Filter by the external id of the order. |
| filters[externalcheckoutid] | query | optional | string | Filter by the external checkout id |
| filters[email] | query | optional | string | Filter by the customer email address. |
| filters[state] | query | optional | integer | Filter by the state of the order. 0 = Pending, 1 = Completed, 2 = Abandoned, 3 = Recovered, 4 = Waiting (Customer checked out but payment is not yet completed) |
| filters[customerid] | query | optional | string | Filter by the customer id |
| filters[external_created_date] | query | optional | string | Filter by the external created date |
| orders[connectionid] | query | optional | integer | Order by connection ID. Accepted values are ASC or DESC. |
| orders[externalid] | query | optional | integer | Order by external ID. Accepted values are ASC or DESC. |
| orders[externalcheckoutid] | query | optional | string | Order by external checkout ID. Accepted values are ASC or DESC. |
| orders[email] | query | optional | string | Order by email. Accepted values are ASC or DESC. |
| orders[state] | query | optional | integer | Order by state. Accepted values are ASC or DESC. |
| orders[customerid] | query | optional | string | Order by customer ID. Accepted values are ASC or DESC. |
| orders[external_created_date] | query | optional | string | Order by external created date. Accepted values are ASC or DESC. |
200
422
GET /ecomOrders
/ecomOrders/{id}/orderProducts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the order whose products you’d like returned. |
200
400
GET /ecomOrders/{id}/orderProducts
/emailActivities
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[subscriberid] | query | optional | integer | Set this parameter to return only email activities belonging to a given subscriber. |
| filters[dealId] | query | optional | integer | Set this parameter to return only email activities belonging to a given deal. |
200
400
GET /emailActivities
/eventTrackingEvents
List the names of tracked events
200
400
GET /eventTrackingEvents
/fieldRels
application/json
ListCreateFieldRelationshipToListsRequest
201
403
POST /fieldRels
/fieldRels/{fieldRelId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fieldRelId | path | required | integer | Field relationship ID to be deleted |
200
403
DELETE /fieldRels/{fieldRelId}
/fieldValues
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[fieldid] | query | optional | string | ID of the field the value belongs to. |
| filters[val] | query | optional | string | Value of the custom field for a specific contact |
200
400
GET /fieldValues
/groupLimits
200
GET /groupLimits
/groups
200
GET /groups
/import/bulk_import
200
GET /import/bulk_import
/listGroups
application/json
ListGroupPermissionCreateRequest
201
403
POST /listGroups
/lists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[name] | query | optional | string | Filter by the name of the list |
| limit | query | optional | integer | Limit the number of returned results |
| filters[name][<operator>] | query | optional | string | Filters lists by list name according to the operator specified. (See supported operators below) |
| orders[name] | query | optional | string | Orders filtered results by weight, ascending order, or descending order. If weight is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results. |
200
403
GET /lists
/lists
application/json
ListCreateNewListRequest
200
400
403
POST /lists
/lists/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the list to delete |
200
403
DELETE /lists/{id}
/lists/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | ID of the lists to retrieve |
200
403
404
GET /lists/{id}
/messages
200
400
GET /messages
/savedResponses
200
GET /savedResponses
/scores
200
GET /scores
/segments
200
400
GET /segments
/siteTrackingDomains
List of all whitelisted site tracking domains
200
GET /siteTrackingDomains
/siteTrackingDomains
Add a domain to the site tracking whitelist
application/json
ListWhitelistedDomainCreateRequest
200
400
POST /siteTrackingDomains
/siteTrackingDomains/{name}
Remove a domain from the site tracking whitelist
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| name | path | required | string | The domain name to remove from the whitelist |
204
DELETE /siteTrackingDomains/{name}
/taskOutcomes
Retrieve all existing task outcomes
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[sentiment] | query | optional | string | 1 is for Negative, 2 is for Neutral and 3 is for Positive |
200
400
GET /taskOutcomes
/tasktypeOutcomeRels
Retrieve all existing task type - outcome relations
200
400
GET /tasktypeOutcomeRels
/webhook/events
List all available webhook events
200
GET /webhook/events
/webhooks
List all existing webhooks
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[name] | query | optional | string | Filter by webhook name |
| filters[url] | query | optional | string | Filter by webhook url |
| filters[listid] | query | optional | string | Filter by webhook’s associated list |
200
400
GET /webhooks
/messages
application/json
MessageCreateNewMessageRequest
| Property | Type | Required |
|---|---|---|
| message | object | optional |
| string | required | |
| └ reply2 | string | required |
| └ subject | string | optional |
| └ fromname | string | required |
| └ preheader_text | string | optional |
201
400
POST /messages
/messages/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | ID of the message to delete |
200
400
DELETE /messages/{id}
/messages/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | ID of the message to retrieve |
200
404
GET /messages/{id}
/messages/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | ID of the message to update |
| message.fromname | header | optional | string | Name of sender |
| message.email | header | optional | string | Email of sender |
| message.reply2 | header | optional | string | Reply email for the recipient to reply to |
| message.subject | header | optional | string | Subject of message |
| message.preheader_text | header | optional | string | Preheader Text |
application/json
MessageUpdateByIdRequest
200
404
PUT /messages/{id}
/accounts/{id}/notes
Create a new note for an account
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Account’s id to assign new note to |
application/json
NoteCreateAccountNoteRequest
| Property | Type | Required |
|---|---|---|
| note | object | optional |
| └ note | string | required |
201
POST /accounts/{id}/notes
/accounts/{id}/notes/{noteid}
Update an existing note for a account
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Account’s id to assign new note to |
| noteid | path | required | string | Account note’s id to update |
application/json
NoteUpdateNoteRequest
| Property | Type | Required |
|---|---|---|
| note | object | optional |
| └ note | string | required |
200
PUT /accounts/{id}/notes/{noteid}
/contacts/{id}/notes
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact |
200
404
GET /contacts/{id}/notes
/notes
200
GET /notes
/notes
application/json
NoteCreateNewRequest
201
400
POST /notes