ActiveCampaign

ActiveCampaign marketing and CRM: contacts, lists, tags, deals and campaigns. Accounts on api-us1.com addresses only.

9 actions API key 6 read3 write Calls api-us1.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "activecampaign" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Add tag to contactwriteactivecampaign.add_tag_to_contactApply an existing tag (by tag ID, from list_tags) to a contact.

Input	Type		Description
`contact_id`	string	Required	Contact ID
`tag_id`	string	Required	Tag ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.add_tag_to_contact",
  input: {
    "contact_id": "<contact_id>",
    "tag_id": "<tag_id>"
  },
});

Create contactwriteactivecampaign.create_contactCreate a contact. It fails if the email address already exists; add tags afterwards with add_tag_to_contact.

Input	Type		Description
`email`	string	Required	Email address
`first_name`	string	Optional	First name
`last_name`	string	Optional	Last name
`phone`	string	Optional	Phone number

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.create_contact",
  input: {
    "email": "<email>"
  },
});

Create dealwriteactivecampaign.create_dealCreate a CRM deal in a pipeline stage. The value is in cents (10000 means 100.00).

Input	Type		Description
`title`	string	Required	Deal title
`value`	integer	Required	Deal value in cents
`currency`	string	Required	Lower-case currency code, e.g. usd
`group`	string	Required	Pipeline ID
`stage`	string	Required	Stage ID in that pipeline
`contact`	string	Optional	Contact ID to attach
`owner`	string	Optional	Owner user ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.create_deal",
  input: {
    "title": "<title>",
    "value": 1,
    "currency": "<currency>",
    "group": "<group>",
    "stage": "<stage>"
  },
});

Get contactreadactivecampaign.get_contactGet one contact by ID.

Input	Type		Description
`contact_id`	string	Required	Contact ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.get_contact",
  input: {
    "contact_id": "<contact_id>"
  },
});

List campaignsreadactivecampaign.list_campaignsList email campaigns with their type, status and send counts.

Input	Type		Description
`limit`	integer	Optional	Campaigns to return (default 20, max 100)
`offset`	integer	Optional	Campaigns to skip

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.list_campaigns",
  input: {},
});

List or search contactsreadactivecampaign.list_contactsList contacts or search them by email, name or phone (search), by exact email, or by list or tag.

Input	Type		Description
`search`	string	Optional	Matches email, first name, last name, phone or account name
`email`	string	Optional	Exact email address
`listid`	integer	Optional	Only contacts on this list
`tagid`	integer	Optional	Only contacts with this tag
`limit`	integer	Optional	Contacts to return (default 20, max 100)
`offset`	integer	Optional	Contacts to skip

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.list_contacts",
  input: {},
});

List dealsreadactivecampaign.list_dealsList CRM deals with their value (in cents), currency, stage, pipeline and owner.

Input	Type		Description
`limit`	integer	Optional	Deals to return (default 20, max 100)
`offset`	integer	Optional	Deals to skip

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.list_deals",
  input: {},
});

List listsreadactivecampaign.list_listsList the mailing lists in the account with their IDs and names.

Input	Type		Description
`limit`	integer	Optional	Lists to return (default 20, max 100)
`offset`	integer	Optional	Lists to skip

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.list_lists",
  input: {},
});

List tagsreadactivecampaign.list_tagsList contact tags, optionally those whose name contains a text. Returns tag IDs to use with add_tag_to_contact.

Input	Type		Description
`search`	string	Optional	Tag name text to match
`limit`	integer	Optional	Tags to return (default 20, max 100)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "activecampaign.list_tags",
  input: {},
});