ActiveCampaign

Usage Instructions

Integrate ActiveCampaign into your workflow. Create and manage contacts, add tags for segmentation, manage CRM deals through the pipeline, retrieve lists, and trigger marketing automations for powerful email marketing and sales automation.

Tools

`activecampaign_get_contacts`

Retrieve contacts from ActiveCampaign with optional search filter

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`email`	string	No	Filter contacts by email address
`search`	string	No	Search contacts by name or email
`limit`	number	No	Maximum number of contacts to return (default 20, max 100)
`offset`	number	No	Number of contacts to skip for pagination

Output

Parameter	Type	Description
`contacts`	json	Array of ActiveCampaign contact objects
`total`	number	Total number of contacts returned

`activecampaign_create_contact`

Create a new contact in ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`email`	string	No	Contact email address
`firstName`	string	No	Contact first name
`lastName`	string	No	Contact last name
`phone`	string	No	Contact phone number
`fieldValues`	json	No	Custom field values as JSON array [{"field": "id", "value": "val"}]

Output

Parameter	Type	Description
`id`	string	ActiveCampaign contact ID
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name

`activecampaign_update_contact`

Update an existing contact in ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`contactId`	string	No	ActiveCampaign contact ID to update
`email`	string	No	Updated email address
`firstName`	string	No	Updated first name
`lastName`	string	No	Updated last name
`phone`	string	No	Updated phone number
`fieldValues`	json	No	Updated custom field values as JSON array

Output

Parameter	Type	Description
`id`	string	ActiveCampaign contact ID
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name

`activecampaign_get_deals`

Retrieve CRM deals from ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`title`	string	No	Filter deals by title
`search`	string	No	Search deals by title
`limit`	number	No	Maximum number of deals to return (default 20, max 100)
`offset`	number	No	Number of deals to skip for pagination

Output

Parameter	Type	Description
`deals`	json	Array of ActiveCampaign deal objects
`total`	number	Total number of deals returned

`activecampaign_create_deal`

Create a new CRM deal in ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`title`	string	No	Deal title
`value`	number	No	Deal value in cents (e.g. 10000 = $100.00)
`currency`	string	No	Currency code (e.g. USD, EUR)
`contactId`	string	No	ID of the contact associated with this deal
`groupId`	string	No	CRM pipeline group ID
`ownerId`	string	No	ID of the deal owner (user)
`stageId`	string	No	Pipeline stage ID
`status`	string	No	Deal status: "open", "won", or "lost"

Output

Parameter	Type	Description
`id`	string	ActiveCampaign deal ID
`title`	string	Deal title
`value`	number	Deal value in cents
`status`	string	Deal status (open/won/lost)

`activecampaign_add_tag`

Add a tag to a contact in ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`contactId`	string	No	Contact ID to add the tag to
`tagId`	string	No	Tag ID to add to the contact

Output

Parameter	Type	Description
`success`	boolean	Whether the tag was added successfully
`contactId`	string	Contact ID
`tagId`	string	Tag ID that was added

`activecampaign_get_lists`

Retrieve all contact lists in ActiveCampaign

Input

Parameter	Type	Required	Description
`apiKey`	string	No	ActiveCampaign API key
`accountUrl`	string	No	ActiveCampaign account URL (e.g. https://myaccount.api-us1.com\)
`limit`	number	No	Maximum number of lists to return

Output

Parameter	Type	Description
`lists`	json	Array of ActiveCampaign list objects
`total`	number	Total number of lists returned

ActiveCampaign

本页内容