Skip to main content
Server path: /activecampaign | Type: Application | PCID required: Yes

Tools

ToolDescription
activecampaign_add_contact_to_automationAdd a contact to an automation
activecampaign_add_contact_to_listAdd or update contact list subscription
activecampaign_add_tag_to_contactAdd a tag to a contact
activecampaign_create_contact_custom_fieldCreate a contact custom field
activecampaign_create_contact_field_relationshipLink custom field to lists
activecampaign_create_contact_field_valueCreate a contact field value
activecampaign_create_contact_tagCreate a tag
activecampaign_create_dealCreate a deal
activecampaign_create_deal_noteCreate a deal note
activecampaign_create_deal_pipelineCreate a deal pipeline
activecampaign_create_field_optionsCreate field options
activecampaign_create_listCreate a list
activecampaign_create_list_group_permissionCreate list group permission
activecampaign_create_or_update_contactCreate or update a contact
activecampaign_deal_owner_bulk_updateBulk update deal owners
activecampaign_get_campaignGet a campaign
activecampaign_get_campaign_linksGet campaign links
activecampaign_get_contactGet a contact
activecampaign_get_contact_automationGet a contact automation
activecampaign_get_contact_custom_fieldGet a contact custom field
activecampaign_get_contact_field_valueGet a contact field value
activecampaign_get_dealGet a deal
activecampaign_get_deal_pipelineGet a deal pipeline
activecampaign_get_listGet a list
activecampaign_get_tagGet a tag
activecampaign_list_automationsList automations
activecampaign_list_campaignsList campaigns
activecampaign_list_contact_automationsList a contact’s automations
activecampaign_list_contact_custom_fieldsList contact custom fields
activecampaign_list_contact_field_valuesList contact field values
activecampaign_list_contactsList, search, and filter contacts
activecampaign_list_deal_activitiesList deal activities
activecampaign_list_deal_pipelinesList deal pipelines
activecampaign_list_dealsList deals
activecampaign_list_email_activitiesList email activities
activecampaign_list_groupsList user groups
activecampaign_list_listsList contact lists
activecampaign_list_tagsList tags
activecampaign_remove_contact_from_automationRemove a contact from an automation
activecampaign_update_contact_field_valueUpdate a contact field value
activecampaign_update_dealUpdate a deal
activecampaign_update_deal_noteUpdate a deal note
activecampaign_update_deal_pipelineUpdate a deal pipeline
activecampaign_update_listUpdate a list

activecampaign_add_contact_to_automation

Add a contact to an automation Parameters:
ParameterTypeRequiredDefaultDescription
contactAutomationobjectYesContact Automation

activecampaign_add_contact_to_list

Add or update contact list subscription Parameters:
ParameterTypeRequiredDefaultDescription
contactListobjectYesContact List

activecampaign_add_tag_to_contact

Add a tag to a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactTagobjectYesContact Tag

activecampaign_create_contact_custom_field

Create a contact custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldobjectYesThe field value

activecampaign_create_contact_field_relationship

Link custom field to lists Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdintegerYesCustom field ID to link
fieldRelobjectYesField Rel

activecampaign_create_contact_field_value

Create a contact field value Parameters:
ParameterTypeRequiredDefaultDescription
fieldValueobjectYesField Value

activecampaign_create_contact_tag

Create a tag Parameters:
ParameterTypeRequiredDefaultDescription
tagobjectYesThe tag value

activecampaign_create_deal

Create a deal Parameters:
ParameterTypeRequiredDefaultDescription
dealobjectYesThe deal value

activecampaign_create_deal_note

Create a deal note Parameters:
ParameterTypeRequiredDefaultDescription
dealIdintegerYesDeal ID to add the note to
noteobjectYesThe note value

activecampaign_create_deal_pipeline

Create a deal pipeline Parameters:
ParameterTypeRequiredDefaultDescription
dealGroupobjectYesDeal Group

activecampaign_create_field_options

Create field options Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdintegerYesCustom field ID to add options to
fieldOptionsobject[]YesArray of field options to create

activecampaign_create_list

Create a list Parameters:
ParameterTypeRequiredDefaultDescription
listobjectYesThe list value

activecampaign_create_list_group_permission

Create list group permission Parameters:
ParameterTypeRequiredDefaultDescription
listIdintegerYesList ID to grant permission on
listGroupPermissionobjectYesList Group Permission

activecampaign_create_or_update_contact

Create or update a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactobjectYesThe contact value

activecampaign_deal_owner_bulk_update

Bulk update deal owners Parameters:
ParameterTypeRequiredDefaultDescription
dealIdsinteger[]YesArray of deal IDs to reassign
ownerintegerYesNew owner (user) ID to assign all specified deals to

activecampaign_get_campaign

Get a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID

Get campaign links Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID

activecampaign_get_contact

Get a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact ID

activecampaign_get_contact_automation

Get a contact automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact automation record ID

activecampaign_get_contact_custom_field

Get a contact custom field Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCustom field ID

activecampaign_get_contact_field_value

Get a contact field value Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesField value ID

activecampaign_get_deal

Get a deal Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesDeal ID

activecampaign_get_deal_pipeline

Get a deal pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesPipeline (deal group) ID

activecampaign_get_list

Get a list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesList ID

activecampaign_get_tag

Get a tag Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTag ID

activecampaign_list_automations

List automations Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of automations to return
offsetintegerNoNumber of automations to skip for pagination

activecampaign_list_campaigns

List campaigns Parameters:
ParameterTypeRequiredDefaultDescription
filtersStatusintegerNoFilter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled)
filtersTypestringNoFilter by campaign type (single, recurring, split, responder, reminder, special, activerss, text)
filtersAfterstringNoFilter campaigns sent after this date (YYYY-MM-DD format)
filtersBeforestringNoFilter campaigns sent before this date (YYYY-MM-DD format)
searchstringNoSearch campaigns by name
limitintegerNoMaximum number of campaigns to return
offsetintegerNoNumber of campaigns to skip for pagination

activecampaign_list_contact_automations

List a contact’s automations Parameters:
ParameterTypeRequiredDefaultDescription
contactIdintegerYesContact ID

activecampaign_list_contact_custom_fields

List contact custom fields Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of fields to return (default 100)
offsetintegerNoNumber of fields to skip for pagination

activecampaign_list_contact_field_values

List contact field values Parameters:
ParameterTypeRequiredDefaultDescription
filtersContactintegerNoFilter field values by contact ID
filtersFieldintegerNoFilter field values by custom field ID
limitintegerNoMaximum number of results to return
offsetintegerNoNumber of results to skip for pagination

activecampaign_list_contacts

List, search, and filter contacts Parameters:
ParameterTypeRequiredDefaultDescription
idsstringNoFilter contacts by ID. Can be repeated for multiple IDs (for example, ids[]=1&ids[]=2).
emailstringNoEmail address of the contact to retrieve
email_likestringNoFilter contacts that contain this value in the email address
excludeintegerNoExclude from the response the contact with the given ID
listidstringNoFilter contacts associated with the given list
segmentidstringNoReturn 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.
formidintegerNoFilter contacts associated with the given form
id_greaterintegerNoOnly include contacts with an ID greater than the given ID
id_lessintegerNoOnly include contacts with an ID less than the given ID
phonestringNoFilter contacts where the phone number starts with the given value
organizationintegerNo(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID
searchstringNoFilter contacts by name, organization, phone, or email
seriesidintegerNoFilter contacts associated with the given automation
statusintegerNoContact status filter. See ActiveCampaign contact parameter values.
tagidintegerNoFilter contacts associated with the given tag
waitidintegerNoFilter contacts in the wait queue of an automation block
in_group_listsstringNoSet to true to return only contacts the current user has permission to see
forceQuerynumberNoIf present and equal to 1, a new segment request is kicked off which will return an updated result set.
sortIdnumberNoIf sorting results by a score or custom field, this parameter holds the id of the score or custom field respectively
filtersCreatedBeforestringNoFilter contacts created prior to this date
filtersCreatedAfterstringNoFilter contacts created after this date
filtersUpdatedBeforestringNoFilter contacts updated before this date
filtersUpdatedAfterstringNoFilter contacts updated after this date
ordersIdstringNoOrder contacts by unique ID
ordersCdatestringNoOrder contacts by creation date
ordersEmailstringNoOrder contacts by email
ordersFirstNamestringNoOrder contacts by first name
ordersLastNamestringNoOrder contacts by last name
ordersNamestringNoOrder contacts by full name
ordersScorestringNoOrder contacts by score. Use together with sortId.
limitintegerNoMaximum number of contacts to return (default 20, max 100)
offsetintegerNoNumber of contacts to skip for pagination

activecampaign_list_deal_activities

List deal activities Parameters:
ParameterTypeRequiredDefaultDescription
filtersDealintegerNoFilter activities by deal ID
filtersOwnerintegerNoFilter activities by owner (user) ID
limitintegerNoMaximum number of activities to return
offsetintegerNoNumber of activities to skip for pagination

activecampaign_list_deal_pipelines

List deal pipelines Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of pipelines to return
offsetintegerNoNumber of pipelines to skip for pagination

activecampaign_list_deals

List deals Parameters:
ParameterTypeRequiredDefaultDescription
filtersSearchstringNoSearch text to use with filters[search_field].
filtersSearchFieldstringNoField to search by (see deal parameter available values in ActiveCampaign docs).
filtersTitlestringNoFilter by deal title
filtersStageintegerNoFilter by deal stage ID
filtersGroupintegerNoFilter by pipeline (deal group) ID
filtersStatusintegerNoFilter by deal status (see deal parameter available values in ActiveCampaign docs).
filtersOwnerintegerNoFilter by deal owner (user) ID
filtersNextdateRangestringNoFilter by deal task due dates (see available values in ActiveCampaign docs).
filtersTagstringNoFilter by tag names associated with the deal’s primary contact
filtersTasktypestringNoFilter deals that have tasks with the given type
filtersCreatedBeforestringNoReturn deals created before this date
filtersCreatedAfterstringNoReturn deals created on or after this date
filtersUpdatedBeforestringNoReturn deals updated before this date
filtersUpdatedAfterstringNoReturn deals updated on or after this date
filtersOrganizationintegerNoFilter by the primary contact’s organization ID
filtersMinimumValueintegerNoReturn deals whose value is greater than or equal to this USD amount
filtersMaximumValueintegerNoReturn deals whose value is less than or equal to this USD amount
filtersScoreGreaterThanstringNoScore filter in format <score_id>:<score_value>, greater-than comparison
filtersScoreLessThanstringNoScore filter in format <score_id>:<score_value>, less-than comparison
filtersScorestringNoScore filter in format <score_id>:<score_value>, exact match
ordersTitlestringNoOrder by deal title
ordersValuestringNoOrder by deal value
ordersCdatestringNoOrder by deal creation date
ordersContactNamestringNoOrder by primary contact first name
ordersContactOrgnamestringNoOrder by primary contact organization name
ordersNextActionstringNoOrder by next task due date, then deals with no task, then overdue tasks
limitintegerNoMaximum number of deals to return
offsetintegerNoNumber of deals to skip for pagination

activecampaign_list_email_activities

List email activities Parameters:
ParameterTypeRequiredDefaultDescription
filtersContactintegerNoFilter email activities by contact ID
filtersCampaignintegerNoFilter email activities by campaign ID
limitintegerNoMaximum number of activities to return
offsetintegerNoNumber of activities to skip for pagination

activecampaign_list_groups

List user groups Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of groups to return
offsetintegerNoNumber of groups to skip for pagination

activecampaign_list_lists

List contact lists Parameters:
ParameterTypeRequiredDefaultDescription
filtersNameContainsstringNoFilter lists whose name contains this string
limitintegerNoMaximum number of lists to return
offsetintegerNoNumber of lists to skip for pagination

activecampaign_list_tags

List tags Parameters:
ParameterTypeRequiredDefaultDescription
searchstringNoFilter tags by name (partial match)
limitintegerNoMaximum number of tags to return
offsetintegerNoNumber of tags to skip for pagination

activecampaign_remove_contact_from_automation

Remove a contact from an automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact automation record ID

activecampaign_update_contact_field_value

Update a contact field value Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesField value ID
fieldValueobjectYesField Value

activecampaign_update_deal

Update a deal Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesDeal ID
dealobjectYesThe deal value

activecampaign_update_deal_note

Update a deal note Parameters:
ParameterTypeRequiredDefaultDescription
dealIdintegerYesDeal ID the note belongs to
noteIdintegerYesNote ID to update
noteobjectYesThe note value

activecampaign_update_deal_pipeline

Update a deal pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesPipeline (deal group) ID
dealGroupobjectYesDeal Group

activecampaign_update_list

Update a list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesList ID
listobjectYesThe list value