Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /activecampaign | Type: Application | PCID required: Yes
Add a contact to an automation
Parameters:
Parameter Type Required Default Description contactAutomationobject Yes — Contact Automation
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contactAutomation" : {
"type" : "object" ,
"description" : "Contact Automation" ,
"properties" : {
"contact" : {
"type" : "integer" ,
"description" : "Contact ID to enroll in the automation"
},
"automation" : {
"type" : "integer" ,
"description" : "Automation ID to enroll the contact in"
}
},
"required" : [
"contact" ,
"automation"
]
}
},
"required" : [
"PCID" ,
"contactAutomation"
]
}
Add or update contact list subscription
Parameters:
Parameter Type Required Default Description contactListobject Yes — Contact List
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contactList" : {
"type" : "object" ,
"description" : "Contact List" ,
"properties" : {
"list" : {
"type" : "integer" ,
"description" : "List ID"
},
"contact" : {
"type" : "integer" ,
"description" : "Contact ID"
},
"status" : {
"type" : "integer" ,
"description" : "Subscription status (1=active/subscribed, 2=unsubscribed)"
}
},
"required" : [
"list" ,
"contact" ,
"status"
]
}
},
"required" : [
"PCID" ,
"contactList"
]
}
Add a tag to a contact
Parameters:
Parameter Type Required Default Description contactTagobject Yes — Contact Tag
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contactTag" : {
"type" : "object" ,
"description" : "Contact Tag" ,
"properties" : {
"contact" : {
"type" : "integer" ,
"description" : "Contact ID to tag"
},
"tag" : {
"type" : "integer" ,
"description" : "Tag ID to apply to the contact"
}
},
"required" : [
"contact" ,
"tag"
]
}
},
"required" : [
"PCID" ,
"contactTag"
]
}
Create a contact custom field
Parameters:
Parameter Type Required Default Description fieldobject Yes — The field value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"field" : {
"type" : "object" ,
"description" : "The field value" ,
"properties" : {
"type" : {
"type" : "string" ,
"description" : "Field type"
},
"title" : {
"type" : "string" ,
"description" : "Field label shown in the UI"
},
"description" : {
"type" : "string" ,
"description" : "Field description"
},
"perstag" : {
"type" : "string" ,
"description" : "Personalization tag for use in email templates"
},
"defval" : {
"type" : "string" ,
"description" : "Default value for the field"
},
"show_in_list" : {
"type" : "integer" ,
"description" : "Whether to show field in contact list view (0=no, 1=yes)"
},
"visible" : {
"type" : "integer" ,
"description" : "Whether field is visible (0=hidden, 1=visible)"
},
"ordernum" : {
"type" : "integer" ,
"description" : "Display order of the field"
}
},
"required" : [
"type" ,
"title"
]
}
},
"required" : [
"PCID" ,
"field"
]
}
Link custom field to lists
Parameters:
Parameter Type Required Default Description fieldIdinteger Yes — Custom field ID to link fieldRelobject Yes — Field Rel
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fieldId" : {
"type" : "integer" ,
"description" : "Custom field ID to link"
},
"fieldRel" : {
"type" : "object" ,
"description" : "Field Rel" ,
"properties" : {
"field" : {
"type" : "integer" ,
"description" : "Custom field ID (should match path parameter)"
},
"relid" : {
"type" : "integer" ,
"description" : "List ID to link the field to"
}
},
"required" : [
"field" ,
"relid"
]
}
},
"required" : [
"PCID" ,
"fieldId" ,
"fieldRel"
]
}
Create a contact field value
Parameters:
Parameter Type Required Default Description fieldValueobject Yes — Field Value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fieldValue" : {
"type" : "object" ,
"description" : "Field Value" ,
"properties" : {
"contact" : {
"type" : "integer" ,
"description" : "Contact ID"
},
"field" : {
"type" : "integer" ,
"description" : "Custom field ID"
},
"value" : {
"type" : "string" ,
"description" : "Value to store in the field"
}
},
"required" : [
"contact" ,
"field" ,
"value"
]
}
},
"required" : [
"PCID" ,
"fieldValue"
]
}
Create a tag
Parameters:
Parameter Type Required Default Description tagobject Yes — The tag value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"tag" : {
"type" : "object" ,
"description" : "The tag value" ,
"properties" : {
"tag" : {
"type" : "string" ,
"description" : "Tag name"
},
"tagType" : {
"type" : "string" ,
"description" : "Tag type (e.g., \" contact \" for contact tags)"
},
"description" : {
"type" : "string" ,
"description" : "Optional description for the tag"
}
},
"required" : [
"tag" ,
"tagType"
]
}
},
"required" : [
"PCID" ,
"tag"
]
}
activecampaign_create_deal
Create a deal
Parameters:
Parameter Type Required Default Description dealobject Yes — The deal value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"deal" : {
"type" : "object" ,
"description" : "The deal value" ,
"properties" : {
"title" : {
"type" : "string" ,
"description" : "Deal title"
},
"contact" : {
"type" : "integer" ,
"description" : "Contact ID associated with the deal"
},
"value" : {
"type" : "integer" ,
"description" : "Deal value in cents (e.g., 10000 = $100.00)"
},
"currency" : {
"type" : "string" ,
"description" : "Currency code (e.g., \" usd \" , \" eur \" )"
},
"group" : {
"type" : "integer" ,
"description" : "Pipeline (deal group) ID"
},
"stage" : {
"type" : "integer" ,
"description" : "Deal stage ID within the pipeline"
},
"owner" : {
"type" : "integer" ,
"description" : "Deal owner (user) ID"
},
"percent" : {
"type" : "integer" ,
"description" : "Probability percentage of closing (0-100)"
},
"status" : {
"type" : "integer" ,
"description" : "Deal status (0=open, 1=won, 2=lost)"
},
"description" : {
"type" : "string" ,
"description" : "Deal description"
}
},
"required" : [
"title" ,
"contact" ,
"value" ,
"currency"
]
}
},
"required" : [
"PCID" ,
"deal"
]
}
activecampaign_create_deal_note
Create a deal note
Parameters:
Parameter Type Required Default Description dealIdinteger Yes — Deal ID to add the note to noteobject Yes — The note value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"dealId" : {
"type" : "integer" ,
"description" : "Deal ID to add the note to"
},
"note" : {
"type" : "object" ,
"description" : "The note value" ,
"properties" : {
"note" : {
"type" : "string" ,
"description" : "Note content text"
}
},
"required" : [
"note"
]
}
},
"required" : [
"PCID" ,
"dealId" ,
"note"
]
}
activecampaign_create_deal_pipeline
Create a deal pipeline
Parameters:
Parameter Type Required Default Description dealGroupobject Yes — Deal Group
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"dealGroup" : {
"type" : "object" ,
"description" : "Deal Group" ,
"properties" : {
"title" : {
"type" : "string" ,
"description" : "Pipeline name"
},
"currency" : {
"type" : "string" ,
"description" : "Default currency code for deals in this pipeline (e.g., \" usd \" )"
},
"autoAssign" : {
"type" : "integer" ,
"description" : "Auto-assign deals to users (0=off, 1=on)"
},
"allgroups" : {
"type" : "integer" ,
"description" : "Make pipeline accessible to all groups (0=no, 1=yes)"
}
},
"required" : [
"title" ,
"currency"
]
}
},
"required" : [
"PCID" ,
"dealGroup"
]
}
activecampaign_create_field_options
Create field options
Parameters:
Parameter Type Required Default Description fieldIdinteger Yes — Custom field ID to add options to fieldOptionsobject[] Yes — Array of field options to create
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fieldId" : {
"type" : "integer" ,
"description" : "Custom field ID to add options to"
},
"fieldOptions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Array of field options to create"
}
},
"required" : [
"PCID" ,
"fieldId" ,
"fieldOptions"
]
}
activecampaign_create_list
Create a list
Parameters:
Parameter Type Required Default Description listobject Yes — The list value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"list" : {
"type" : "object" ,
"description" : "The list value" ,
"properties" : {
"name" : {
"type" : "string" ,
"description" : "List name"
},
"stringid" : {
"type" : "string" ,
"description" : "Unique string identifier for the list (URL-safe)"
},
"sender_url" : {
"type" : "string" ,
"description" : "URL of the sender's website"
},
"sender_reminder" : {
"type" : "string" ,
"description" : "Reminder message shown to subscribers about why they are on the list"
},
"sender_name" : {
"type" : "string" ,
"description" : "Name of the sender"
},
"sender_addr1" : {
"type" : "string" ,
"description" : "Sender's address line 1"
},
"sender_city" : {
"type" : "string" ,
"description" : "Sender's city"
},
"sender_state" : {
"type" : "string" ,
"description" : "Sender's state/province"
},
"sender_zip" : {
"type" : "string" ,
"description" : "Sender's postal/zip code"
},
"sender_country" : {
"type" : "string" ,
"description" : "Sender's country"
}
},
"required" : [
"name" ,
"sender_url" ,
"sender_reminder"
]
}
},
"required" : [
"PCID" ,
"list"
]
}
activecampaign_create_list_group_permission
Create list group permission
Parameters:
Parameter Type Required Default Description listIdinteger Yes — List ID to grant permission on listGroupPermissionobject Yes — List Group Permission
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"listId" : {
"type" : "integer" ,
"description" : "List ID to grant permission on"
},
"listGroupPermission" : {
"type" : "object" ,
"description" : "List Group Permission" ,
"properties" : {
"groupid" : {
"type" : "integer" ,
"description" : "Group ID to grant permission to"
},
"listid" : {
"type" : "integer" ,
"description" : "List ID (should match path parameter)"
}
},
"required" : [
"groupid" ,
"listid"
]
}
},
"required" : [
"PCID" ,
"listId" ,
"listGroupPermission"
]
}
Create or update a contact
Parameters:
Parameter Type Required Default Description contactobject Yes — The contact value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contact" : {
"type" : "object" ,
"description" : "The contact value" ,
"properties" : {
"email" : {
"type" : "string" ,
"description" : "Contact's email address (used as unique identifier)"
},
"firstName" : {
"type" : "string" ,
"description" : "Contact's first name"
},
"lastName" : {
"type" : "string" ,
"description" : "Contact's last name"
},
"phone" : {
"type" : "string" ,
"description" : "Contact's phone number"
},
"fieldValues" : {
"type" : "array" ,
"description" : "Custom field values to set on the contact"
}
},
"required" : [
"email"
]
}
},
"required" : [
"PCID" ,
"contact"
]
}
activecampaign_deal_owner_bulk_update
Bulk update deal owners
Parameters:
Parameter Type Required Default Description dealIdsinteger[] Yes — Array of deal IDs to reassign ownerinteger Yes — New owner (user) ID to assign all specified deals to
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"dealIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Array of deal IDs to reassign"
},
"owner" : {
"type" : "integer" ,
"description" : "New owner (user) ID to assign all specified deals to"
}
},
"required" : [
"PCID" ,
"dealIds" ,
"owner"
]
}
activecampaign_get_campaign
Get a campaign
Parameters:
Parameter Type Required Default Description idinteger Yes — Campaign ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Campaign ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_get_campaign_links
Get campaign links
Parameters:
Parameter Type Required Default Description idinteger Yes — Campaign ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Campaign ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
Get a contact
Parameters:
Parameter Type Required Default Description idinteger Yes — Contact ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Contact ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
Get a contact automation
Parameters:
Parameter Type Required Default Description idinteger Yes — Contact automation record ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Contact automation record ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
Get a contact custom field
Parameters:
Parameter Type Required Default Description idinteger Yes — Custom field ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Custom field ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
Get a contact field value
Parameters:
Parameter Type Required Default Description idinteger Yes — Field value ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Field value ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_get_deal
Get a deal
Parameters:
Parameter Type Required Default Description idinteger Yes — Deal ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Deal ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_get_deal_pipeline
Get a deal pipeline
Parameters:
Parameter Type Required Default Description idinteger Yes — Pipeline (deal group) ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Pipeline (deal group) ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_get_list
Get a list
Parameters:
Parameter Type Required Default Description idinteger Yes — List ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "List ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_get_tag
Get a tag
Parameters:
Parameter Type Required Default Description idinteger Yes — Tag ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Tag ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
activecampaign_list_automations
List automations
Parameters:
Parameter Type Required Default Description limitinteger No — Maximum number of automations to return offsetinteger No — Number of automations to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of automations to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of automations to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_campaigns
List campaigns
Parameters:
Parameter Type Required Default Description filtersStatusinteger No — Filter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled) filtersTypestring No — Filter by campaign type (single, recurring, split, responder, reminder, special, activerss, text) filtersAfterstring No — Filter campaigns sent after this date (YYYY-MM-DD format) filtersBeforestring No — Filter campaigns sent before this date (YYYY-MM-DD format) searchstring No — Search campaigns by name limitinteger No — Maximum number of campaigns to return offsetinteger No — Number of campaigns to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"filtersStatus" : {
"type" : "integer" ,
"description" : "Filter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled)"
},
"filtersType" : {
"type" : "string" ,
"description" : "Filter by campaign type (single, recurring, split, responder, reminder, special, activerss, text)"
},
"filtersAfter" : {
"type" : "string" ,
"description" : "Filter campaigns sent after this date (YYYY-MM-DD format)"
},
"filtersBefore" : {
"type" : "string" ,
"description" : "Filter campaigns sent before this date (YYYY-MM-DD format)"
},
"search" : {
"type" : "string" ,
"description" : "Search campaigns by name"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of campaigns to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of campaigns to skip for pagination"
}
},
"required" : [
"PCID"
]
}
List a contact’s automations
Parameters:
Parameter Type Required Default Description contactIdinteger Yes — Contact ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contactId" : {
"type" : "integer" ,
"description" : "Contact ID"
}
},
"required" : [
"PCID" ,
"contactId"
]
}
List contact custom fields
Parameters:
Parameter Type Required Default Description limitinteger No — Maximum number of fields to return (default 100) offsetinteger No — Number of fields to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of fields to return (default 100)"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of fields to skip for pagination"
}
},
"required" : [
"PCID"
]
}
List contact field values
Parameters:
Parameter Type Required Default Description filtersContactinteger No — Filter field values by contact ID filtersFieldinteger No — Filter field values by custom field ID limitinteger No — Maximum number of results to return offsetinteger No — Number of results to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"filtersContact" : {
"type" : "integer" ,
"description" : "Filter field values by contact ID"
},
"filtersField" : {
"type" : "integer" ,
"description" : "Filter field values by custom field ID"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of results to skip for pagination"
}
},
"required" : [
"PCID"
]
}
List contacts
Parameters:
Parameter Type Required Default Description listidinteger No — Filter contacts by list ID segmentidinteger No — Filter contacts by segment ID tagidinteger No — Filter contacts by tag ID formidinteger No — Filter contacts by form ID statusinteger No — Filter by subscription status (1=active, 2=unsubscribed, 3=bounced, 0=any) emailstring No — Filter by exact email address searchstring No — Search contacts by name, email, or organization limitinteger No — Maximum number of contacts to return (default 20, max 100) offsetinteger No — Number of contacts to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"listid" : {
"type" : "integer" ,
"description" : "Filter contacts by list ID"
},
"segmentid" : {
"type" : "integer" ,
"description" : "Filter contacts by segment ID"
},
"tagid" : {
"type" : "integer" ,
"description" : "Filter contacts by tag ID"
},
"formid" : {
"type" : "integer" ,
"description" : "Filter contacts by form ID"
},
"status" : {
"type" : "integer" ,
"description" : "Filter by subscription status (1=active, 2=unsubscribed, 3=bounced, 0=any)" ,
"enum" : [
0 ,
1 ,
2 ,
3
]
},
"email" : {
"type" : "string" ,
"description" : "Filter by exact email address"
},
"search" : {
"type" : "string" ,
"description" : "Search contacts by name, email, or organization"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of contacts to return (default 20, max 100)"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of contacts to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_deal_activities
List deal activities
Parameters:
Parameter Type Required Default Description filtersDealinteger No — Filter activities by deal ID filtersOwnerinteger No — Filter activities by owner (user) ID limitinteger No — Maximum number of activities to return offsetinteger No — Number of activities to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"filtersDeal" : {
"type" : "integer" ,
"description" : "Filter activities by deal ID"
},
"filtersOwner" : {
"type" : "integer" ,
"description" : "Filter activities by owner (user) ID"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of activities to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of activities to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_deal_pipelines
List deal pipelines
Parameters:
Parameter Type Required Default Description limitinteger No — Maximum number of pipelines to return offsetinteger No — Number of pipelines to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of pipelines to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of pipelines to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_deals
List deals
Parameters:
Parameter Type Required Default Description search_fieldstring No — Field to search by (all, title, contact, org) search_valuestring No — Value to search for in the selected search_field statusinteger No — Filter by deal status (0=open, 1=won, 2=lost) filtersStageinteger No — Filter by deal stage ID filtersGroupinteger No — Filter by pipeline (deal group) ID filtersOwnerinteger No — Filter by deal owner (user) ID limitinteger No — Maximum number of deals to return offsetinteger No — Number of deals to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"search_field" : {
"type" : "string" ,
"description" : "Field to search by (all, title, contact, org)" ,
"enum" : [
"all" ,
"title" ,
"contact" ,
"org"
]
},
"search_value" : {
"type" : "string" ,
"description" : "Value to search for in the selected search_field"
},
"status" : {
"type" : "integer" ,
"description" : "Filter by deal status (0=open, 1=won, 2=lost)" ,
"enum" : [
0 ,
1 ,
2
]
},
"filtersStage" : {
"type" : "integer" ,
"description" : "Filter by deal stage ID"
},
"filtersGroup" : {
"type" : "integer" ,
"description" : "Filter by pipeline (deal group) ID"
},
"filtersOwner" : {
"type" : "integer" ,
"description" : "Filter by deal owner (user) ID"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of deals to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of deals to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_email_activities
List email activities
Parameters:
Parameter Type Required Default Description filtersContactinteger No — Filter email activities by contact ID filtersCampaigninteger No — Filter email activities by campaign ID limitinteger No — Maximum number of activities to return offsetinteger No — Number of activities to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"filtersContact" : {
"type" : "integer" ,
"description" : "Filter email activities by contact ID"
},
"filtersCampaign" : {
"type" : "integer" ,
"description" : "Filter email activities by campaign ID"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of activities to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of activities to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_groups
List user groups
Parameters:
Parameter Type Required Default Description limitinteger No — Maximum number of groups to return offsetinteger No — Number of groups to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of groups to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of groups to skip for pagination"
}
},
"required" : [
"PCID"
]
}
activecampaign_list_lists
List contact lists
Parameters:
Parameter Type Required Default Description filtersNameContainsstring No — Filter lists whose name contains this string limitinteger No — Maximum number of lists to return offsetinteger No — Number of lists to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"filtersNameContains" : {
"type" : "string" ,
"description" : "Filter lists whose name contains this string"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of lists to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of lists to skip for pagination"
}
},
"required" : [
"PCID"
]
}
List tags
Parameters:
Parameter Type Required Default Description searchstring No — Filter tags by name (partial match) limitinteger No — Maximum number of tags to return offsetinteger No — Number of tags to skip for pagination
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"search" : {
"type" : "string" ,
"description" : "Filter tags by name (partial match)"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of tags to return"
},
"offset" : {
"type" : "integer" ,
"description" : "Number of tags to skip for pagination"
}
},
"required" : [
"PCID"
]
}
Remove a contact from an automation
Parameters:
Parameter Type Required Default Description idinteger Yes — Contact automation record ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Contact automation record ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
Update a contact field value
Parameters:
Parameter Type Required Default Description idinteger Yes — Field value ID fieldValueobject Yes — Field Value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Field value ID"
},
"fieldValue" : {
"type" : "object" ,
"description" : "Field Value" ,
"properties" : {
"value" : {
"type" : "string" ,
"description" : "New value for the field"
}
},
"required" : [
"value"
]
}
},
"required" : [
"PCID" ,
"id" ,
"fieldValue"
]
}
activecampaign_update_deal
Update a deal
Parameters:
Parameter Type Required Default Description idinteger Yes — Deal ID dealobject Yes — The deal value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Deal ID"
},
"deal" : {
"type" : "object" ,
"description" : "The deal value" ,
"properties" : {
"title" : {
"type" : "string" ,
"description" : "Deal title"
},
"value" : {
"type" : "integer" ,
"description" : "Deal value in cents"
},
"currency" : {
"type" : "string" ,
"description" : "Currency code"
},
"group" : {
"type" : "integer" ,
"description" : "Pipeline (deal group) ID"
},
"stage" : {
"type" : "integer" ,
"description" : "Deal stage ID"
},
"owner" : {
"type" : "integer" ,
"description" : "Deal owner (user) ID"
},
"percent" : {
"type" : "integer" ,
"description" : "Probability percentage (0-100)"
},
"status" : {
"type" : "integer" ,
"description" : "Deal status (0=open, 1=won, 2=lost)"
},
"description" : {
"type" : "string" ,
"description" : "Deal description"
}
}
}
},
"required" : [
"PCID" ,
"id" ,
"deal"
]
}
activecampaign_update_deal_note
Update a deal note
Parameters:
Parameter Type Required Default Description dealIdinteger Yes — Deal ID the note belongs to noteIdinteger Yes — Note ID to update noteobject Yes — The note value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"dealId" : {
"type" : "integer" ,
"description" : "Deal ID the note belongs to"
},
"noteId" : {
"type" : "integer" ,
"description" : "Note ID to update"
},
"note" : {
"type" : "object" ,
"description" : "The note value" ,
"properties" : {
"note" : {
"type" : "string" ,
"description" : "Updated note content"
}
},
"required" : [
"note"
]
}
},
"required" : [
"PCID" ,
"dealId" ,
"noteId" ,
"note"
]
}
activecampaign_update_deal_pipeline
Update a deal pipeline
Parameters:
Parameter Type Required Default Description idinteger Yes — Pipeline (deal group) ID dealGroupobject Yes — Deal Group
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Pipeline (deal group) ID"
},
"dealGroup" : {
"type" : "object" ,
"description" : "Deal Group" ,
"properties" : {
"title" : {
"type" : "string" ,
"description" : "Pipeline name"
},
"currency" : {
"type" : "string" ,
"description" : "Default currency code"
},
"autoAssign" : {
"type" : "integer" ,
"description" : "Auto-assign deals to users (0=off, 1=on)"
},
"allgroups" : {
"type" : "integer" ,
"description" : "Make pipeline accessible to all groups (0=no, 1=yes)"
}
}
}
},
"required" : [
"PCID" ,
"id" ,
"dealGroup"
]
}
activecampaign_update_list
Update a list
Parameters:
Parameter Type Required Default Description idinteger Yes — List ID listobject Yes — The list value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "List ID"
},
"list" : {
"type" : "object" ,
"description" : "The list value" ,
"properties" : {
"name" : {
"type" : "string" ,
"description" : "List name"
},
"sender_url" : {
"type" : "string" ,
"description" : "URL of the sender's website"
},
"sender_reminder" : {
"type" : "string" ,
"description" : "Reminder message for subscribers"
},
"sender_name" : {
"type" : "string" ,
"description" : "Name of the sender"
},
"sender_addr1" : {
"type" : "string" ,
"description" : "Sender's address line 1"
},
"sender_city" : {
"type" : "string" ,
"description" : "Sender's city"
},
"sender_state" : {
"type" : "string" ,
"description" : "Sender's state/province"
},
"sender_zip" : {
"type" : "string" ,
"description" : "Sender's postal/zip code"
},
"sender_country" : {
"type" : "string" ,
"description" : "Sender's country"
}
}
}
},
"required" : [
"PCID" ,
"id" ,
"list"
]
}