/activecampaign | Type: Application | PCID required: Yes
Tools
activecampaign_add_contact_to_automation
Add a contact to an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactAutomation | object | Yes | — | Contact Automation |
activecampaign_add_contact_to_list
Add or update contact list subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactList | object | Yes | — | Contact List |
activecampaign_add_tag_to_contact
Add a tag to a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactTag | object | Yes | — | Contact Tag |
activecampaign_create_contact_custom_field
Create a contact custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field | object | Yes | — | The field value |
activecampaign_create_contact_field_relationship
Link custom field to lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | integer | Yes | — | Custom field ID to link |
fieldRel | object | Yes | — | Field Rel |
activecampaign_create_contact_field_value
Create a contact field value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldValue | object | Yes | — | Field Value |
activecampaign_create_contact_tag
Create a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | object | Yes | — | The tag value |
activecampaign_create_deal
Create a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deal | object | Yes | — | The deal value |
activecampaign_create_deal_note
Create a deal note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dealId | integer | Yes | — | Deal ID to add the note to |
note | object | Yes | — | The note value |
activecampaign_create_deal_pipeline
Create a deal pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dealGroup | object | Yes | — | Deal Group |
activecampaign_create_field_options
Create field options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | integer | Yes | — | Custom field ID to add options to |
fieldOptions | object[] | Yes | — | Array of field options to create |
activecampaign_create_list
Create a list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list | object | Yes | — | The list value |
activecampaign_create_list_group_permission
Create list group permission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
listId | integer | Yes | — | List ID to grant permission on |
listGroupPermission | object | Yes | — | List Group Permission |
activecampaign_create_or_update_contact
Create or update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact | object | Yes | — | The contact value |
activecampaign_deal_owner_bulk_update
Bulk update deal owners Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dealIds | integer[] | Yes | — | Array of deal IDs to reassign |
owner | integer | Yes | — | New owner (user) ID to assign all specified deals to |
activecampaign_get_campaign
Get a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
activecampaign_get_campaign_links
Get campaign links Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
activecampaign_get_contact
Get a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Contact ID |
activecampaign_get_contact_automation
Get a contact automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Contact automation record ID |
activecampaign_get_contact_custom_field
Get a contact custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Custom field ID |
activecampaign_get_contact_field_value
Get a contact field value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Field value ID |
activecampaign_get_deal
Get a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Deal ID |
activecampaign_get_deal_pipeline
Get a deal pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Pipeline (deal group) ID |
activecampaign_get_list
Get a list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | List ID |
activecampaign_get_tag
Get a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Tag ID |
activecampaign_list_automations
List automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of automations to return |
offset | integer | No | — | Number of automations to skip for pagination |
activecampaign_list_campaigns
List campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersStatus | integer | No | — | Filter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled) |
filtersType | string | No | — | Filter by campaign type (single, recurring, split, responder, reminder, special, activerss, text) |
filtersAfter | string | No | — | Filter campaigns sent after this date (YYYY-MM-DD format) |
filtersBefore | string | No | — | Filter campaigns sent before this date (YYYY-MM-DD format) |
search | string | No | — | Search campaigns by name |
limit | integer | No | — | Maximum number of campaigns to return |
offset | integer | No | — | Number of campaigns to skip for pagination |
activecampaign_list_contact_automations
List a contact’s automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | integer | Yes | — | Contact ID |
activecampaign_list_contact_custom_fields
List contact custom fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of fields to return (default 100) |
offset | integer | No | — | Number of fields to skip for pagination |
activecampaign_list_contact_field_values
List contact field values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersContact | integer | No | — | Filter field values by contact ID |
filtersField | integer | No | — | Filter field values by custom field ID |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | Number of results to skip for pagination |
activecampaign_list_contacts
List, search, and filter contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string | No | — | Filter contacts by ID. Can be repeated for multiple IDs (for example, ids[]=1&ids[]=2). |
email | string | No | — | Email address of the contact to retrieve |
email_like | string | No | — | Filter contacts that contain this value in the email address |
exclude | integer | No | — | Exclude from the response the contact with the given ID |
listid | string | No | — | Filter contacts associated with the given list |
segmentid | string | No | — | Return only contacts that match a list segment. The first API call within 1 hour or an API call with the param forceQuery=1 will kick off an new segment request. |
formid | integer | No | — | Filter contacts associated with the given form |
id_greater | integer | No | — | Only include contacts with an ID greater than the given ID |
id_less | integer | No | — | Only include contacts with an ID less than the given ID |
phone | string | No | — | Filter contacts where the phone number starts with the given value |
organization | integer | No | — | (Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID |
search | string | No | — | Filter contacts by name, organization, phone, or email |
seriesid | integer | No | — | Filter contacts associated with the given automation |
status | integer | No | — | Contact status filter. See ActiveCampaign contact parameter values. |
tagid | integer | No | — | Filter contacts associated with the given tag |
waitid | integer | No | — | Filter contacts in the wait queue of an automation block |
in_group_lists | string | No | — | Set to true to return only contacts the current user has permission to see |
forceQuery | number | No | — | If present and equal to 1, a new segment request is kicked off which will return an updated result set. |
sortId | number | No | — | If sorting results by a score or custom field, this parameter holds the id of the score or custom field respectively |
filtersCreatedBefore | string | No | — | Filter contacts created prior to this date |
filtersCreatedAfter | string | No | — | Filter contacts created after this date |
filtersUpdatedBefore | string | No | — | Filter contacts updated before this date |
filtersUpdatedAfter | string | No | — | Filter contacts updated after this date |
ordersId | string | No | — | Order contacts by unique ID |
ordersCdate | string | No | — | Order contacts by creation date |
ordersEmail | string | No | — | Order contacts by email |
ordersFirstName | string | No | — | Order contacts by first name |
ordersLastName | string | No | — | Order contacts by last name |
ordersName | string | No | — | Order contacts by full name |
ordersScore | string | No | — | Order contacts by score. Use together with sortId. |
limit | integer | No | — | Maximum number of contacts to return (default 20, max 100) |
offset | integer | No | — | Number of contacts to skip for pagination |
activecampaign_list_deal_activities
List deal activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersDeal | integer | No | — | Filter activities by deal ID |
filtersOwner | integer | No | — | Filter activities by owner (user) ID |
limit | integer | No | — | Maximum number of activities to return |
offset | integer | No | — | Number of activities to skip for pagination |
activecampaign_list_deal_pipelines
List deal pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of pipelines to return |
offset | integer | No | — | Number of pipelines to skip for pagination |
activecampaign_list_deals
List deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersSearch | string | No | — | Search text to use with filters[search_field]. |
filtersSearchField | string | No | — | Field to search by (see deal parameter available values in ActiveCampaign docs). |
filtersTitle | string | No | — | Filter by deal title |
filtersStage | integer | No | — | Filter by deal stage ID |
filtersGroup | integer | No | — | Filter by pipeline (deal group) ID |
filtersStatus | integer | No | — | Filter by deal status (see deal parameter available values in ActiveCampaign docs). |
filtersOwner | integer | No | — | Filter by deal owner (user) ID |
filtersNextdateRange | string | No | — | Filter by deal task due dates (see available values in ActiveCampaign docs). |
filtersTag | string | No | — | Filter by tag names associated with the deal’s primary contact |
filtersTasktype | string | No | — | Filter deals that have tasks with the given type |
filtersCreatedBefore | string | No | — | Return deals created before this date |
filtersCreatedAfter | string | No | — | Return deals created on or after this date |
filtersUpdatedBefore | string | No | — | Return deals updated before this date |
filtersUpdatedAfter | string | No | — | Return deals updated on or after this date |
filtersOrganization | integer | No | — | Filter by the primary contact’s organization ID |
filtersMinimumValue | integer | No | — | Return deals whose value is greater than or equal to this USD amount |
filtersMaximumValue | integer | No | — | Return deals whose value is less than or equal to this USD amount |
filtersScoreGreaterThan | string | No | — | Score filter in format <score_id>:<score_value>, greater-than comparison |
filtersScoreLessThan | string | No | — | Score filter in format <score_id>:<score_value>, less-than comparison |
filtersScore | string | No | — | Score filter in format <score_id>:<score_value>, exact match |
ordersTitle | string | No | — | Order by deal title |
ordersValue | string | No | — | Order by deal value |
ordersCdate | string | No | — | Order by deal creation date |
ordersContactName | string | No | — | Order by primary contact first name |
ordersContactOrgname | string | No | — | Order by primary contact organization name |
ordersNextAction | string | No | — | Order by next task due date, then deals with no task, then overdue tasks |
limit | integer | No | — | Maximum number of deals to return |
offset | integer | No | — | Number of deals to skip for pagination |
activecampaign_list_email_activities
List email activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersContact | integer | No | — | Filter email activities by contact ID |
filtersCampaign | integer | No | — | Filter email activities by campaign ID |
limit | integer | No | — | Maximum number of activities to return |
offset | integer | No | — | Number of activities to skip for pagination |
activecampaign_list_groups
List user groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of groups to return |
offset | integer | No | — | Number of groups to skip for pagination |
activecampaign_list_lists
List contact lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filtersNameContains | string | No | — | Filter lists whose name contains this string |
limit | integer | No | — | Maximum number of lists to return |
offset | integer | No | — | Number of lists to skip for pagination |
activecampaign_list_tags
List tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search | string | No | — | Filter tags by name (partial match) |
limit | integer | No | — | Maximum number of tags to return |
offset | integer | No | — | Number of tags to skip for pagination |
activecampaign_remove_contact_from_automation
Remove a contact from an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Contact automation record ID |
activecampaign_update_contact_field_value
Update a contact field value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Field value ID |
fieldValue | object | Yes | — | Field Value |
activecampaign_update_deal
Update a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Deal ID |
deal | object | Yes | — | The deal value |
activecampaign_update_deal_note
Update a deal note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dealId | integer | Yes | — | Deal ID the note belongs to |
noteId | integer | Yes | — | Note ID to update |
note | object | Yes | — | The note value |
activecampaign_update_deal_pipeline
Update a deal pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Pipeline (deal group) ID |
dealGroup | object | Yes | — | Deal Group |
activecampaign_update_list
Update a list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | List ID |
list | object | Yes | — | The list value |

