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

activecampaign_add_contact_to_list

Add or update contact list subscription Parameters:
ParameterTypeRequiredDefaultDescription
contactListobjectYescontactList

activecampaign_add_tag_to_contact

Add a tag to a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactTagobjectYescontactTag

activecampaign_create_contact_custom_field

Create a contact custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldobjectYesfield

activecampaign_create_contact_field_relationship

Link custom field to lists Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdintegerYesCustom field ID to link
fieldRelobjectYesfieldRel

activecampaign_create_contact_field_value

Create a contact field value Parameters:
ParameterTypeRequiredDefaultDescription
fieldValueobjectYesfieldValue

activecampaign_create_contact_tag

Create a tag Parameters:
ParameterTypeRequiredDefaultDescription
tagobjectYestag

activecampaign_create_deal

Create a deal Parameters:
ParameterTypeRequiredDefaultDescription
dealobjectYesdeal

activecampaign_create_deal_note

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

activecampaign_create_deal_pipeline

Create a deal pipeline Parameters:
ParameterTypeRequiredDefaultDescription
dealGroupobjectYesdealGroup

activecampaign_create_field_options

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

activecampaign_create_list

Create a list Parameters:
ParameterTypeRequiredDefaultDescription
listobjectYeslist

activecampaign_create_list_group_permission

Create list group permission Parameters:
ParameterTypeRequiredDefaultDescription
listIdintegerYesList ID to grant permission on
listGroupPermissionobjectYeslistGroupPermission

activecampaign_create_or_update_contact

Create or update a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactobjectYescontact

activecampaign_deal_owner_bulk_update

Bulk update deal owners Parameters:
ParameterTypeRequiredDefaultDescription
dealIdsany[]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 contacts Parameters:
ParameterTypeRequiredDefaultDescription
listidintegerNoFilter contacts by list ID
segmentidintegerNoFilter contacts by segment ID
tagidintegerNoFilter contacts by tag ID
formidintegerNoFilter contacts by form ID
statusintegerNoFilter by subscription status (1=active, 2=unsubscribed, 3=bounced, 0=any)
emailstringNoFilter by exact email address
searchstringNoSearch contacts by name, email, or organization
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
search_fieldstringNoField to search by (all, title, contact, org)
search_valuestringNoValue to search for in the selected search_field
statusintegerNoFilter by deal status (0=open, 1=won, 2=lost)
filtersStageintegerNoFilter by deal stage ID
filtersGroupintegerNoFilter by pipeline (deal group) ID
filtersOwnerintegerNoFilter by deal owner (user) ID
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
fieldValueobjectYesfieldValue

activecampaign_update_deal

Update a deal Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesDeal ID
dealobjectYesdeal

activecampaign_update_deal_note

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

activecampaign_update_deal_pipeline

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

activecampaign_update_list

Update a list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesList ID
listobjectYeslist