> ## 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.
# activecampaign
> ActiveCampaign - contact management, email marketing, automations, CRM deals and pipelines
**Server path:** `/activecampaign` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [`activecampaign_add_contact_to_automation`](#activecampaign_add_contact_to_automation) | Add a contact to an automation |
| [`activecampaign_add_contact_to_list`](#activecampaign_add_contact_to_list) | Add or update contact list subscription |
| [`activecampaign_add_tag_to_contact`](#activecampaign_add_tag_to_contact) | Add a tag to a contact |
| [`activecampaign_create_contact_custom_field`](#activecampaign_create_contact_custom_field) | Create a contact custom field |
| [`activecampaign_create_contact_field_relationship`](#activecampaign_create_contact_field_relationship) | Link custom field to lists |
| [`activecampaign_create_contact_field_value`](#activecampaign_create_contact_field_value) | Create a contact field value |
| [`activecampaign_create_contact_tag`](#activecampaign_create_contact_tag) | Create a tag |
| [`activecampaign_create_deal`](#activecampaign_create_deal) | Create a deal |
| [`activecampaign_create_deal_note`](#activecampaign_create_deal_note) | Create a deal note |
| [`activecampaign_create_deal_pipeline`](#activecampaign_create_deal_pipeline) | Create a deal pipeline |
| [`activecampaign_create_field_options`](#activecampaign_create_field_options) | Create field options |
| [`activecampaign_create_list`](#activecampaign_create_list) | Create a list |
| [`activecampaign_create_list_group_permission`](#activecampaign_create_list_group_permission) | Create list group permission |
| [`activecampaign_create_or_update_contact`](#activecampaign_create_or_update_contact) | Create or update a contact |
| [`activecampaign_deal_owner_bulk_update`](#activecampaign_deal_owner_bulk_update) | Bulk update deal owners |
| [`activecampaign_get_campaign`](#activecampaign_get_campaign) | Get a campaign |
| [`activecampaign_get_campaign_links`](#activecampaign_get_campaign_links) | Get campaign links |
| [`activecampaign_get_contact`](#activecampaign_get_contact) | Get a contact |
| [`activecampaign_get_contact_automation`](#activecampaign_get_contact_automation) | Get a contact automation |
| [`activecampaign_get_contact_custom_field`](#activecampaign_get_contact_custom_field) | Get a contact custom field |
| [`activecampaign_get_contact_field_value`](#activecampaign_get_contact_field_value) | Get a contact field value |
| [`activecampaign_get_deal`](#activecampaign_get_deal) | Get a deal |
| [`activecampaign_get_deal_pipeline`](#activecampaign_get_deal_pipeline) | Get a deal pipeline |
| [`activecampaign_get_list`](#activecampaign_get_list) | Get a list |
| [`activecampaign_get_tag`](#activecampaign_get_tag) | Get a tag |
| [`activecampaign_list_automations`](#activecampaign_list_automations) | List automations |
| [`activecampaign_list_campaigns`](#activecampaign_list_campaigns) | List campaigns |
| [`activecampaign_list_contact_automations`](#activecampaign_list_contact_automations) | List a contact's automations |
| [`activecampaign_list_contact_custom_fields`](#activecampaign_list_contact_custom_fields) | List contact custom fields |
| [`activecampaign_list_contact_field_values`](#activecampaign_list_contact_field_values) | List contact field values |
| [`activecampaign_list_contacts`](#activecampaign_list_contacts) | List, search, and filter contacts |
| [`activecampaign_list_deal_activities`](#activecampaign_list_deal_activities) | List deal activities |
| [`activecampaign_list_deal_pipelines`](#activecampaign_list_deal_pipelines) | List deal pipelines |
| [`activecampaign_list_deals`](#activecampaign_list_deals) | List all deals |
| [`activecampaign_list_email_activities`](#activecampaign_list_email_activities) | List email activities |
| [`activecampaign_list_groups`](#activecampaign_list_groups) | List user groups |
| [`activecampaign_list_lists`](#activecampaign_list_lists) | List contact lists |
| [`activecampaign_list_tags`](#activecampaign_list_tags) | List tags |
| [`activecampaign_remove_contact_from_automation`](#activecampaign_remove_contact_from_automation) | Remove a contact from an automation |
| [`activecampaign_update_contact_field_value`](#activecampaign_update_contact_field_value) | Update a contact field value |
| [`activecampaign_update_deal`](#activecampaign_update_deal) | Update a deal |
| [`activecampaign_update_deal_note`](#activecampaign_update_deal_note) | Update a deal note |
| [`activecampaign_update_deal_pipeline`](#activecampaign_update_deal_pipeline) | Update a deal pipeline |
| [`activecampaign_update_list`](#activecampaign_update_list) | Update a list |
***
## activecampaign\_add\_contact\_to\_automation
Add a contact to an automation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ------------------ |
| `contactAutomation` | object | Yes | — | Contact Automation |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_add\_contact\_to\_list
Add or update contact list subscription
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------ |
| `contactList` | object | Yes | — | Contact List |
```json theme={null}
{
"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)",
"enum": [
1,
2
]
}
},
"required": [
"list",
"contact",
"status"
]
}
},
"required": [
"PCID",
"contactList"
]
}
```
***
## activecampaign\_add\_tag\_to\_contact
Add a tag to a contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `contactTag` | object | Yes | — | Contact Tag |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_create\_contact\_custom\_field
Create a contact custom field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------- |
| `field` | object | Yes | — | The field value |
```json theme={null}
{
"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",
"enum": [
"text",
"textarea",
"date",
"datetime",
"dropdown",
"multiselect",
"radio",
"checkbox",
"hidden",
"currency",
"number"
]
},
"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)",
"enum": [
0,
1
]
},
"visible": {
"type": "integer",
"description": "Whether field is visible (0=hidden, 1=visible)",
"enum": [
0,
1
]
},
"ordernum": {
"type": "integer",
"description": "Display order of the field"
}
},
"required": [
"type",
"title"
]
}
},
"required": [
"PCID",
"field"
]
}
```
***
## 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 |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_create\_contact\_field\_value
Create a contact field value
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `fieldValue` | object | Yes | — | Field Value |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_create\_contact\_tag
Create a tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------- |
| `tag` | object | Yes | — | The tag value |
```json theme={null}
{
"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)",
"enum": [
"contact",
"template"
]
},
"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 |
| --------- | ------ | -------- | ------- | -------------- |
| `deal` | object | Yes | — | The deal value |
```json theme={null}
{
"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)",
"enum": [
0,
1,
2
]
},
"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 |
| --------- | ------- | -------- | ------- | -------------------------- |
| `dealId` | integer | Yes | — | Deal ID to add the note to |
| `note` | object | Yes | — | The note value |
```json theme={null}
{
"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 |
| ----------- | ------ | -------- | ------- | ----------- |
| `dealGroup` | object | Yes | — | Deal Group |
```json theme={null}
{
"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)",
"enum": [
0,
1
]
},
"allgroups": {
"type": "integer",
"description": "Make pipeline accessible to all groups (0=no, 1=yes)",
"enum": [
0,
1
]
}
},
"required": [
"title",
"currency"
]
}
},
"required": [
"PCID",
"dealGroup"
]
}
```
***
## 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 |
```json theme={null}
{
"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",
"properties": {
"label": {
"type": "string",
"description": "Display label for the option"
},
"value": {
"type": "string",
"description": "Stored value for the option"
},
"isdefault": {
"type": "integer",
"enum": [
0,
1
],
"description": "Whether this is the default option (0=no, 1=yes)"
},
"orderid": {
"type": "integer",
"description": "Display order of the option"
}
},
"required": [
"label",
"value"
]
},
"description": "Array of field options to create"
}
},
"required": [
"PCID",
"fieldId",
"fieldOptions"
]
}
```
***
## activecampaign\_create\_list
Create a list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------- |
| `list` | object | Yes | — | The list value |
```json theme={null}
{
"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 |
| --------------------- | ------- | -------- | ------- | ------------------------------ |
| `listId` | integer | Yes | — | List ID to grant permission on |
| `listGroupPermission` | object | Yes | — | List Group Permission |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_create\_or\_update\_contact
Create or update a contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------- |
| `contact` | object | Yes | — | The contact value |
```json theme={null}
{
"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",
"items": {
"type": "object"
},
"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 |
| --------- | ---------- | -------- | ------- | ---------------------------------------------------- |
| `dealIds` | integer\[] | Yes | — | Array of deal IDs to reassign |
| `owner` | integer | Yes | — | New owner (user) ID to assign all specified deals to |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | Campaign ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | Campaign ID |
```json theme={null}
{
"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\_contact
Get a contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | Contact ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## activecampaign\_get\_contact\_automation
Get a contact automation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------------------- |
| `id` | integer | Yes | — | Contact automation record ID |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_get\_contact\_custom\_field
Get a contact custom field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------- |
| `id` | integer | Yes | — | Custom field ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Custom field ID"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## activecampaign\_get\_contact\_field\_value
Get a contact field value
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------- |
| `id` | integer | Yes | — | Field value ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | Deal ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ------------------------ |
| `id` | integer | Yes | — | Pipeline (deal group) ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | List ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ----------- |
| `id` | integer | Yes | — | Tag ID |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | -------------------------------------------- |
| `limit` | integer | No | — | Maximum number of automations to return |
| `offset` | integer | No | — | Number of automations to skip for pagination |
```json theme={null}
{
"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 |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `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 |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_list\_contact\_automations
List a contact's automations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------- |
| `contactId` | integer | Yes | — | Contact ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "integer",
"description": "Contact ID"
}
},
"required": [
"PCID",
"contactId"
]
}
```
***
## 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 |
```json theme={null}
{
"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"
]
}
```
***
## 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 |
```json theme={null}
{
"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"
]
}
```
***
## 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 you want to get |
| `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. When the segment results are ready, subsequent API calls without the forceQuery param will return contacts that match the segment (timeout 1 hour). |
| `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 that match the given value in the contact names, organization, phone or email |
| `seriesid` | integer | No | — | Filter contacts associated with the given automation |
| `status` | integer | No | — | Contact status filter. See available values in ActiveCampaign contact parameters. |
| `tagid` | integer | No | — | Filter contacts associated with the given tag |
| `waitid` | integer | No | — | Filter by 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. Otherwise, a segmented API request with a consistent sorting returns the same results for 1 hour. |
| `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 that were created prior to this date |
| `filtersCreatedAfter` | string | No | — | Filter contacts that were created after this date |
| `filtersUpdatedBefore` | string | No | — | Filter contacts that were updated before this date |
| `filtersUpdatedAfter` | string | No | — | Filter contacts that were 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Filter contacts by ID. Can be repeated for multiple IDs (for example, ids[]=1&ids[]=2)."
},
"email": {
"type": "string",
"description": "Email address of the contact you want to get"
},
"email_like": {
"type": "string",
"description": "Filter contacts that contain this value in the email address"
},
"exclude": {
"type": "integer",
"description": "Exclude from the response the contact with the given ID"
},
"listid": {
"type": "string",
"description": "Filter contacts associated with the given list"
},
"segmentid": {
"type": "string",
"description": "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. When the segment results are ready, subsequent API calls without the forceQuery param will return contacts that match the segment (timeout 1 hour)."
},
"formid": {
"type": "integer",
"description": "Filter contacts associated with the given form"
},
"id_greater": {
"type": "integer",
"description": "Only include contacts with an ID greater than the given ID"
},
"id_less": {
"type": "integer",
"description": "Only include contacts with an ID less than the given ID"
},
"phone": {
"type": "string",
"description": "Filter contacts where the phone number starts with the given value"
},
"organization": {
"type": "integer",
"description": "(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID"
},
"search": {
"type": "string",
"description": "Filter contacts that match the given value in the contact names, organization, phone or email"
},
"seriesid": {
"type": "integer",
"description": "Filter contacts associated with the given automation"
},
"status": {
"type": "integer",
"description": "Contact status filter. See available values in ActiveCampaign contact parameters."
},
"tagid": {
"type": "integer",
"description": "Filter contacts associated with the given tag"
},
"waitid": {
"type": "integer",
"description": "Filter by contacts in the wait queue of an automation block"
},
"in_group_lists": {
"type": "string",
"description": "Set to true to return only contacts the current user has permission to see"
},
"forceQuery": {
"type": "number",
"description": "If present and equal to 1, a new segment request is kicked off which will return an updated result set. Otherwise, a segmented API request with a consistent sorting returns the same results for 1 hour.",
"enum": [
0,
1
]
},
"sortId": {
"type": "number",
"description": "If sorting results by a score or custom field, this parameter holds the id of the score or custom field respectively"
},
"filtersCreatedBefore": {
"type": "string",
"description": "Filter contacts that were created prior to this date"
},
"filtersCreatedAfter": {
"type": "string",
"description": "Filter contacts that were created after this date"
},
"filtersUpdatedBefore": {
"type": "string",
"description": "Filter contacts that were updated before this date"
},
"filtersUpdatedAfter": {
"type": "string",
"description": "Filter contacts that were updated after this date"
},
"ordersId": {
"type": "string",
"description": "Order contacts by unique ID",
"enum": [
"desc",
"asc"
]
},
"ordersCdate": {
"type": "string",
"description": "Order contacts by creation date",
"enum": [
"desc",
"asc"
]
},
"ordersEmail": {
"type": "string",
"description": "Order contacts by email",
"enum": [
"desc",
"asc"
]
},
"ordersFirstName": {
"type": "string",
"description": "Order contacts by first name",
"enum": [
"desc",
"asc"
]
},
"ordersLastName": {
"type": "string",
"description": "Order contacts by last name",
"enum": [
"desc",
"asc"
]
},
"ordersName": {
"type": "string",
"description": "Order contacts by full name",
"enum": [
"desc",
"asc"
]
},
"ordersScore": {
"type": "string",
"description": "Order contacts by score. Use together with sortId.",
"enum": [
"desc",
"asc"
]
},
"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 |
| -------------- | ------- | -------- | ------- | ------------------------------------------- |
| `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 |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | ------------------------------------------ |
| `limit` | integer | No | — | Maximum number of pipelines to return |
| `offset` | integer | No | — | Number of pipelines to skip for pagination |
```json theme={null}
{
"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 all deals
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filtersSearch` | string | No | — | Search text to use with search\_field parameter. |
| `filtersSearchField` | string | No | — | Field to search for. See available values in ActiveCampaign deal parameters. |
| `filtersTitle` | string | No | — | Filter by deal's title |
| `filtersStage` | integer | No | — | Filter by deal's stage |
| `filtersGroup` | integer | No | — | Filter by deal's pipeline |
| `filtersStatus` | integer | No | — | Filter by deal's status. See available values in ActiveCampaign deal parameters. |
| `filtersOwner` | integer | No | — | Filter by deal's owner |
| `filtersNextdateRange` | string | No | — | Filter by deal's tasks due dates. See available values in ActiveCampaign deal parameters. |
| `filtersTag` | string | No | — | Filter by tag names associated with deal's primary contact. See available values in ActiveCampaign deal parameters. |
| `filtersTasktype` | string | No | — | Filter by deals that have tasks with given type |
| `filtersCreatedBefore` | string | No | — | Returns deals that are created less than given date |
| `filtersCreatedAfter` | string | No | — | Returns deals that are created greater than or equal to given date |
| `filtersUpdatedBefore` | string | No | — | Returns deals that are updated less than given date |
| `filtersUpdatedAfter` | string | No | — | Returns deals that are updated greater than or equal to given date |
| `filtersOrganization` | integer | No | — | Filter by deal's primary contact's organization's id |
| `filtersMinimumValue` | integer | No | — | In USD with dollar portion. Returns deals whose values are greater than or equal to given value |
| `filtersMaximumValue` | integer | No | — | In USD with dollar portion. Returns deals whose values are less than or equal to given value |
| `filtersScoreGreaterThan` | string | No | — | In a format of \:\. Returns deals whose score value is greater than given value |
| `filtersScoreLessThan` | string | No | — | In a format of \:\. Returns deals whose score value is less than given value |
| `filtersScore` | string | No | — | In a format of \:\. Returns deals whose score value is equal to given value |
| `ordersTitle` | string | No | — | Order by deal's title. |
| `ordersValue` | string | No | — | Order by deal's value. |
| `ordersCdate` | string | No | — | Order by deal's created date. |
| `ordersContactName` | string | No | — | Order by deal's primary contact's first name. |
| `ordersContactOrgname` | string | No | — | Order by deal's primary contact's organization name. |
| `ordersNextAction` | string | No | — | Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id. |
| `limit` | integer | No | — | Maximum number of deals to return |
| `offset` | integer | No | — | Number of deals to skip for pagination |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filtersSearch": {
"type": "string",
"description": "Search text to use with search_field parameter."
},
"filtersSearchField": {
"type": "string",
"description": "Field to search for. See available values in ActiveCampaign deal parameters."
},
"filtersTitle": {
"type": "string",
"description": "Filter by deal's title"
},
"filtersStage": {
"type": "integer",
"description": "Filter by deal's stage"
},
"filtersGroup": {
"type": "integer",
"description": "Filter by deal's pipeline"
},
"filtersStatus": {
"type": "integer",
"description": "Filter by deal's status. See available values in ActiveCampaign deal parameters."
},
"filtersOwner": {
"type": "integer",
"description": "Filter by deal's owner"
},
"filtersNextdateRange": {
"type": "string",
"description": "Filter by deal's tasks due dates. See available values in ActiveCampaign deal parameters."
},
"filtersTag": {
"type": "string",
"description": "Filter by tag names associated with deal's primary contact. See available values in ActiveCampaign deal parameters."
},
"filtersTasktype": {
"type": "string",
"description": "Filter by deals that have tasks with given type"
},
"filtersCreatedBefore": {
"type": "string",
"description": "Returns deals that are created less than given date"
},
"filtersCreatedAfter": {
"type": "string",
"description": "Returns deals that are created greater than or equal to given date"
},
"filtersUpdatedBefore": {
"type": "string",
"description": "Returns deals that are updated less than given date"
},
"filtersUpdatedAfter": {
"type": "string",
"description": "Returns deals that are updated greater than or equal to given date"
},
"filtersOrganization": {
"type": "integer",
"description": "Filter by deal's primary contact's organization's id"
},
"filtersMinimumValue": {
"type": "integer",
"description": "In USD with dollar portion. Returns deals whose values are greater than or equal to given value"
},
"filtersMaximumValue": {
"type": "integer",
"description": "In USD with dollar portion. Returns deals whose values are less than or equal to given value"
},
"filtersScoreGreaterThan": {
"type": "string",
"description": "In a format of :. Returns deals whose score value is greater than given value"
},
"filtersScoreLessThan": {
"type": "string",
"description": "In a format of :. Returns deals whose score value is less than given value"
},
"filtersScore": {
"type": "string",
"description": "In a format of :. Returns deals whose score value is equal to given value"
},
"ordersTitle": {
"type": "string",
"description": "Order by deal's title.",
"enum": [
"desc",
"asc"
]
},
"ordersValue": {
"type": "string",
"description": "Order by deal's value.",
"enum": [
"desc",
"asc"
]
},
"ordersCdate": {
"type": "string",
"description": "Order by deal's created date.",
"enum": [
"desc",
"asc"
]
},
"ordersContactName": {
"type": "string",
"description": "Order by deal's primary contact's first name.",
"enum": [
"desc",
"asc"
]
},
"ordersContactOrgname": {
"type": "string",
"description": "Order by deal's primary contact's organization name.",
"enum": [
"desc",
"asc"
]
},
"ordersNextAction": {
"type": "string",
"description": "Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id.",
"enum": [
"desc",
"asc"
]
},
"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 |
| ----------------- | ------- | -------- | ------- | ------------------------------------------- |
| `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 |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `limit` | integer | No | — | Maximum number of groups to return |
| `offset` | integer | No | — | Number of groups to skip for pagination |
```json theme={null}
{
"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 |
| --------------------- | ------- | -------- | ------- | -------------------------------------------- |
| `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 |
```json theme={null}
{
"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"
]
}
```
***
## 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 |
```json theme={null}
{
"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"
]
}
```
***
## activecampaign\_remove\_contact\_from\_automation
Remove a contact from an automation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------------------- |
| `id` | integer | Yes | — | Contact automation record ID |
```json theme={null}
{
"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"
]
}
```
***
## 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 |
```json theme={null}
{
"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 |
| --------- | ------- | -------- | ------- | -------------- |
| `id` | integer | Yes | — | Deal ID |
| `deal` | object | Yes | — | The deal value |
```json theme={null}
{
"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)",
"enum": [
0,
1,
2
]
},
"description": {
"type": "string",
"description": "Deal description"
}
}
}
},
"required": [
"PCID",
"id",
"deal"
]
}
```
***
## 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 |
```json theme={null}
{
"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 |
| ----------- | ------- | -------- | ------- | ------------------------ |
| `id` | integer | Yes | — | Pipeline (deal group) ID |
| `dealGroup` | object | Yes | — | Deal Group |
```json theme={null}
{
"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)",
"enum": [
0,
1
]
},
"allgroups": {
"type": "integer",
"description": "Make pipeline accessible to all groups (0=no, 1=yes)",
"enum": [
0,
1
]
}
}
}
},
"required": [
"PCID",
"id",
"dealGroup"
]
}
```
***
## activecampaign\_update\_list
Update a list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------- |
| `id` | integer | Yes | — | List ID |
| `list` | object | Yes | — | The list value |
```json theme={null}
{
"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"
]
}
```