🟢 READ-ONLY · Ecom Orders · GET /ecomOrders

List all orders

Fetches data. Makes no changes to your ActiveCampaign account.

List all existing e-commerce order resources.

🟡 WRITE · creates data · Ecom Orders · POST /ecomOrders

Create an order

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new e-commerce order resource.

🟢 READ-ONLY · Webhooks · GET /webhooks

List all webhooks

Fetches data. Makes no changes to your ActiveCampaign account.

List all existing webhooks

🟡 WRITE · creates data · Webhooks · POST /webhooks

Create a webhook

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new webhook

🟢 READ-ONLY · Ecom Orders · GET /ecomOrders/{ecomOrderId}

Retrieve an order

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing e-commerce order resource.

🔴 DESTRUCTIVE · deletes data · Ecom Orders · DELETE /ecomOrders/{ecomOrderId}

Delete an order

Deletes a record. Confirm with the user before calling.

Delete an existing e-commerce order resource.

🟢 READ-ONLY · Connections · GET /connections/{id}

Retrieve a connection

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing connection resource.

🟡 WRITE · updates data · Connections · PUT /connections/{id}

Update a connection

Modifies an existing record in place. Idempotent.

Update an existing connection resource.

🔴 DESTRUCTIVE · deletes data · Connections · DELETE /connections/{id}

Delete a connection

Deletes a record. Confirm with the user before calling.

Delete an existing connection resource.

🟢 READ-ONLY · Ecom Customers · GET /ecomCustomers/{id}

Retrieve a customer

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing e-commerce customer resource.

🟡 WRITE · updates data · Ecom Customers · PUT /ecomCustomers/{id}

Update a customer

Modifies an existing record in place. Idempotent.

Update an existing e-commerce customer resource.

🔴 DESTRUCTIVE · deletes data · Ecom Customers · DELETE /ecomCustomers/{id}

Delete a customer

Deletes a record. Confirm with the user before calling.

Delete an existing e-commerce customer resource.

🟢 READ-ONLY · Ecom Customers · GET /ecomCustomers

List all customers

Fetches data. Makes no changes to your ActiveCampaign account.

List all e-commerce customer resources.

🟡 WRITE · creates data · Ecom Customers · POST /ecomCustomers

Create a customer

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new e-commerce customer resource.

🟢 READ-ONLY · Webhooks · GET /webhook/events

List all webhook events

Fetches data. Makes no changes to your ActiveCampaign account.

List all available webhook events

🟢 READ-ONLY · Webhooks · GET /webhooks/{id}

Retrieve a webhook

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing webhook

🟡 WRITE · updates data · Webhooks · PUT /webhooks/{id}

Update a webhook

Modifies an existing record in place. Idempotent.

Update an existing webhook

🔴 DESTRUCTIVE · deletes data · Webhooks · DELETE /webhooks/{id}

Delete a webhook

Deletes a record. Confirm with the user before calling.

Delete an existing webhook

🟢 READ-ONLY · Connections · GET /connections

List all connections

Fetches data. Makes no changes to your ActiveCampaign account.

List all existing connection resources.

🟡 WRITE · creates data · Connections · POST /connections

Create a connection

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new connection resource.

🟢 READ-ONLY · Brandings · GET /brandings/{id}

Retrieve a branding

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing branding resource

🟡 WRITE · updates data · Brandings · PUT /brandings/{id}

Update a branding

Modifies an existing record in place. Idempotent.

Update an existing branding resource

🟢 READ-ONLY · Brandings · GET /brandings

List all brandings

Fetches data. Makes no changes to your ActiveCampaign account.

List all existing branding resources

🟢 READ-ONLY · Users · GET /users

List all users

Fetches data. Makes no changes to your ActiveCampaign account.

List all existing users

🟡 WRITE · creates data · Users · POST /users

Create a user

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new user

🟢 READ-ONLY · Users · GET /users/{id}

Retrieve a user

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing user

🟡 WRITE · updates data · Users · PUT /users/{id}

Update a user

Modifies an existing record in place. Idempotent.

Update an existing user

🔴 DESTRUCTIVE · deletes data · Users · DELETE /users/{id}

Delete a user

Deletes a record. Confirm with the user before calling.

Delete an existing user

🟢 READ-ONLY · Users · GET /users/email/{email}

Retrieve a user by email

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing user by looking up their email address

🟢 READ-ONLY · Users · GET /users/username/{username}

Retrieve a user by username

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing user by looking up their username

🟢 READ-ONLY · Users · GET /users/me

Retrieve logged-in user

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve the logged-in user

🟢 READ-ONLY · Deal Tasks · GET /dealTasks

List all tasks

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve a list of existing tasks

🟡 WRITE · creates data · Deal Tasks · POST /dealTasks

Create a task

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new task

🟢 READ-ONLY · Deal Tasks · GET /dealTasks/{id}

Retrieve a task

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing task

🟡 WRITE · updates data · Deal Tasks · PUT /dealTasks/{id}

Update a task

Modifies an existing record in place. Idempotent.

Update an existing task

🔴 DESTRUCTIVE · deletes data · Deal Tasks · DELETE /dealTasks/{id}

Delete a task

Deletes a record. Confirm with the user before calling.

Delete an existing task

🟢 READ-ONLY · Deals · GET /deals/{id}

Retrieve a deal

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing deal

🟡 WRITE · updates data · Deals · PUT /deals/{id}

Update a deal

Modifies an existing record in place. Idempotent.

Update an existing deal

🔴 DESTRUCTIVE · deletes data · Deals · DELETE /deals/{id}

Delete a deal

Deletes a record. Confirm with the user before calling.

Delete an existing deal

🟢 READ-ONLY · Deals · GET /deals

List all deals

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing deals

🟡 WRITE · creates data · Deals · POST /deals

Create a deal

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new deal

🟢 READ-ONLY · Deal Stages · GET /dealStages

List all stages

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing stages

🟡 WRITE · creates data · Deal Stages · POST /dealStages

Create a stage

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new stage for a pipeline

🟢 READ-ONLY · Deal Groups · GET /dealGroups/{id}

Retrieve a pipeline

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing pipeline

🟡 WRITE · updates data · Deal Groups · PUT /dealGroups/{id}

Update a pipeline

Modifies an existing record in place. Idempotent.

Update an existing pipeline

🔴 DESTRUCTIVE · deletes data · Deal Groups · DELETE /dealGroups/{id}

Delete a pipeline

Deletes a record. Confirm with the user before calling.

Delete an existing pipeline

🟢 READ-ONLY · Deal Groups · GET /dealGroups

List all pipelines

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing pipelines

🟡 WRITE · creates data · Deal Groups · POST /dealGroups

Create a pipeline

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new pipeline

🟢 READ-ONLY · Deal Stages · GET /dealStages/{id}

Retrieve a stage

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing stage

🟡 WRITE · updates data · Deal Stages · PUT /dealStages/{id}

Update a stage

Modifies an existing record in place. Idempotent.

Update an existing stage

🔴 DESTRUCTIVE · deletes data · Deal Stages · DELETE /dealStages/{id}

Delete a stage

Deletes a record. Confirm with the user before calling.

Delete an existing stage

🟢 READ-ONLY · Deal Tasktypes · GET /dealTasktypes

List all task types

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing task types

🟡 WRITE · creates data · Deal Tasktypes · POST /dealTasktypes

Create a task type

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new task type

🟢 READ-ONLY · Deal Tasktypes · GET /dealTasktypes/{id}

Retrieve a task type

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing task type

🟡 WRITE · updates data · Deal Tasktypes · PUT /dealTasktypes/{id}

Update a task type

Modifies an existing record in place. Idempotent.

Update an existing task type

🔴 DESTRUCTIVE · deletes data · Deal Tasktypes · DELETE /dealTasktypes/{id}

Delete a task type

Deletes a record. Confirm with the user before calling.

Delete an existing task type

🟢 READ-ONLY · Event Tracking Events · GET /eventTrackingEvents

List all events (names only)

Fetches data. Makes no changes to your ActiveCampaign account.

List the names of tracked events

🟡 WRITE · creates data · Event Tracking Events · POST /eventTrackingEvents

Create a new event (name only)

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new event tracking event (name only)

🟢 READ-ONLY · Event Tracking · GET /eventTracking

Retrieve Event Tracking Status

Fetches data. Makes no changes to your ActiveCampaign account.

Get event tracking status (enabled or disabled)

🟡 WRITE · updates data · Event Tracking · PUT /eventTracking

Enable/disable

Modifies an existing record in place. Idempotent.

Enable or disable event tracking

🟢 READ-ONLY · Contacts · GET /contacts

List, search, and filter contacts

Fetches data. Makes no changes to your ActiveCampaign account.

Use this API endpoint to list all contacts, search contacts, or filter contacts by many criteria. For example, search for specific contacts by email, list, account.

🟡 WRITE · creates data · Contacts · POST /contacts

Create a contact

Creates a new record. Not idempotent — calling twice may create duplicates.

🔴 DESTRUCTIVE · deletes data · Event Tracking Events · DELETE /eventTrackingEvents/{eventName}

Delete event (name only)

Deletes a record. Confirm with the user before calling.

Remove an existing event tracking event (name only)

🟢 READ-ONLY · Site Tracking · GET /siteTracking

Retrieve status

Fetches data. Makes no changes to your ActiveCampaign account.

Get site tracking status (enabled or disabled)

🟡 WRITE · updates data · Site Tracking · PUT /siteTracking

Enable/disable

Modifies an existing record in place. Idempotent.

Enable or disable site tracking

🟢 READ-ONLY · Site Tracking Domains · GET /siteTrackingDomains

List all whitelisted domains

Fetches data. Makes no changes to your ActiveCampaign account.

List of all whitelisted site tracking domains

🟡 WRITE · creates data · Site Tracking Domains · POST /siteTrackingDomains

Add domain to whitelist

Creates a new record. Not idempotent — calling twice may create duplicates.

Add a domain to the site tracking whitelist

🔴 DESTRUCTIVE · deletes data · Site Tracking Domains · DELETE /siteTrackingDomains/{name}

Remove domain from whitelist

Deletes a record. Confirm with the user before calling.

Remove a domain from the site tracking whitelist

🟡 WRITE · updates data · Deal Stages · PUT /dealStages/{id}/deals

Move deals to another stage

Modifies an existing record in place. Idempotent.

Move all deals in one stage to another stage

🟡 WRITE · creates data · Deals · POST /deals/{id}/notes

Create a deal note

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new note for a deal

🟡 WRITE · updates data · Deals · PUT /deals/{id}/notes/{noteId}

Update a deal note

Modifies an existing record in place. Idempotent.

Update an existing note for a deal

🟡 WRITE · updates data · Deal Tasktypes · PUT /dealTasktypes/{id}/dealTasks

Move tasks to another task type

Modifies an existing record in place. Idempotent.

Move tasks to a different task type

🟡 WRITE · links records · Contact Tags · POST /contactTags

Add a tag to contact

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

Create a contact tag object

🟡 WRITE · unlinks records · Contact Tags · DELETE /contactTags/{id}

Remove a tag from a contact

Removes an association between records (e.g. untags a contact, removes it from a list/automation). Reversible — it does not delete the underlying records.

Delete a contact tag object

🟢 READ-ONLY · Contacts · GET /contacts/{id}

Retrieve a contact

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing contact

🟡 WRITE · updates data · Contacts · PUT /contacts/{id}

Update a contact

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Contacts · DELETE /contacts/{id}

Delete a contact

Deletes a record. Confirm with the user before calling.

Delete an existing contact

🟢 READ-ONLY · Site Tracking · GET /siteTracking/code

Retrieve site tracking code

Fetches data. Makes no changes to your ActiveCampaign account.

Get site tracking code

🟢 READ-ONLY · Email Activities · GET /emailActivities

List all email activities

Fetches data. Makes no changes to your ActiveCampaign account.

🔴 DESTRUCTIVE · deletes data · Address Lists · DELETE /addressLists/{id}

Delete address associated with a specific list

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Campaigns · GET /campaigns

List all campaigns

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactAutomations

List all automations the contact is in

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contact Automations · GET /contactAutomations/{id}

Retrieve an automation a contact is in

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · unlinks records · Contact Automations · DELETE /contactAutomations/{id}

Remove a contact from an automation

Removes an association between records (e.g. untags a contact, removes it from a list/automation). Reversible — it does not delete the underlying records.

🟢 READ-ONLY · Automations · GET /automations

List all automations

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Addresses · GET /addresses

List all addresses

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Addresses · POST /addresses

Create an address

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Campaigns · GET /campaigns/{id}/links

Retrieve links associated to campaign

Fetches data. Makes no changes to your ActiveCampaign account.

🔴 DESTRUCTIVE · deletes data · Address Groups · DELETE /addressGroups/{id}

Delete address associated with a specific user group

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Contact Automations · GET /contactAutomations

List all automations a contact is in

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · links records · Contact Automations · POST /contactAutomations

Add a contact to an automation

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

🟢 READ-ONLY · Addresses · GET /addresses/{id}

Retrieve an address

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Addresses · PUT /addresses/{id}

Update an address

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Addresses · DELETE /addresses/{id}

Delete an address

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Notes · GET /notes

Retrieve list of all notes

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Notes · POST /notes

Create a note

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Notes · GET /notes/{id}

Retrieve a note

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Notes · PUT /notes/{id}

Update a note

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Notes · DELETE /notes/{id}

Delete a note

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Segments · GET /segments

List all segments

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Templates · GET /templates/{id}

Retrieve a template

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Groups · GET /groups/{id}

Retrieve a group

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Groups · PUT /groups/{id}

Update a group

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Groups · DELETE /groups/{id}

Delete a group

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Messages · GET /messages

List all messages

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Messages · POST /messages

Create a message

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Groups · GET /groups

List all groups

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Groups · POST /groups

Create a group

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Messages · GET /messages/{id}

Retrieve a message

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Messages · PUT /messages/{id}

Update a message

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Messages · DELETE /messages/{id}

Delete a message

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Forms · GET /forms

List all forms

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Forms · GET /forms/{id}

Retrieve a form

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Lists · GET /lists

Retrieve all lists

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Lists · POST /lists

Create a list

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Field Values · GET /fieldValues/{id}

Retrieve a custom field value

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Field Values · PUT /fieldValues/{id}

Update a custom field value for contact

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Field Values · DELETE /fieldValues/{id}

Delete a custom field value

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Lists · GET /lists/{id}

Retrieve a list

Fetches data. Makes no changes to your ActiveCampaign account.

🔴 DESTRUCTIVE · deletes data · Lists · DELETE /lists/{id}

Delete a list

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Tags · GET /tags

List all tags

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Tags · POST /tags

Create a tag

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · updates data · Configs · PUT /configs/{id}

Update settings

Modifies an existing record in place. Idempotent.

🟢 READ-ONLY · Field Values · GET /fieldValues

List all custom field values

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Field Values · POST /fieldValues

Create a custom field value

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Fields · GET /fields/{id}

Get a custom field by ID

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Fields · PUT /fields/{id}

Update a custom field

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Fields · DELETE /fields/{id}

Delete a custom field

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Fields · GET /fields

List all custom fields

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Fields · POST /fields

Create a custom field

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Tags · GET /tags/{id}

Retrieve a tag

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Tags · PUT /tags/{id}

Update a tag

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Tags · DELETE /tags/{id}

Delete a Tag

Deletes a record. Confirm with the user before calling.

🟡 WRITE · links records · Contact Lists · POST /contactLists

Update list status for a contact

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

Subscribe a contact to a list or unsubscribe a contact from a list.

🟢 READ-ONLY · Deal Custom Field Data · GET /dealCustomFieldData/{id}

Retrieve a custom field value

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Deal Custom Field Data · PUT /dealCustomFieldData/{id}

Update a custom field value

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Deal Custom Field Data · DELETE /dealCustomFieldData/{id}

Delete a custom field value

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Deal Custom Field Meta · GET /dealCustomFieldMeta

List all custom fields

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Deal Custom Field Meta · POST /dealCustomFieldMeta

Create a custom field meta

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Deal Custom Field Meta · GET /dealCustomFieldMeta/{id}

Retrieve a custom field

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Deal Custom Field Meta · PUT /dealCustomFieldMeta/{id}

Update a custom field

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Deal Custom Field Meta · DELETE /dealCustomFieldMeta/{id}

Delete a custom field

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Deal Custom Field Data · GET /dealCustomFieldData

List all custom field values

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Deal Custom Field Data · POST /dealCustomFieldData

Create a custom field value

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Saved Responses · GET /savedResponses

List all saved responses

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Saved Responses · POST /savedResponses

Create a saved response

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Calendars · GET /calendars

List all calendar feeds

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Calendars · POST /calendars

Create a calendar feed

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Calendars · GET /calendars/{id}

Retrieve a calendar feed

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Calendars · PUT /calendars/{id}

Update a calendar feed

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Calendars · DELETE /calendars/{id}

Delete a calendar feed

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Saved Responses · GET /savedResponses/{id}

Retrieve a saved response

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Saved Responses · PUT /savedResponses/{id}

Update a saved response

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Saved Responses · DELETE /savedResponses/{id}

Delete a saved response

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Segments · GET /segments/{id}

Retrieve a segment

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Scores · GET /scores

List all scores

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Campaigns · GET /campaigns/{id}

Retrieve a campaign

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Scores · GET /scores/{id}

Retrieve a score

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · List Groups · POST /listGroups

Create a list group permission

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · links records · Field Rels · POST /fieldRels

Create a custom field relationship to list(s)

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/scoreValues

Retrieve a contact's score value

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contact Deals · GET /contactDeals

List all secondary contacts

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all secondary contacts

🟡 WRITE · creates data · Contact Deals · POST /contactDeals

Create a secondary contact

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new secondary contact for a deal

🟢 READ-ONLY · Contact Deals · GET /contactDeals/{id}

Retrieve a secondary contact

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing secondary contact

🟡 WRITE · updates data · Contact Deals · PUT /contactDeals/{id}

Update a secondary contact

Modifies an existing record in place. Idempotent.

Update an existing secondary contact

🔴 DESTRUCTIVE · deletes data · Contact Deals · DELETE /contactDeals/{id}

Delete a secondary contact

Deletes a record. Confirm with the user before calling.

Delete an existing secondary contact

🟡 WRITE · creates data · Field Values · POST /fieldOption/bulk

Create custom field options

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · creates data · Deal Custom Field Data · POST /dealCustomFieldData/bulkCreate

Bulk create a custom deal field value

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · updates data · Deal Custom Field Data · PATCH /dealCustomFieldData/bulkUpdate

Bulk update a custom field value

Modifies an existing record in place. Idempotent.

🟢 READ-ONLY · Accounts · GET /accounts

List all accounts

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing account

🟡 WRITE · creates data · Accounts · POST /accounts

Create an account

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new account

🟢 READ-ONLY · Account Custom Field Data · GET /accountCustomFieldData

List all custom field values

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Account Custom Field Data · POST /accountCustomFieldData

Create a custom field value

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Account Custom Field Meta · GET /accountCustomFieldMeta/{id}

Retrieve a custom field

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Account Custom Field Meta · PUT /accountCustomFieldMeta/{id}

Update a custom field

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Account Custom Field Meta · DELETE /accountCustomFieldMeta/{id}

Delete a custom field

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Account Custom Field Data · GET /accountCustomFieldData/{id}

Retrieve a custom field value

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Account Custom Field Data · PUT /accountCustomFieldData/{id}

Update a custom field value

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Account Custom Field Data · DELETE /accountCustomFieldData/{id}

Delete a custom field value

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Accounts · GET /accounts/{id}

Retrieve an account

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing account

🟡 WRITE · updates data · Accounts · PUT /accounts/{id}

Update an account

Modifies an existing record in place. Idempotent.

Update an existing account

🔴 DESTRUCTIVE · deletes data · Accounts · DELETE /accounts/{id}

Delete an account

Deletes a record. Confirm with the user before calling.

Delete an existing account

🟡 WRITE · creates data · Account Custom Field Data · POST /accountCustomFieldData/bulkCreate

Bulk create a custom account field value

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · updates data · Account Custom Field Data · PATCH /accountCustomFieldData/bulkUpdate

Bulk update a custom field value

Modifies an existing record in place. Idempotent.

🟢 READ-ONLY · Account Custom Field Meta · GET /accountCustomFieldMeta

List all custom fields

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Account Custom Field Meta · POST /accountCustomFieldMeta

Create a custom field

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · creates data · Accounts · POST /accounts/{id}/notes

Create an account note

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new note for an account

🟡 WRITE · updates data · Accounts · PUT /accounts/{id}/notes/{noteid}

Update an account note

Modifies an existing record in place. Idempotent.

Update an existing note for a account

🔴 DESTRUCTIVE · bulk delete · Accounts · DELETE /accounts/bulk_delete

Bulk delete accounts

Deletes many records in a single call. High blast radius — always confirm before calling.

Delete an existing account

🟢 READ-ONLY · Account Contacts · GET /accountContacts

List all associations

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing account association

🟡 WRITE · links records · Account Contacts · POST /accountContacts

Create an association

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

Create a new account association

🟢 READ-ONLY · Account Contacts · GET /accountContacts/{id}

Retrieve an association

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing account association

🟡 WRITE · updates data · Account Contacts · PUT /accountContacts/{id}

Update an association

Modifies an existing record in place. Idempotent.

Update an existing account association

🟡 WRITE · unlinks records · Account Contacts · DELETE /accountContacts/{id}

Delete an association

Removes an association between records (e.g. untags a contact, removes it from a list/automation). Reversible — it does not delete the underlying records.

Delete an existing account association

🟢 READ-ONLY · Ecom Order Products · GET /ecomOrderProducts

List EcomOrderProducts

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Ecom Orders · GET /ecomOrders/{id}/orderProducts

List EcomOrderProducts for a Specific EcomOrder

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Ecom Order Products · GET /ecomOrderProducts/{id}

Retrieve an EcomOrderProduct

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Ecom Orders · PUT /ecomOrders/{id}

Update an order

Modifies an existing record in place. Idempotent.

Update an existing ecommerce order/cart resource.

🟡 WRITE · creates or updates · Contacts · POST /contact/sync

Sync a contact's data

Creates the record if it is new, otherwise updates the existing one (an upsert). Idempotent.

🟢 READ-ONLY · Import · GET /import/bulk_import

Bulk import status list

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Import · POST /import/bulk_import

Bulk import contacts

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Activities · GET /activities

List a contact's activities

Fetches data. Makes no changes to your ActiveCampaign account.

View your contact's recent activity. The activity is generated when a contact is retrieved via /api/3/contacts/[contactID]. This endpoint should be used after retrieving a contact to obtain the latest data. This is useful for searching for contacts that match certain criteria - such as being part of a certain list, or having a specific custom field value.

🟢 READ-ONLY · Custom Objects · GET /customObjects/schemas

List all schemas

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all schemas available within an account.

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

🟡 WRITE · creates data · Custom Objects · POST /customObjects/schemas

Create a schema

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Custom Objects · GET /customObjects/schemas/{id}

Retrieve a schema

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve a specific schema by id.

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

🔴 DESTRUCTIVE · deletes data · Custom Objects · DELETE /customObjects/schemas/{id}

Delete a schema

Deletes a record. Confirm with the user before calling.

🟡 WRITE · updates data · Custom Objects · PUT /customObjects/schemas/{schemaId}

Update a schema

Modifies an existing record in place. Idempotent.

Make an update to a given schema.

To delete a schema field, reference the field delete endpoint: https://developers.activecampaign.com/reference/delete-a-field-1

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

🟢 READ-ONLY · Custom Objects · GET /customObjects/records/{schemaId}

List records by schema

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Custom Objects · POST /customObjects/records/{schemaId}

Create or update record

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Custom Objects · GET /customObjects/records/{schemaId}/{recordId}

Get a record by id

Fetches data. Makes no changes to your ActiveCampaign account.

🔴 DESTRUCTIVE · deletes data · Custom Objects · DELETE /customObjects/records/{schemaId}/{recordId}

Delete a record by id

Deletes a record. Confirm with the user before calling.

🔴 DESTRUCTIVE · deletes data · Custom Objects · DELETE /customObjects/records/{schemaId}/external/{externalId}

Delete a record by external ID

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Deal Roles · GET /dealRoles

List all deal roles

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Deal Roles · POST /dealRoles

Create a deal role

Creates a new record. Not idempotent — calling twice may create duplicates.

🔴 DESTRUCTIVE · deletes data · Deal Roles · DELETE /dealRoles/{id}

Delete a deal role

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Records · GET /records/{schemdId}/external/{externalId}

Get a record by external id

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Task Outcomes · GET /taskOutcomes

List all task outcomes

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing task outcomes

🟡 WRITE · creates data · Task Outcomes · POST /taskOutcomes

Create a task outcome

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new task outcome

🟢 READ-ONLY · Task Outcomes · GET /taskOutcomes/{id}

Retrieve a task outcome

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing task outcome

🟡 WRITE · updates data · Task Outcomes · PUT /taskOutccomes/{id}

Update a task outcome

Modifies an existing record in place. Idempotent.

Update an existing task outcome

🔴 DESTRUCTIVE · deletes data · Task Outcomes · DELETE /taskOutccomes/{id}

Delete a task outcome

Deletes a record. Confirm with the user before calling.

Delete an existing task outcome

🟢 READ-ONLY · Tasktype Outcome Rels · GET /tasktypeOutcomeRels

List all task type - outcome relations

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve all existing task type - outcome relations

🟡 WRITE · creates data · Tasktype Outcome Rels · POST /tasktypeOutcomeRels

WIP Create a task type - outcome relation

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new task type

🟢 READ-ONLY · Tasktype Outcome Rels · GET /tasktypeOutcomeRels/{id}

Retrieve a task type - outcome relation

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an existing task type - outcome relation

🟡 WRITE · updates data · Tasktype Outcome Rels · PUT /tasktypeOutcomeRels/{id}

WIP Update a task type - outcome relation

Modifies an existing record in place. Idempotent.

Update an existing task type

🔴 DESTRUCTIVE · deletes data · Tasktype Outcome Rels · DELETE /tasktypeOutcomeRels/{id}

Delete a task type - outcome relation

Deletes a record. Confirm with the user before calling.

Delete an existing task type - outcome relation

🟡 WRITE · creates data · Custom Objects · POST /customObjects/schemas/public

Create a public schema

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · creates data · Custom Objects · POST /customObjects/schemas/{id}/child

Create a child schema

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Import · GET /import/info

Bulk import status info

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Deals · PATCH /deals/bulkUpdate

Bulk Update Deal Owners

Modifies an existing record in place. Idempotent.

Update an existing deal

🟢 READ-ONLY · Deal Groups · GET /dealGroup/get_inaccessible_deal_groups

Retrieve inaccessible pipelines by user

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve pipelines that given user doesn't have access to

🟢 READ-ONLY · Contacts · GET /contacts/{id}/bounceLogs

Retrieve a contact's bounce logs

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactData

Retrieve a contact's data

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactGoals

Retrieve a contact's goals

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactLists

Retrieve a contact's list memberships

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactLogs

Retrieve a contact's logs

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/contactDeals

Retrieve a list of contact's deals

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/deals

Retrieve a contact's deals

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/fieldValues

Retrieve a contact's field values

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/geoIps

Retrieve a contacts list of geo-ips

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/notes

Retrieve a contacts notes

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/organization

Retrieve a contacts organization

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/plusAppend

Retrieve a contacts plus append

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/trackingLogs

Retrieve a contacts tracking logs

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/accountContacts

Retrieve a contacts account contacts

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/automationEntryCounts

Retrieve a contacts automation entry counts

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Group Limits · GET /groupLimits

List All Group Limits

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Localevent · POST /localevent

Local Events

Creates a new record. Not idempotent — calling twice may create duplicates.

Published by TrackCmp. Creates an em_local_event row in production database.

🟡 WRITE · unlinks records · Field Rels · DELETE /fieldRels/{fieldRelId}

Delete a custom field relationship to list(s)

Removes an association between records (e.g. untags a contact, removes it from a list/automation). Reversible — it does not delete the underlying records.

🟡 WRITE · creates data · Task Notifications · POST /taskNotifications

Create a task reminder

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a new task reminder

🔴 DESTRUCTIVE · deletes data · Custom Objects · DELETE /customObjects/schemas/{schemaId}/fields/{fieldId}

Delete a field

Deletes a record. Confirm with the user before calling.

Deleting a schema field is an irreversible process.

Assuming a valid 202 Accepted response is received, any associated field data on associated records will immediately be unavailable to the user. There may be a small delay if record requests are in the midst of processing when the field delete request is issued.

The deleted field id will not be immediately recycled for reuse. Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema f…

🟢 READ-ONLY · Contacts · GET /contacts/{contactId}/trackingLogs

Get Contact's Tracking Logs/Events

Fetches data. Makes no changes to your ActiveCampaign account.

Get a log of events for a Contact

🟢 READ-ONLY · Tracking Logs · GET /trackingLogs/{eventId}/contact

Get Contact By Event ID

Fetches data. Makes no changes to your ActiveCampaign account.

Get the contact that was involved in an event.

🟢 READ-ONLY · Deal Activities · GET /dealActivities

List all deal activities

Fetches data. Makes no changes to your ActiveCampaign account.

View a recent activity for Deals. A specific deal's activity can also be viewed using /api/3/deals/[dealID]/dealActivities.

🟢 READ-ONLY · Group Members · GET /groupMembers

Get All Custom Field Groups

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · links records · Group Members · POST /groupMembers

Add Custom Field to Field Group

Creates an association between records (e.g. tags a contact, adds a contact to a list/automation). Reversible.

🟢 READ-ONLY · Group Members · GET /groupMembers/{groupID}

Get Custom Field Group by ID

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · unlinks records · Group Members · DELETE /groupMembers/{groupID}

Delete Custom Field Field Group

Removes an association between records (e.g. untags a contact, removes it from a list/automation). Reversible — it does not delete the underlying records.

🟡 WRITE · updates data · Group Members · PUT /groupMembers/{groupId}

Update Custom Field Field Group

Modifies an existing record in place. Idempotent.

🟢 READ-ONLY · Geo Ips · GET /geoIps/{geoAddressID}/geoAddress

Retrieve a contacts geo IP address

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Personalizations · GET /personalizations

List Variables

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve a list of personalization variables

🟡 WRITE · creates data · Personalizations · POST /personalizations

Create a Variable

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a personalization variable

🟢 READ-ONLY · Personalizations · GET /personalizations/{variableID}

Retrieve a Variable

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve an individual personalization variable

🟡 WRITE · updates data · Personalizations · PUT /personalizations/{variableID}

Edit a Variable

Modifies an existing record in place. Idempotent.

Edit a personalization variable

🔴 DESTRUCTIVE · deletes data · Personalizations · DELETE /personalizations/{variableID}

Delete a Variable

Deletes a record. Confirm with the user before calling.

Delete a personalization variable

🔴 DESTRUCTIVE · bulk delete · Personalizations · DELETE /personalizations/bulkdelete

Bulk Delete Variables

Deletes many records in a single call. High blast radius — always confirm before calling.

Bulk delete personalization variables

🟡 WRITE · updates data · Campaigns · PUT /campaigns/{id}/edit

Edit campaign

Modifies an existing record in place. Idempotent.

🟡 WRITE · creates data · Campaigns · POST /campaign

Create Campaign

Creates a new record. Not idempotent — calling twice may create duplicates.

🟡 WRITE · creates data · Campaigns · POST /campaigns/{id}/copy

Duplicate Campaign

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Lists · GET /lists/exclusions/{id}

Retrieve an exclusion

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Lists · PUT /lists/exclusions/{id}

Update an exclusion

Modifies an existing record in place. Idempotent.

🟢 READ-ONLY · Lists · GET /lists/exclusions

Retrieve exclusions list

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · creates data · Group Definitions · POST /groupDefinitions

Create a Custom Field Group

Creates a new record. Not idempotent — calling twice may create duplicates.

🟢 READ-ONLY · Stripo · GET /stripo/personalizationTags

Personalization Tags

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Stripo · GET /stripo/config

Stripo config

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Content · GET /content/editorMarkup/{messageId}

Get Editor Markup

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Sms · GET /sms/credits

Get current sms credit use data

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve the current period's sms credit usage and remaining balance

🟢 READ-ONLY · Sms · GET /sms/broadcasts

Get all broadcast messages

Fetches data. Makes no changes to your ActiveCampaign account.

Gets a paged list of all of a customer's broadcast messages with optional filtering

🟡 WRITE · sends messages · Sms · POST /sms/broadcasts

Create a new broadcast message

Sends or schedules an outbound message (SMS / WhatsApp) to real recipients. Not reversible once delivered — confirm the audience first.

Creates a new SMS broadcast message

🟢 READ-ONLY · Sms · GET /sms/broadcasts/{id}

Get broadcast message

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieves the full details for one broadcast message

🟡 WRITE · updates data · Sms · PUT /sms/broadcasts/{id}

Update broadcast message

Modifies an existing record in place. Idempotent.

Updates an existing broadcast message

🔴 DESTRUCTIVE · deletes data · Sms · DELETE /sms/broadcasts/{id}

Delete broadcast message

Deletes a record. Confirm with the user before calling.

Performs a soft-delete on the requested message

🟢 READ-ONLY · Sms · GET /sms/lists

Get all broadcast lists

Fetches data. Makes no changes to your ActiveCampaign account.

Gets a paged list of all broadcast lists (SMS channel)

🟡 WRITE · sends messages · Sms · POST /sms/broadcasts/ai

Create AI-generated broadcast

Sends or schedules an outbound message (SMS / WhatsApp) to real recipients. Not reversible once delivered — confirm the audience first.

Creates a broadcast using AI based on prompt and tone

🟡 WRITE · updates data · Sms · PUT /sms/broadcasts/ai

Update broadcast with AI

Modifies an existing record in place. Idempotent.

Updates an existing broadcast using AI

🟢 READ-ONLY · Sms · GET /sms/broadcasts/ai/{Id}

Get AI broadcast request status

Fetches data. Makes no changes to your ActiveCampaign account.

Returns the current status of the AI process execution

🟢 READ-ONLY · query · Sms · POST /sms/broadcasts/metrics

Get all broadcast metrics

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

Returns metrics for specified broadcast IDs

🟢 READ-ONLY · Sms · GET /sms/broadcasts/metrics/snapshot

Get broadcast snapshot

Fetches data. Makes no changes to your ActiveCampaign account.

Returns snapshot data for all broadcasts

🟢 READ-ONLY · query · Sms · POST /sms/broadcasts/metrics/snapshot

Get broadcast snapshot

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

Returns snapshot for specified broadcast IDs

🟢 READ-ONLY · Sms · GET /sms/broadcasts/metrics/{broadcastId}/failures

Get broadcast failure details

Fetches data. Makes no changes to your ActiveCampaign account.

Returns grouping and counts of failures for the broadcast

🟢 READ-ONLY · Sms · GET /sms/broadcasts/{broadcastId}/recipients

Get broadcast recipients

Fetches data. Makes no changes to your ActiveCampaign account.

Fetch all contacts who were sent a specific broadcast

🟢 READ-ONLY · query · Sms · POST /sms/broadcasts/export

Export broadcast metrics

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

Export broadcast performance metrics as CSV

🟢 READ-ONLY · query · Sms · POST /sms/broadcasts/{broadcastId}/recipients/export

Export broadcast recipients

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

Export recipient data as CSV including full contact records

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/channels/whatsapp/template

List WhatsApp Templates

Fetches data. Makes no changes to your ActiveCampaign account.

Lists WhatsApp Templates. You can search with the name and status fields using the ?seach=my-template-name query parameter.

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/channels/whatsapp/template/{id}

Get WhatsApp Template

Fetches data. Makes no changes to your ActiveCampaign account.

Gets a WhatsApp Template by Id.

🟡 WRITE · updates data · Whatsapp · PUT /channel/whatsapp/channels/whatsapp/template/{id}

Update WhatsApp Template

Modifies an existing record in place. Idempotent.

Update a WhatsApp Template by Id.

🔴 DESTRUCTIVE · deletes data · Whatsapp · DELETE /channel/whatsapp/channels/whatsapp/template/{id}

Delete WhatsApp Template

Deletes a record. Confirm with the user before calling.

Deletes a WhatsApp Template by Id.

🟡 WRITE · sends messages · Whatsapp · POST /channel/whatsapp/channels/whatsapp/template/{id}/send

Send a WhatsApp Template

Sends or schedules an outbound message (SMS / WhatsApp) to real recipients. Not reversible once delivered — confirm the audience first.

Send a single WhatsApp message: select a template to use and call our endpoint with the recipient phone number and the variables the template needs. That's it!

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/flow-execution

List Flow Executions

Fetches data. Makes no changes to your ActiveCampaign account.

Lists Flow Executions.

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/flow-execution-contact

List Flow Execution Contacts

Fetches data. Makes no changes to your ActiveCampaign account.

Lists Flow Execution Contacts.

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/flow-execution-contact/{id}

Get Flow Execution Contact by Id

Fetches data. Makes no changes to your ActiveCampaign account.

Get Flow Execution Contact by Id.

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/flow-execution/{id}

Get Flow Execution

Fetches data. Makes no changes to your ActiveCampaign account.

Get Flow Execution by Id.

🟡 WRITE · creates data · Whatsapp · POST /channel/whatsapp/flow/{id}/run

Create a Flow Execution

Creates a new record. Not idempotent — calling twice may create duplicates.

Create a Flow Execution of a Flow.

🟢 READ-ONLY · Whatsapp · GET /channel/whatsapp/inbox/conversation

List Conversations

Fetches data. Makes no changes to your ActiveCampaign account.

Lists Conversations.

🟡 WRITE · updates data · Whatsapp · PUT /channel/whatsapp/inbox/conversation/{id}/update

Update a conversation

Modifies an existing record in place. Idempotent.

Update a Conversation

🟡 WRITE · updates data · Whatsapp · PATCH /channel/whatsapp/inbox/conversation/{id}/update

Partially Update a Conversation

Modifies an existing record in place. Idempotent.

Partially update a Conversation

🟡 WRITE · creates data · Segments · POST /segmentsV2

Create a Segment

Creates a new record. Not idempotent — calling twice may create duplicates.

The Segment JSON structure is extremely flexible; Only segments that are supported by the segment-builder are guaranteed to work as expected. Specific Condition types only support a subset of FieldDO and AggregateDO options. Please refer to your account's /app/segments/segment-builder page to verify what Segment JSON configurations are possible.

🟢 READ-ONLY · Segments · GET /segmentsV2/{segmentId}

Retrieve a Segment

Fetches data. Makes no changes to your ActiveCampaign account.

🟡 WRITE · updates data · Segments · PUT /segmentsV2/{segmentId}

Update a Segment

Modifies an existing record in place. Idempotent.

🔴 DESTRUCTIVE · deletes data · Segments · DELETE /segmentsV2/{segmentId}

Delete a Segment by SegmentId including its historic versions

Deletes a record. Confirm with the user before calling.

🟢 READ-ONLY · Segments · GET /segmentsV2/{segmentId}/createdDate/{timestamp}

Retrieve a Segment's Historic Definition

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve a Segment as it existed at the given point in time. Only segments with non-numeric SegmentIds are supported

🟡 WRITE · updates data · Segments · PUT /segmentsV2/{segmentId}/createdDate/{timestamp}

Revert a Segment to a Historic Definition

Modifies an existing record in place. Idempotent.

Revert a segment to how it looked at a specific point in time. Only segments with non-numeric SegmentIds are supported

🟢 READ-ONLY · Segments · GET /audiences

List Summaries for Saved Segments

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Segments · GET /audiences/{segmentId}

Retrieve a Saved Segment's Summary

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Segments · GET /segmentMatch/{segmentId}/{contactId}

Create a Match One Request

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · Segments · GET /segmentMatch/{segmentId}/{contactId}/{externalId}

Check to see if a Contact matches a Segment using the given externalId

Fetches data. Makes no changes to your ActiveCampaign account.

🟢 READ-ONLY · query · Segments · POST /api/3/segmentMatchAll

Create a Match All Request for a new Segment

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

Find all Contact Id's that match the given Segment. The provided segment will be saved with a 24 hour TTL. A new match-all request will be initiated. If results are not ready within 4 seconds, a response that lacks a result-set will be returned. Use the returned segmentId and runId to poll and check back later to see if the result-set is ready.

🟢 READ-ONLY · query · Segments · GET /api/3/segmentMatchAll/{segmentId}

Create a Match All Request

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

A new match-all request will be initiated. If results are not ready within 4 seconds, a response that lacks a result-set will be returned and the response's is_ready attribute will be equal to false. Use the returned segmentId and runId to poll and check back later to see if the result-set is ready

🟢 READ-ONLY · Segments · GET /api/3/segmentMatchAll/{segmentId}/{runId}

Return Match All result-set

Fetches data. Makes no changes to your ActiveCampaign account.

If the result-set is not ready yet, the response's is_ready attribute will be equal to false. The match-all request has errored out if the is_ready attribute is false and the run_id_end attribute contains a valid timestamp`; when this occurs please try your request again or alert the support team. If either the RunId or the SegmentId have expired or otherwise do not exist, a 404 with error details will be returned.

result-sets are cached and returned in the same sort order that's requ…

🟢 READ-ONLY · query · Segments · POST /api/3/segmentMatchSome/{segmentId}

Create a Match Some Request

Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.

🟢 READ-ONLY · Segments · GET /api/3/segmentMatchSome/{segmentId}/{runId}

Return a Match Some result-set

Fetches data. Makes no changes to your ActiveCampaign account.

If the result-set is not ready yet, the response's is_ready attribute will be equal to false. The match-all request has errored out if the is_ready attribute is false and the run_id_end attribute contains a valid timestamp`; when this occurs please try your request again or alert the support team. If either the RunId or the SegmentId have expired or otherwise do not exist, a 404 with error details will be returned.

Sorting is not supported for this endpoint. This endpoint can be used to…

🟢 READ-ONLY · Segments · GET /api/3/segmentsV2/count-history

Retrieve the most recent result count for the given segments that were ran without an AdditionalCriteria

Fetches data. Makes no changes to your ActiveCampaign account.

One result per segment will be returned. Pagination not supported. Maximum 100 segmentIds per request. SegmentIds in the request that doesn't exist, will simply be ignored

🟢 READ-ONLY · Segments · GET /api/3/segmentsV2/{segmentId}/count-history

Retrieve all result counts for the given segment that were ran without an AdditionalCriteria

Fetches data. Makes no changes to your ActiveCampaign account.

Up to 50 results will be returned at once. To get the next page, request again with the last result's timestamp formatted as an EPOCH seconds value

🟢 READ-ONLY · Segments · GET /api/3/segmentsV2/{segmentId}/count-history/{timestamp}

Retrieve all result counts for the given segment that were ran without an AdditionalCriteria

Fetches data. Makes no changes to your ActiveCampaign account.

Up to 50 results will be returned at once. To get the next page, request again with the last result's timestamp formatted as an EPOCH seconds value

🟡 WRITE · GraphQL · POST /api/3/ecom/graphql

Run an arbitrary query against ActiveCampaign's Ecommerce GraphQL API and return the JSON result.

A GraphQL document may contain mutations, so treat this as a write. Endpoint: https://your-account.api-us1.com/api/3/ecom/graphql. Prefer the dedicated REST tools for standard CRUD; use this for precise field selection or ecommerce data.