Skip to main content
ActiveCampaign logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 298
  • Triggers: 0
  • Slug: ACTIVE_CAMPAIGN
  • Version: 20261101_00

Tools

Slug: ACTIVE_CAMPAIGN_ADD_BROWSE_SESSION_CARTSet a browse session to have addedToCart flag set to true in ActiveCampaign. This action updates an existing browse session or creates a new one with the addedToCart flag enabled for the specified email and connection. Use this to track when a customer adds items to their shopping cart during their browsing session.

Input Parameters

string
required
Email address to use to find the browse session. This should be the email of the contact whose browse session you want to update. The browse session will be marked as having items added to cart.
integer
required
Integer connection identifier matching the v3 API DeepData Connection ID. This identifies which e-commerce connection to use for the browse session. You can find this ID in your ActiveCampaign DeepData Connections settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CONTACT_NOTEAdd a note to a contact in ActiveCampaign. The note will be associated with a contact as a subscriber type. The tool will first find the contact ID using the provided email address and then create the note.

Input Parameters

string
required
The content of the note to be added. This should be plain text as HTML will be stripped.
string
required
The email address of the contact to associate the note with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CONTACT_TO_AUTOMATIONAdds an existing ActiveCampaign contact to a specific automation workflow. This action enrolls a contact in an automation by their email address. The contact must already exist in ActiveCampaign, and the automation must be created beforehand (automations can only be created through the ActiveCampaign UI, not via API). The action performs two steps: 1. Looks up the contact by email to retrieve their contact ID 2. Enrolls the contact in the specified automation Returns enrollment details including the contact ID, automation ID, status, and timestamps. Note: The automation_id must correspond to an existing, active automation in your ActiveCampaign account. You can find automation IDs through the ActiveCampaign UI or by listing automations via the GET /api/3/automations endpoint.

Input Parameters

string
required
ID of the automation to add the contact to
string
required
Email address of the contact to add to automation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CONTACT_TO_LISTTool to add a contact to a list in ActiveCampaign. Use when you need to subscribe or unsubscribe a contact to/from a specific list using their IDs.

Input Parameters

integer
required
The ID of the list to add the contact to
integer
required
The subscription status. Use 1 for subscribed, 2 for unsubscribed
integer
required
The ID of the contact to add to the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CUSTOM_FIELDTool to add a new custom field in ActiveCampaign. Use when you need to create a custom contact field to store additional information like industry, company size, or other custom data points. Supports various field types including text, dropdown, date, and more.

Input Parameters

integer
Number of columns for textarea field type. Only applicable when type is ‘textarea’.
integer
Number of rows for textarea field type. Only applicable when type is ‘textarea’.
string ("text" | "textarea" | "date" | "datetime" | "dropdown" | "multiselect" | "radio" | "checkbox" | "hidden" | "currency" | "number" | "listbox")
required
The type of the custom field. Determines how the field is displayed and what data it accepts.
integer
Field group ID to organize related fields together
string
required
The display name/title of the custom field
array
List of options for dropdown, multiselect, radio, or checkbox field types. Required when using those field types.
string
Unique personalization tag identifier for the field. Must be unique across all fields. Use uppercase letters, numbers, and underscores only.
integer
Field visibility status. Set to 1 for visible, 0 for hidden.
string
Description of the custom field to help users understand its purpose
integer
Display order number for the field. Lower numbers appear first.
integer
Whether the field is mandatory (1) or optional (0)
integer
Whether to show this field in contact list views (1) or hide it (0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CUSTOM_FIELD_OPTIONSTool to add custom field options in bulk to ActiveCampaign. Use when you need to create multiple options for dropdown, radio, checkbox, or listbox custom fields. The field must already exist before adding options.

Input Parameters

array
required
Array of field option objects to create. Each option must include orderid, value, label, isdefault, and field properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_CUSTOM_FIELD_TO_FIELD_GROUPTool to add a custom field to a field group in ActiveCampaign. Use when you need to associate a custom field with a display group to organize related fields together on contact or deal pages.

Input Parameters

integer
required
The ID of the custom field to add to the group
integer
required
The ID of the field group to add the custom field to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_DOMAIN_TO_WHITE_LISTAdd a domain to ActiveCampaign’s site tracking whitelist. Use this to enable site tracking functionality for specific domains in your ActiveCampaign account. This action registers a domain that is allowed for site tracking. After adding a domain to the whitelist, ActiveCampaign can track visitor activity on that domain for analytics and automation purposes.

Input Parameters

string
required
The domain name to add to the whitelist for site tracking (e.g., example.com, subdomain.example.com). This domain will be allowed for ActiveCampaign site tracking functionality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_FIELD_RELATIONSHIPAdd a field relationship in ActiveCampaign. Use this to associate a custom field with a list or other entity, enabling the field to be used within that context.

Input Parameters

integer
required
The ID of the custom field to associate with a list or entity
integer
required
The ID of the related entity (e.g., list ID) to associate with the custom field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_SECONDARY_CONTACT_TO_DEALAdds a secondary contact to an existing deal in ActiveCampaign, optionally specifying a job title. The contact and deal must both be accessible to the connection, as each is checked before the association is created.

Input Parameters

integer
required
The ID of the deal to add the contact to
string
The job title of the contact at this deal (e.g., ‘Product Manager’, ‘Sales Lead’)
integer
required
The ID of the contact to add as secondary contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACTTool to add a tag to a contact in ActiveCampaign. Use when you need to directly associate a tag with a contact using their IDs. Both contact ID and tag ID must already exist.

Input Parameters

string
required
ID of the tag to add to the contact
string
required
ID of the contact to add the tag to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ACCOUNTCreates a new account in ActiveCampaign. An account represents a business or organization that you want to track in your CRM. Each account must have a unique name. Required: account name Optional: account URL, owner (user ID, defaults to 1), custom fields Note: Account names must be unique. If an account with the same name already exists, the API will return an error.

Input Parameters

string
required
The name of the account
integer
The ID of the user who owns the account. Defaults to user ID 1 if not specified.
array
List of custom fields for the account
string
The URL associated with the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ACCOUNT_CONTACTSTool to create a new account-contact association in ActiveCampaign. Use when you need to link an existing contact to an existing account, optionally specifying the contact’s job title at that account.

Input Parameters

integer
required
The ID of the account to associate with the contact
integer
required
The ID of the contact to associate with the account
string
The job title of the contact at this account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ACCOUNT_CUSTOM_FIELD_DATACreates a custom field value for an account in ActiveCampaign. Use when you need to set or add a custom field value to an existing account. Requires the account ID and custom field ID.

Input Parameters

string
required
Values for the field. For currency field only, this needs to be in cents (e.g., 10050 = 100.5). Format varies by field type: text/textarea/hidden (plain string), dropdown/radio (pipe-delimited format: ||option1||option2||), multiselect/checkbox (array format: [“option1”, “option2”]), currency (numeric cents), number (decimal string), date (ISO format YYYY-MM-DD), datetime (ISO 8601 format)
integer
required
The ID of the custom field metadata this field value relates to
string
Currency code for monetary values (e.g., ‘USD’, ‘EUR’); defaults to the field’s configured currency if not specified
integer
required
The ID of the account this field value relates to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ACCOUNT_CUSTOM_FIELD_METATool to create a new account custom field metadata in ActiveCampaign. Use when you need to define a new custom field for accounts. After creating the field, you must call the Add Custom Field to Field Group API to add it to a field group for visibility on record pages.

Input Parameters

object
required
The account custom field metadata object containing field configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ACCOUNT_NOTETool to create a new note for an account in ActiveCampaign. Use when you need to add notes or comments to a specific account. The note will be associated with the account specified by the account ID.

Input Parameters

string
required
Account’s id to assign new note to. This is the unique identifier of the account.
object
required
The note object containing the note content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_ADDRESSTool to create a new address in ActiveCampaign. Use when you need to add a company address for campaigns, forms, or other communications. Requires company name, primary address, and country code.

Input Parameters

string
The ZIP or postal code
string
The city name
string
The state or province
string
required
The country code (e.g., US, CA, GB)
string
Whether the address is available to all groups (0 or 1)
string
The district
string
required
The primary address line
string
The secondary address line (optional)
string
required
The company name for the address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_A_DEAL_NOTETool to create a note for a specific deal in ActiveCampaign. Use when you need to add documentation, comments, or important information to a deal record.

Input Parameters

string
required
The deal’s ID to assign the new note to
string
required
The content of the note to be added to the deal. This should be plain text as HTML will be stripped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_AN_ORDERTool to create an e-commerce order in ActiveCampaign. Use when you need to record a purchase or transaction for e-commerce tracking and automation triggers.

Input Parameters

string
required
Customer email address. Contact will be created if it doesn’t exist.
integer
Source of the order (0=placed, 1=pending, 2=shipped, 3=refunded, 4=cancelled)
string
required
Three-letter ISO 4217 currency code
string
URL to view the order in your e-commerce platform
string
Order date in ISO 8601 format
integer
Tax amount in cents
integer
required
Customer ID in ActiveCampaign. Create customer first using the create customer action.
string
required
External order ID from your e-commerce platform. Must be unique.
integer
required
Total order price in cents (e.g., 19999 for $199.99)
string
Human-readable order number
integer
required
E-commerce connection ID in ActiveCampaign. Find this in Settings > Integrations.
string
Date the order was abandoned in ISO 8601 format
array
required
Array of products included in the order. At least one product is required.
integer
Discount amount in cents
integer
Shipping cost in cents
string
Shipping method used for the order
string
External checkout ID from your e-commerce platform
string
required
Order creation date in ISO 8601 format (e.g., ‘2024-01-15T12:00:00-06:00’)
string
Order last update date in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_A_TAG2Tool to create a new tag in ActiveCampaign with explicit tag type specification. Use when you need to create a tag with a specific type (contact or template).

Input Parameters

string
required
The name of the tag to create
string ("contact" | "template")
required
The type of tag to create. Use ‘contact’ for tags applied to contacts or ‘template’ for template-related tags
string
Optional description for the tag to provide context about its purpose

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_BULK_ACCOUNT_CUSTOM_FIELD_DATATool to bulk create custom field values for accounts in ActiveCampaign. Use when you need to set multiple custom field values across one or more accounts in a single request. Note: This endpoint updates the Last Modified date of associated accounts. If multiple items in the request reference the same accountId, the first item’s account will show the modified timestamp.

Input Parameters

array
required
Array of account custom field data objects to create. Each object specifies an account ID, custom field ID, and the value to store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CALENDARSTool to create a new calendar feed in ActiveCampaign. Use when you need to create a calendar feed that syncs with external calendar applications like Google Calendar or Outlook.

Input Parameters

string
required
The type of calendar. Typically ‘All’ to include all events
string
required
The title or name of the calendar feed
integer
required
Notification setting for the calendar (1 = enabled, 0 = disabled)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CAMPAIGNTool to create a new campaign in ActiveCampaign. Use when you need to create a broadcast email campaign or automation campaign.

Input Parameters

string
required
Name of the campaign to create. Must be unique.
string ("single" | "recurring" | "split" | "responder" | "reminder" | "special" | "activerss" | "automation")
required
Type of campaign to create. ‘single’ is for broadcast emails, ‘automation’ for automated campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CHILD_SCHEMATool to create a child schema in ActiveCampaign. Use when you need to create a child schema for a parent schema. Parent/child schemas allow multiple customers to share the same schema, useful for resellers and application developers. The parent schema must be public and associated with an application ID.

Input Parameters

string
required
The ID of the parent schema. Parent schema must be public and associated with an application ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CONNECTIONTool to create a new connection in ActiveCampaign. Use when you need to establish a link between an ActiveCampaign account and an external service or application.

Input Parameters

string
required
Display name for the connection
URL link to the external service
string
required
URL to the logo image for the service
string
required
The name of the external service
string
required
External identifier for the connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CONTACT_TASKCreate a task associated with a contact in ActiveCampaign. This action allows you to create a new task that will be associated with a specific contact in your ActiveCampaign account. The task can include details such as due date, title, description, and can be assigned to a specific user.

Input Parameters

string
Content describing the task
string
End date and time of the task. Must be a valid ISO 8601 datetime string with timezone offset (must be later than duedate). Format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., ‘2025-01-15T15:30:00-05:00’). Do NOT use placeholder values - provide an actual datetime value.
integer
required
The ID of the contact to associate the task with
string
The title of the task
integer
Task status (0 for incomplete, 1 for complete)
string
required
Due date and time of the task. Must be a valid ISO 8601 datetime string with timezone offset. Format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., ‘2025-01-15T14:30:00-05:00’ for January 15, 2025 at 2:30 PM EST). Do NOT use placeholder values like ‘<DATE_TIME>’ - provide an actual datetime value.
integer
The ID of the user this task will be assigned to
string
required
The type of task based on available Task Types in your account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_CUSTOMERTool to create an e-commerce customer in ActiveCampaign. Use when you need to register a new customer from your e-commerce platform for tracking purchases and automations.

Input Parameters

string
required
Customer email address. Used to associate the customer with a contact in ActiveCampaign.
string
required
External customer ID from your e-commerce platform. Must be unique per connection.
integer
required
E-commerce connection ID in ActiveCampaign. Find this by listing connections using the retrieve all connections action.
string
Marketing acceptance status. Use ‘1’ for accepts marketing, ‘0’ for does not accept.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DEAL_CUSTOM_FIELD_METATool to create a new deal custom field metadata in ActiveCampaign. Use when you need to define a new custom field for deals. After creating the field, you must call the Add Custom Field to Field Group API (/api/3/groupMembers) to add it to a field group for visibility on deal pages.

Input Parameters

object
required
The deal custom field metadata object containing field configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DEAL_PIPELINECreates a new deal pipeline in ActiveCampaign. A deal pipeline is a visual representation of your sales process that helps organize and track deals through different stages. When you create a new pipeline, it automatically comes with three default stages: ‘To Contact,’ ‘In Contact,’ and ‘Follow Up.‘

Input Parameters

string
required
The name of the pipeline
array
Array of user IDs who are allowed to manage the pipeline. Note: This parameter may cause API errors in some configurations and should be used with caution.
integer
Set to 1 to allow all users to manage the pipeline
string
required
The default currency for deals in this pipeline (ISO 4217 currency code, e.g., ‘usd’, ‘eur’, ‘gbp’)
integer
Set to 1 to allow all user groups to manage the pipeline
integer
Set to 1 to enable automatic assignment of new deals to owners

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DEAL_ROLETool to create a new deal role in ActiveCampaign. Use when you need to define roles that contacts can have in deals, such as Decision Maker, Influencer, or Head of Sales.

Input Parameters

string
required
The title/name of the deal role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DEAL_STAGETool to create a new stage in an ActiveCampaign deal pipeline. Use when you need to add a custom stage to organize deals in a specific pipeline.

Input Parameters

integer
required
The ID of the pipeline (deal group) this stage belongs to
integer
The display order/position of the stage within the pipeline. Lower numbers appear first. If not specified, the stage will be added at the end.
string
required
The name of the deal stage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DEAL_TASK_TYPEThis tool creates a new deal task type in ActiveCampaign. Deal task types are used to categorize and organize tasks associated with deals, and they are an important feature for maintaining a structured task management system within the deals pipeline. This action complements the existing ACTIVE_CAMPAIGN_CREATE_DEAL_TASK action by enabling the creation of custom task types that can be used when creating deal tasks.

Input Parameters

string
required
The name of the task type
integer
Status of the task type (0 for active, 1 for inactive)
string
Description of the task type. Note: The API accepts this field but does not return it in responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_DUPLICATE_CAMPAIGNTool to duplicate an existing campaign in ActiveCampaign. Use when you need to create a copy of a campaign with the same configuration and content.

Input Parameters

integer
required
The ID of the campaign to duplicate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_EVENT_TRACKING_EVENTTool to create a new event tracking event in ActiveCampaign. Use when you need to whitelist a new event name for tracking and use in automations.

Input Parameters

string
required
The name of the event to create in the event tracking whitelist. This event can then be used in automations and tracked via the Track Event API. Use descriptive, consistent naming (e.g., ‘purchase_complete’, ‘trial_started’, ‘file_download’). Maximum 32 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_FORM_OPTINSubmit a form opt-in request for a specific ActiveCampaign form by ID. The request supplies only the form ID, and the tool reports success based on the HTTP response.

Input Parameters

string
required
The ID of the form to submit an opt-in for. This is the form ID from your ActiveCampaign forms (e.g., ‘13’, ‘101’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_IMPORT_BULKBulk import large numbers of contacts into ActiveCampaign with a single API call. This action allows you to upload up to 250,000 contacts at once. The import is processed asynchronously - contacts are queued and imported in the background. You can optionally provide a webhook callback URL to be notified when the import completes. Use cases: - Migrate contacts from another platform - Import large CSV files of contacts - Bulk upload leads from marketing campaigns - Synchronize contacts from external databases Note: This is an asynchronous operation. The API returns immediately with a batch ID, but contacts are processed in the background. Use the callback parameter to get notified when processing completes.

Input Parameters

object
Optional callback configuration for the bulk import.
array
required
Array of contact objects to import. Each contact must have at least an email address. You can import up to 250,000 contacts per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_LISTTool to create a new list in ActiveCampaign. Use when you need to create a subscriber list for organizing contacts and sending campaigns.

Input Parameters

object
required
List object containing the details of the list to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_LIST_GROUP_PERMISSIONCreates a list group permission in ActiveCampaign by associating a list with a user group. This allows you to grant a specific group access permissions to a particular list.

Input Parameters

integer
required
The ID of the list to associate with the group
integer
required
The ID of the user group to associate with the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_MESSAGETool to create a message in ActiveCampaign. Use when you need to create an email message template that can be used in campaigns or automations. The message must include a subject, sender information (name and email), reply-to address, and content (HTML and/or text).

Input Parameters

object
required
The message object containing all message properties

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_METRICS_SNAPSHOTTool to retrieve snapshot metrics for specified SMS broadcast IDs in ActiveCampaign. Use when you need aggregated metrics (campaigns, sends, deliveries, clicks, replies, failures, opt-outs) for specific broadcast IDs.

Input Parameters

array
required
Array of broadcast IDs to retrieve snapshot metrics for. Pass an array of SMS broadcast IDs to get aggregated metrics for those specific broadcasts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_NOTECreate a note and attach it to a specific entity (contact, deal, account, etc.) in ActiveCampaign. Use this when you need to add notes to track information about contacts, deals, or accounts.

Input Parameters

string
required
The content of the note. HTML will be stripped.
integer
required
The ID of the related entity (contact, deal, account, etc.) to attach the note to
string ("Activity" | "Deal" | "DealTask" | "Subscriber" | "CustomerAccount")
required
The type of entity the note is being attached to. Valid values: Activity, Deal, DealTask, Subscriber (contact), CustomerAccount (account)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_OR_UPDATE_CONTACTCreate a new contact or update an existing contact in ActiveCampaign using the sync endpoint. This action uses the contact sync endpoint which automatically handles both creation and updates: - If a contact with the given email exists, it will be updated with the provided data - If no contact with the email exists, a new contact will be created This is the recommended way to ensure contact data is up-to-date without manually checking for existence.

Input Parameters

object
required
Contact object containing email and other fields to sync. The email is used to match existing contacts - if found, the contact is updated; otherwise, a new contact is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_OR_UPDATE_CUSTOM_OBJECT_RECORDTool to create or update a custom object record in ActiveCampaign. Use when you need to store custom data associated with contacts, accounts, or deals using custom object schemas. The API uses upsert logic: if external_id matches an existing record, it updates; otherwise, it creates a new record.

Input Parameters

array
required
Array of field objects containing the data for the record. Each field must have an ‘id’ matching the schema field definition and a ‘value’ of the appropriate type
string
required
The ID of the custom object schema for which you’re creating or updating a record
string
External identifier for the record. If provided and matches an existing record, that record will be updated. Otherwise, a new record is created
object
Object containing relationships to other records (contacts, accounts, deals). Keys are relationship names from the schema, values are arrays of related record IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_PRISM_URL_WHITELISTAdd a domain to ActiveCampaign’s site tracking whitelist. Use this to enable tracking, conversations, and WordPress integration for specific domains or pages in your ActiveCampaign account. This action is required before ActiveCampaign tracking scripts will function on your domain. You can control which features (tracking, conversations, WordPress) are enabled for each whitelisted domain.

Input Parameters

boolean
Enable or disable WordPress integration for the whitelisted domain. Set to true if using ActiveCampaign’s WordPress plugin, false otherwise.
boolean
Enable or disable site tracking for the whitelisted domain. Set to true to track visitor behavior, false to disable tracking.
string
Specific page path to whitelist, or '' for all pages on the domain. Use '' to enable tracking across the entire domain, or specify a path like ‘/products’ to restrict tracking to specific pages.
string
required
The domain to whitelist for site tracking (e.g., example.com, subdomain.example.com). This domain will be allowed for ActiveCampaign tracking scripts.
boolean
Enable or disable the Conversations chat widget on the whitelisted domain. Set to true to show the chat widget, false to hide it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_PRODUCTCreate a new product entry in the ActiveCampaign ecommerce catalog using GraphQL. This action creates a product in your ActiveCampaign ecommerce catalog with details like name, SKU, price, and variant information. The product is associated with a specific DeepData connection ID that links it to your e-commerce integration.

Input Parameters

string
required
Stock Keeping Unit (SKU) for this product variant. Use this to uniquely identify the specific variant.
string
Optional name for the product variant. Use this to distinguish between different variations (e.g., size, color).
string
required
The store’s unique identifier for this product. This is your internal product ID from your e-commerce system.
string
required
The name of the base product. This is the main product name that will be displayed.
integer
required
Integer connection identifier matching the v3 API DeepData Connection ID. This identifies which e-commerce connection to use for the product. You can find this ID in your ActiveCampaign DeepData Connections settings.
number
Price amount for the product variant as a decimal number.
string
ISO 4217 currency code for the product price (e.g., USD, EUR, GBP).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_SAVED_RESPONSETool to create a new saved response in ActiveCampaign. Use when you need to create a reusable email template with title, subject, and body content.

Input Parameters

string
required
The body content of the response
string
required
The title of the saved response
string
required
The subject line for the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_SEGMENTS_V2Tool to create advanced segments in ActiveCampaign using the V2 segments API. Use when you need to create flexible contact segments with complex filtering conditions based on tags, lists, fields, or other contact attributes. Only segments supported by the segment-builder UI are guaranteed to work as expected.

Input Parameters

array
required
Array containing the segment data. Typically contains a single segment object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_TASKOUTCOMETool to create a new task outcome in ActiveCampaign. Use when you need to add a new outcome option for tasks, which helps categorize task results with associated sentiment.

Input Parameters

string
required
The name/title of the task outcome
string
Status field to indicate if outcome is disabled (0 for active, 1 for disabled)
string ("POSITIVE" | "NEUTRAL" | "NEGATIVE")
required
The sentiment associated with the outcome (POSITIVE, NEUTRAL, or NEGATIVE)
string
The user ID who created the outcome

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_TASK_REMINDERCreate a new task reminder notification in ActiveCampaign. Use this action to set up notifications that will remind users about upcoming tasks before their due date.

Input Parameters

string
required
Notification interval in minutes before the task due date. This determines when the reminder notification will be sent before the task is due (e.g., ‘30’ for 30 minutes before, ‘60’ for 1 hour before, ‘1440’ for 1 day before).
string
required
The ID of the deal task for which to create a notification reminder. This must be a valid deal task ID that exists in your ActiveCampaign account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_USERCreates a new user (team member/staff account) in ActiveCampaign with specified details. Use when you need to add a new team member who can log into ActiveCampaign. Note: This creates account users (staff), not contacts (marketing database entries).

Input Parameters

string
Language preference for the user (e.g., ‘en-US’, ‘es-ES’)
string
required
Email address for the new user. Must be a valid email format.
integer
required
The permission group ID for the user. This determines the user’s access level and permissions within ActiveCampaign.
string
required
Last name of the user
string
required
Password for the new user. Must be at least 8 characters long.
string
required
Username for the new user. Must be unique within the account.
string
required
First name of the user
string
Local timezone ID for the user (e.g., ‘America/New_York’, ‘Europe/London’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_CREATE_WEBHOOKCreate a new webhook in ActiveCampaign to receive real-time notifications when specific events occur. Use this when you need to set up automated notifications for contact activities like subscriptions, email interactions, or other events.

Input Parameters

string
required
The URL endpoint where webhook data will be posted. Must be a valid HTTP/HTTPS URL that can accept POST requests
string
required
The name of the webhook to identify it
array
required
Array of event types that will trigger the webhook. Common events include ‘subscribe’, ‘unsubscribe’, ‘sent’, ‘open’, ‘click’, ‘bounce’, ‘reply’. Use the List Webhook Events action to see all available events
string
The list ID to associate with the webhook. If provided, the webhook will only trigger for events related to this specific list
array
required
Array of sources that can trigger the webhook. Common sources are ‘public’, ‘system’, ‘admin’, ‘api’. ‘public’ allows events from public pages, ‘system’ from internal processes, ‘admin’ from admin actions, ‘api’ from API calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ACCOUNTPermanently deletes an account from ActiveCampaign by its ID. This action is irreversible and will remove the account and all associated data from the system. Use this when you need to clean up old or unwanted accounts. The deletion is immediate and cannot be undone. Returns the deleted account ID upon successful deletion. Raises an error if the account is not found.

Input Parameters

integer
required
The ID of the account to delete. You can obtain account IDs from ACTIVE_CAMPAIGN_CREATE_ACCOUNT, ACTIVE_CAMPAIGN_UPSERT_ACCOUNT, or by listing accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ACCOUNT_CONTACTSDeletes an existing account-contact association in ActiveCampaign. Use when you need to remove the relationship between an account and a contact without deleting either entity.

Input Parameters

integer
required
The ID of the account-contact association to delete. This is the unique identifier of the relationship between an account and a contact, not the account ID or contact ID itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ACCOUNT_CUSTOM_FIELD_DATATool to delete a custom account field value in ActiveCampaign. Use when you need to remove a specific custom field value associated with an account. Requires permission to manage accounts.

Input Parameters

integer
required
The identifier of the custom field value to remove. This ID refers to a specific account custom field data record, not the field definition itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ACCOUNT_CUSTOM_FIELD_METATool to delete an account custom field meta definition from ActiveCampaign. Use when you need to remove a custom field definition permanently. Requires account management permissions. This action is irreversible.

Input Parameters

integer
required
The ID of the account custom field meta to delete. This is the unique identifier of the custom field definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ACCOUNTS_BULKTool to bulk delete multiple accounts from ActiveCampaign in a single operation. Use when you need to delete multiple accounts at once rather than deleting them individually. This action is irreversible and will permanently remove all specified accounts and their associated data. Provide a list of account IDs to delete.

Input Parameters

array
required
List of account IDs to delete. Each ID must be a valid integer representing an existing account. Multiple accounts will be deleted in a single operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ADDRESSPermanently deletes an address from ActiveCampaign by its ID. This action is irreversible and will remove the address from the system. Use this when you need to clean up old or unwanted addresses. The deletion is immediate and cannot be undone. Returns the deleted address ID upon successful deletion. Raises an error if the address is not found.

Input Parameters

integer
required
The address ID to delete. You can obtain address IDs from ACTIVE_CAMPAIGN_GET_ADDRESS or ACTIVE_CAMPAIGN_LIST_ADDRESSES actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_ADDRESS_GROUPTool to delete an address group from ActiveCampaign by its ID. Use when you need to remove an address group permanently. This action is irreversible and will remove the address group from the system immediately.

Input Parameters

integer
required
The unique identifier of the address group to delete. This is the ID of the address group resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_AN_ORDERTool to permanently delete an e-commerce order from ActiveCampaign by its ID. Use when you need to remove an order from the system. This action is irreversible - the deleted order cannot be recovered.

Input Parameters

string
required
The identifier of the e-commerce order resource to be deleted. You can obtain order IDs from ACTIVE_CAMPAIGN_CREATE_AN_ORDER, ACTIVE_CAMPAIGN_RETRIEVE_AN_ORDER, or by listing orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CALENDARTool to permanently delete a calendar feed from ActiveCampaign by its ID. Use when you need to remove a calendar feed that is no longer needed. The deletion is immediate and cannot be undone.

Input Parameters

string
required
The calendar feed identifier to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CONNECTIONPermanently deletes a connection from ActiveCampaign by its ID. This action is irreversible and will remove the connection from the system. Use this when you need to clean up old or unwanted connections. The deletion is immediate and cannot be undone. Returns the deleted connection ID upon successful deletion. Raises an error if the connection is not found.

Input Parameters

string
required
The connection identifier to be deleted. You can obtain connection IDs from ACTIVE_CAMPAIGN_RETRIEVE_CONNECTION or ACTIVE_CAMPAIGN_RETRIEVE_ALL_CONNECTIONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CONTACTPermanently deletes a contact from ActiveCampaign by its ID. This action is irreversible and will remove the contact and all associated data from the system. Use this when you need to clean up old or unwanted contacts. The deletion is immediate and cannot be undone. Returns the deleted contact ID upon successful deletion. Raises an error if the contact is not found.

Input Parameters

integer
required
The ID of the contact to delete. You can obtain contact IDs from ACTIVE_CAMPAIGN_CREATE_CONTACT, ACTIVE_CAMPAIGN_FIND_CONTACT, or by listing contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CUSTOMERTool to permanently delete an e-commerce customer from ActiveCampaign by ID. Use when you need to remove a customer and all associated data. This action is irreversible and cannot be undone.

Input Parameters

string
required
The unique identifier of the e-commerce customer to delete. You can obtain customer IDs from ACTIVE_CAMPAIGN_RETRIEVE_CUSTOMER, ACTIVE_CAMPAIGN_RETRIEVE_ALL_CUSTOMERS, or when creating customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CUSTOM_FIELDTool to delete a custom field from ActiveCampaign by its ID. Use when you need to remove an unwanted or obsolete custom field. This action is irreversible and will permanently delete the field and its associated data.

Input Parameters

integer
required
The ID of the custom field to delete. You can obtain field IDs from ACTIVE_CAMPAIGN_LIST_ALL_CUSTOM_FIELDS or by creating a custom field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_CUSTOM_FIELD_FIELD_GROUPTool to delete a custom field field group member in ActiveCampaign. Use when you need to remove the association between a custom field and a field group. This operation is permanent and cannot be undone.

Input Parameters

string
required
The identifier of the field group member to delete. This removes the association between a custom field and a field group. You can obtain group member IDs from ACTIVE_CAMPAIGN_LIST_GROUP_MEMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEALTool to permanently delete a deal from ActiveCampaign by its ID. Use when you need to remove unwanted or obsolete deals from the system. This action is irreversible and will permanently remove the deal and all associated data. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The ID of the deal to delete. You can obtain deal IDs from deal creation, update operations, or by listing deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_CUSTOM_FIELD_DATATool to delete a custom deal field value in ActiveCampaign. Use when you need to remove custom field data from a deal. Requires deal management permissions and pipeline-specific permissions.

Input Parameters

integer
required
The ID of the custom deal field value to delete. This is the dealCustomFieldData ID, not the field ID or deal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_CUSTOM_FIELD_METATool to delete a custom deal field metadata from ActiveCampaign. Use when you need to remove a custom field definition from deals. Requires deal management permissions and pipeline-specific permissions.

Input Parameters

integer
required
The unique identifier of the custom deal field metadata to delete. You can obtain this ID from ACTIVE_CAMPAIGN_LIST_DEAL_CUSTOM_FIELD_META or ACTIVE_CAMPAIGN_GET_DEAL_CUSTOM_FIELD_META actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_PIPELINEThis tool deletes an existing deal pipeline in ActiveCampaign. When deleting a pipeline that has existing deals and stages associated with it, the DELETE request will remove all stages and deals associated with it. This tool complements the existing ACTIVE_CAMPAIGN_CREATE_DEAL_PIPELINE action and provides the ability to manage the full lifecycle of deal pipelines in ActiveCampaign.

Input Parameters

integer
required
The unique identifier of the deal pipeline to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_ROLETool to delete an existing deal role in ActiveCampaign. Use when you need to permanently remove a deal role that is no longer needed.

Input Parameters

integer
required
The unique identifier of the deal role to be removed. This permanently deletes the deal role from your ActiveCampaign account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_STAGEDelete an ActiveCampaign deal stage, either directly or after moving its deals to a specified pipeline and stage. Moving deals occurs before deletion and can leave partial changes if an operation fails.

Input Parameters

integer
required
The unique identifier of the deal stage to be deleted
string
required
How to handle deals in this stage before deletion. Use ‘Move’ to move deals to another stage (requires new_pipeline_id and new_stage_id), or ‘Delete’ to delete the stage immediately. Case-insensitive.
integer
Required when action_type=‘Move’. The ID of the target stage where deals should be moved. Must belong to the new_pipeline_id.
integer
Required when action_type=‘Move’. The ID of the target pipeline where deals should be moved. This can be the same pipeline or a different one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_DEAL_TASKSPermanently deletes a deal task from ActiveCampaign by its ID. Use when you need to remove a task associated with a deal. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The ID of the deal task to delete. You can obtain deal task IDs from ACTIVE_CAMPAIGN_CREATE_CONTACT_TASK or ACTIVE_CAMPAIGN_GET_DEAL_TASK.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_EVENTTool to delete an event tracking event from ActiveCampaign. Use when you need to remove an event name from the tracking whitelist.

Input Parameters

string
required
The name of the event to delete from the event tracking whitelist. Event names with spaces will be automatically URL encoded. This will remove the event from ActiveCampaign’s event tracking system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_FIELD_RELATIONSHIPTool to delete a field relationship in ActiveCampaign. Use when you need to remove the association between a custom field and a list. This action is irreversible and will permanently remove the field relationship from the system.

Input Parameters

integer
required
The ID of the field relationship to delete. A field relationship associates a custom field with a list in ActiveCampaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_FIELD_VALUETool to permanently delete a custom field value from ActiveCampaign by its ID. Use when you need to remove a specific field value from a contact. This action is irreversible and will remove the field value immediately.

Input Parameters

string
required
The ID of the custom field value to delete. You can obtain field value IDs from ACTIVE_CAMPAIGN_GET_FIELDVALUE or by listing field values for a contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_FORMTool to permanently delete a form from ActiveCampaign by its ID. Use when you need to remove old or unwanted forms. This action is irreversible and will remove the form and all associated data from the system.

Input Parameters

string
required
The form’s ID to be deleted. You can obtain form IDs from ACTIVE_CAMPAIGN_CREATE_FORM, ACTIVE_CAMPAIGN_GET_FORM, or ACTIVE_CAMPAIGN_LIST_FORMS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_GROUPTool to permanently delete a permission group from ActiveCampaign by its ID. Use when you need to remove a group that is no longer needed. This action is irreversible and will remove the group from the system.

Input Parameters

integer
required
The unique identifier of the group to delete. You can obtain group IDs from ACTIVE_CAMPAIGN_CREATE_GROUP, ACTIVE_CAMPAIGN_LIST_GROUPS, or ACTIVE_CAMPAIGN_GET_GROUP_BY_ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_LISTPermanently deletes a list from ActiveCampaign by its ID. This action is irreversible and will remove the list from the system. Use this when you need to clean up old or unwanted lists. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The ID of the list to delete. You can obtain list IDs from actions like ACTIVE_CAMPAIGN_CREATE_LIST, ACTIVE_CAMPAIGN_GET_LISTS, or ACTIVE_CAMPAIGN_RETRIEVE_LIST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_MESSAGEPermanently deletes a message from ActiveCampaign by its ID. This action is irreversible and will remove the message from the system. Use this when you need to clean up old or unwanted messages. Returns the deleted message ID upon successful deletion. Raises an error if the message is not found.

Input Parameters

integer
required
The ID of the message to delete. You can obtain message IDs from ACTIVE_CAMPAIGN_CREATE_MESSAGE, ACTIVE_CAMPAIGN_LIST_MESSAGES, or ACTIVE_CAMPAIGN_RETRIEVE_MESSAGE actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_NOTEPermanently deletes a note from ActiveCampaign by its ID. This action is irreversible and will remove the note and all associated data from the system. Use this when you need to clean up old or unwanted notes. The deletion is immediate and cannot be undone. Returns the deleted note ID upon successful deletion. Raises an error if the note is not found.

Input Parameters

integer
required
The unique identifier of the note to delete. You can obtain note IDs from ACTIVE_CAMPAIGN_ADD_CONTACT_NOTE, ACTIVE_CAMPAIGN_CREATE_NOTE, or by listing/getting notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_PRODUCTDelete a product from ActiveCampaign’s e-commerce catalog by ID using the deleteProduct GraphQL mutation. Returns the mutation’s boolean result.

Input Parameters

string
required
The unique identifier of the product to delete. This is the product ID returned when creating or listing products in ActiveCampaign’s e-commerce system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_RECORD_BY_EXTERNAL_IDDelete a custom object record from ActiveCampaign by schema ID and external ID. Returns the supplied schema ID and external ID on a successful response.

Input Parameters

string
required
The identifier for the custom object schema. You can obtain schema IDs from ACTIVE_CAMPAIGN_LIST_ALL_SCHEMAS or ACTIVE_CAMPAIGN_GET_SCHEMA_BY_ID.
string
required
The external identifier of the record to be deleted. This is the unique identifier you assigned to the record when it was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_RECORD_BY_IDPermanently deletes a custom object record from ActiveCampaign by its ID and schema ID. This action is irreversible and will remove the record and all associated data from the custom object. Use this when you need to clean up old or unwanted custom object records. The deletion is immediate and cannot be undone. Returns the deleted record ID and schema ID upon successful deletion. Raises an error if the record or schema is not found.

Input Parameters

string
required
The ID of the custom object record to be deleted. You can obtain record IDs from ACTIVE_CAMPAIGN_GET_RECORD_BY_ID or ACTIVE_CAMPAIGN_LIST_RECORDS_FOR_SCHEMA.
string
required
The ID of the custom object schema that the record belongs to. You can obtain schema IDs from ACTIVE_CAMPAIGN_LIST_ALL_SCHEMAS or ACTIVE_CAMPAIGN_GET_SCHEMA_BY_ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_SAVED_RESPONSETool to permanently delete a saved response from ActiveCampaign by its ID. Use when you need to remove saved response templates that are no longer needed. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The unique identifier of the saved response to be deleted. You can obtain saved response IDs from ACTIVE_CAMPAIGN_GET_SAVED_RESPONSE or ACTIVE_CAMPAIGN_LIST_SAVED_RESPONSES actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_SCHEMAPermanently deletes a custom object schema from ActiveCampaign by its UUID. This action is irreversible and will remove the schema and all associated data. Use with caution as deletion cannot be undone.

Input Parameters

string
required
The unique identifier (UUID) of the schema to delete. Schema IDs can be obtained from ACTIVE_CAMPAIGN_LIST_ALL_SCHEMAS or ACTIVE_CAMPAIGN_GET_SCHEMA_BY_ID actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_SECONDARY_CONTACTPermanently deletes a secondary contact association from a deal in ActiveCampaign. This removes the link between a contact and a deal, but does not delete the contact or deal themselves. Use this when you need to remove a secondary contact from a deal. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The ID of the secondary contact association (contactDeal) to delete. This is the contactDeal ID, not the contact ID or deal ID. You can obtain this ID from ACTIVE_CAMPAIGN_ADD_SECONDARY_CONTACT_TO_DEAL, ACTIVE_CAMPAIGN_LIST_CONTACT_DEALS, or ACTIVE_CAMPAIGN_GET_SECONDARY_CONTACT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_SEGMENTS_V2Permanently delete a segment from ActiveCampaign by its UUID, including its historic versions. The response may include data returned by the API after deletion.

Input Parameters

string
required
The unique identifier (UUID) of the segment to delete. This will permanently remove the segment and all its historic versions from ActiveCampaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_TAGTool to permanently delete a tag from ActiveCampaign by its ID. Use when you need to remove unused or unwanted tags from the system. This action is irreversible.

Input Parameters

integer
required
The unique identifier of the tag to delete. You can obtain tag IDs from ACTIVE_CAMPAIGN_CREATE_TAG, ACTIVE_CAMPAIGN_LIST_ALL_TAGS, or ACTIVE_CAMPAIGN_GET_TAG.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_USERPermanently deletes a user from ActiveCampaign by their ID. This action is irreversible and will remove the user account from the system. Use this when you need to remove team members or staff accounts. The deletion is immediate and cannot be undone. Returns the deleted user ID upon successful deletion. Raises an error if the user is not found.

Input Parameters

string
required
The ID of the user to delete. You can obtain user IDs from ACTIVE_CAMPAIGN_FIND_USER or by listing users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_VARIABLEPermanently deletes a personalization variable from ActiveCampaign by its ID. Use when you need to remove unused or unwanted personalization variables. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The ID of the personalization variable to delete. You can obtain variable IDs by listing personalizations using the GET /api/3/personalizations endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_VARIABLES_BULKTool to bulk delete personalization variables in ActiveCampaign. Use when you need to delete multiple personalization variables at once by providing their IDs. The operation will delete existing variables and silently ignore non-existent IDs.

Input Parameters

string
required
Comma-separated list of personalization variable IDs to delete. The endpoint will delete existing variables and ignore non-existent IDs. Example: ‘1,2,3’ or ‘999’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_DELETE_WEBHOOKPermanently deletes a webhook from ActiveCampaign by its ID. Use this when you need to remove a webhook that is no longer needed. The deletion is immediate and cannot be undone.

Input Parameters

integer
required
The webhook identifier to delete. You can obtain webhook IDs from ACTIVE_CAMPAIGN_CREATE_WEBHOOK, ACTIVE_CAMPAIGN_LIST_WEBHOOKS, or ACTIVE_CAMPAIGN_GET_WEBHOOK actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_EDIT_CAMPAIGNUpdate the name of an existing ActiveCampaign campaign by its ID.

Input Parameters

string
required
The campaign ID to edit
string
Updated campaign name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_FIND_CONTACTFind an ActiveCampaign contact by ID, email, or phone, returning the first result; ID takes precedence over other criteria. Phone-only searches use general search and may return partial matches, while combined email and phone searches filter email results by normalized phone.

Input Parameters

string
The ActiveCampaign ID of the contact
string
The email address of the contact
string
The phone number of the contact. Note: Phone search uses the general search parameter internally, which may return partial matches. When combined with email, results are filtered client-side to match both criteria.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_FIND_CONTACT_TASKFind contact tasks in ActiveCampaign, optionally filtering by title, contact ID, and status. Returns matching Subscriber tasks from the requested page and a count of those returned tasks.

Input Parameters

integer
Maximum number of tasks to return (default is 20)
string
The title of the task to search for
integer
Number of tasks to skip for pagination (use with limit)
integer
Task status (0 for incomplete, 1 for complete)
integer
The ID of the contact to filter tasks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_FIND_USER_ACTIONFind an ActiveCampaign account user (team member/staff) by their email address. Returns user details including username, email, first name, last name, phone, signature, language preference, timezone, MFA status, and related resource links. Note: This finds account users (staff who can log into ActiveCampaign), not contacts (people in your marketing database). To find contacts, use the find contact action instead.

Input Parameters

string
required
Email address of the user to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ACCOUNT_CONTACTTool to retrieve an existing account-contact association in ActiveCampaign. Use when you need to get details about the relationship between a specific account and contact.

Input Parameters

integer
required
The ID of the account-contact association to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ACCOUNT_CUSTOM_FIELD_DATARetrieves a specific account custom field data record by ID. Use when you need to get the value of a custom field associated with an account.

Input Parameters

string
required
The identifier for the account custom field data record to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ACCOUNT_CUSTOM_FIELD_METARetrieve metadata for a specific account custom field by ID. Returns details including field label, type, options, default value, visibility settings, and timestamps.

Input Parameters

integer
required
ID of the account custom field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ADDRESSRetrieves a single address by ID from ActiveCampaign. Use when you need to fetch complete details of a specific address including company name, location fields, and metadata.

Input Parameters

integer
required
The address ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ALL_FIELD_RELATIONSHIPSGet all field relationships in ActiveCampaign. Use this to retrieve custom field associations with lists or other entities. Supports pagination via limit and offset parameters for handling large numbers of field relationships.

Input Parameters

integer
Number of field relationships to return per page. Use for pagination.
integer
Pagination offset for retrieving additional results. Use with limit to navigate through pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_AUDIENCESRetrieve a specific audience segment by ID from ActiveCampaign. Returns detailed information about the segment including its conditions, groups, and metadata. Use this action when you need to inspect the configuration or criteria of a saved segment/audience.

Input Parameters

string
required
The unique identifier for the segment/audience to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_BRANDINGTool to retrieve an existing branding resource from ActiveCampaign by its ID. Use when you need to fetch branding configuration details such as site name, logos, templates, and styling information.

Input Parameters

string
required
The branding resource identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_BROADCAST_METRICS_FAILURESRetrieve grouping and counts of failures for an SMS broadcast in ActiveCampaign. Use when you need to analyze failure patterns for a specific broadcast, with optional date filtering.

Input Parameters

string
Filter results by end date using YYYY-MM-DD format
string
Filter results by start date using YYYY-MM-DD format
integer
required
The identifier for the broadcast whose failures you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_BROADCASTS_METRICSTool to retrieve metrics for specified SMS broadcast IDs in ActiveCampaign. Use when you need detailed performance data including sends, deliveries, replies, failures, opt-outs, and clicks for specific broadcasts.

Input Parameters

array
required
Array of broadcast IDs to retrieve metrics for. At least one broadcast ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_BROADCASTS_RECIPIENTSFetch a page of contacts sent a specific SMS broadcast in ActiveCampaign, with optional filters and pagination. Recipient details may include delivery status, engagement metrics, and replies.

Input Parameters

integer
Items per page (default: 20)
integer
Pagination offset (default: 0)
Search contacts by name or phone number
string
Filter results up to this date (YYYY-MM-DD format)
string
Filter results starting from this date (YYYY-MM-DD format)
integer
required
The unique identifier for the broadcast
string ("name" | "phone" | "sentDate" | "clicks" | "deliverability" | "optOut" | "replies")
Fields available for sorting recipients.
array
Filter by engagement type (clicks, replies, or optOuts)
array
Filter by delivery status (deliveries or failures)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_BULK_IMPORT_STATUS_INFOTool to retrieve the status of a specific bulk import in ActiveCampaign. Use when you need to check the progress and results of a bulk contact import, including newly created contact IDs and any failed email addresses.

Input Parameters

string
required
The batch ID of the bulk import to retrieve status information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CALENDARTool to retrieve a specific calendar feed from ActiveCampaign by its ID. Returns calendar details including title, type, token, notification settings, and creation/modification dates.

Input Parameters

string
required
The calendar feed identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_AUTOMATION_CAMPAIGN_LISTSTool to retrieve all lists associated with a specific campaign automation in ActiveCampaign. Use when you need to see which lists a campaign is configured to send to.

Input Parameters

string
required
The ID of the campaign to retrieve lists for. You can obtain campaign IDs from list campaigns actions or from the ActiveCampaign campaign interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_AUTOMATIONSGet automation information associated with a specific campaign in ActiveCampaign. This action retrieves automation details linked to a campaign ID.

Input Parameters

string
required
The ID of the campaign to retrieve automation information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_BY_IDRetrieve a single campaign by its ID from ActiveCampaign. Returns comprehensive campaign details including engagement metrics, content configuration, and automation settings.

Input Parameters

integer
required
The campaign ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_MESSAGEGet the message associated with a specific campaign in ActiveCampaign. Returns message details including subject, content (HTML and text), sender information, and configuration settings.

Input Parameters

string
required
The ID of the campaign to retrieve the message for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_MESSAGESGet campaign messages associated with a specific campaign in ActiveCampaign. Returns an array of message objects linked to the campaign ID.

Input Parameters

string
required
The ID of the campaign to retrieve messages for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CAMPAIGN_USERGet the user (account owner/staff member) associated with a specific campaign in ActiveCampaign. Returns user details including username, email, name, phone, and other account information.

Input Parameters

string
required
The ID of the campaign to retrieve user information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_ACCOUNT_CONTACTSRetrieve all account-contact associations for a specific contact in ActiveCampaign. Use this action when you need to see which accounts a contact is associated with and their role at each account.

Input Parameters

integer
required
The ID of the contact to retrieve account associations for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_AUTOMATION_ENTRY_COUNTSTool to retrieve the number of times a contact has entered each automation. Use when you need to understand a contact’s automation engagement history.

Input Parameters

string
required
The contact’s ID number to retrieve automation entry counts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_AUTOMATIONSRetrieve all automations that a specific contact is enrolled in or has been enrolled in. Returns automation enrollment details including status, progress, and completion information.

Input Parameters

string
required
The unique identifier of the contact to retrieve automations for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_DATARetrieve data for a specific ActiveCampaign contact, including available geographic, social media, Google Analytics, and tracking information. If the response’s data object is missing or empty, the tool returns a contact reference with no other contact data.

Input Parameters

integer
required
ID of the contact to retrieve data for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_DATA_GOALSRetrieve a contact’s goals from ActiveCampaign. Use when you need to access goal completion data, automation goals, and goal tracking information for a specific contact.

Input Parameters

integer
required
ID of the contact to retrieve goals for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_DEALSTool to retrieve all deals associated with a specific contact in ActiveCampaign. Use when you need to see all deals linked to a particular contact, including deal details like value, stage, status, and associated metadata.

Input Parameters

integer
required
ID of the contact for which to retrieve associated deals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_EVENTS_AND_ACTIVITIESTool to retrieve contact events and activities from ActiveCampaign. Use when you need to view the activity history for a specific contact or all contacts, including deal-related activities and general activities. Returns paginated results with limit and offset parameters.

Input Parameters

integer
Number of records to return per request. Default is 20, maximum is 100.
integer
Zero-based index to offset the result set for pagination. Use this to retrieve subsequent pages of results.
integer
Contact ID to filter activities for a specific contact. If not provided, returns activities for all contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_FIELD_VALUESTool to retrieve all custom field values for a specific contact in ActiveCampaign. Use when you need to access a contact’s custom field data such as custom text fields, dropdown selections, or other custom attributes.

Input Parameters

integer
required
The contact’s ID used to retrieve their field values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_GEO_IPS_LISTRetrieve all geo IP addresses associated with a specific contact in ActiveCampaign. Use when you need to view the geographic locations from which a contact has interacted with your campaigns.

Input Parameters

integer
required
The unique identifier of the contact to retrieve geo IP addresses for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_LISTSTool to retrieve all list memberships for a specific contact in ActiveCampaign. Use when you need to see which lists a contact is subscribed to and their subscription details.

Input Parameters

integer
required
The ID of the contact to retrieve list memberships for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_LOGSTool to retrieve logs for a specific contact in ActiveCampaign. Use when you need to access a contact’s activity history, including subscription changes, campaign interactions, and automation events.

Input Parameters

integer
required
The unique identifier of the contact to retrieve logs for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_NOTESRetrieve all existing notes associated with a specific contact in ActiveCampaign. Use when you need to view all notes that have been added to a contact’s record.

Input Parameters

integer
required
The contact’s ID whose notes you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_ORGANIZATIONTool to retrieve organization information associated with a specific contact in ActiveCampaign. Use when you need to get details about the organization that a contact belongs to.

Input Parameters

integer
required
The contact’s ID to retrieve organization information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_PLUS_APPENDRetrieve a contact’s plus append enrichment data from ActiveCampaign, including available social media profile information, profile image URLs, and enrichment service update timestamps.

Input Parameters

integer
required
ID of the contact to retrieve plus append data for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_SCORE_VALUESTool to retrieve all score values associated with a specific contact in ActiveCampaign. Use when you need to see scoring data for a contact.

Input Parameters

integer
required
The ID of the contact to retrieve score values for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_TAGSTool to retrieve all tags associated with a specific contact in ActiveCampaign. Use when you need to see which tags are applied to a contact.

Input Parameters

integer
required
The ID of the contact to retrieve tags for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CONTACT_TRACKING_LOGSRetrieve tracking logs for a specific contact in ActiveCampaign. Use when you need to view all tracking events such as page views, link clicks, and file downloads associated with a contact.

Input Parameters

integer
required
The contact’s ID for which to retrieve tracking logs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_CUSTOM_FIELDRetrieve a specific custom field by ID from ActiveCampaign. Returns field metadata including title, type, options, relationships, and configuration settings. Use when you need detailed information about a custom contact field.

Input Parameters

integer
required
The unique identifier for the custom field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_CUSTOM_FIELD_DATARetrieves a specific deal custom field data record by ID. Use when you need to get the value of a custom field associated with a deal.

Input Parameters

integer
required
The identifier for the custom field value to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_CUSTOM_FIELD_METARetrieve metadata for a specific deal custom field by ID. Returns details including field label, type, options, default value, visibility settings, and timestamps. Requires deal management permission.

Input Parameters

integer
required
ID of the deal custom field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_PIPELINETool to retrieve an existing pipeline (deal group) from ActiveCampaign by its ID. Use when you need to get details about a specific pipeline including its name, currency, stages, and configuration settings.

Input Parameters

string
required
The ID of the pipeline to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_STAGETool to retrieve an existing deal stage from ActiveCampaign by its ID. Use when you need to get detailed information about a specific stage including its title, color, order, and card region configurations.

Input Parameters

string
required
The unique identifier of the deal stage to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_TASKTool to retrieve an existing task in ActiveCampaign by its ID. Use when you need to get detailed information about a specific task including its title, status, due date, assignee, and related contact or deal information.

Input Parameters

integer
required
The task identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_DEAL_TASK_TYPETool to retrieve an existing deal task type in ActiveCampaign by its ID. Use when you need to get details about a specific task type configuration.

Input Parameters

integer
required
The ID of the deal task type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_EVENT_TRACKING_STATUSTool to retrieve the event tracking status for your ActiveCampaign account. Use this to check whether event tracking is enabled or disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_FIELD_VALUETool to retrieve a specific field value by its ID in ActiveCampaign. Use when you need to get detailed information about a particular custom field value including its contact, field, value, and timestamps.

Input Parameters

string
required
The ID of the field value to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_FORMRetrieve a single form by its ID from ActiveCampaign. Returns comprehensive form details including field configuration, styling, submission behavior, and metadata.

Input Parameters

string
required
The form ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_GROUP_BY_IDRetrieve a specific group by ID in ActiveCampaign. Use this to get detailed information about a single group including its title, description, settings, and associated resource links.

Input Parameters

string
required
The ID of the group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_GROUP_LIMITSTool to retrieve group limits configured for different groups in ActiveCampaign account. Use when you need to check limits for emails, contacts, lists, campaigns, users, and other resources per group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_LISTSRetrieve mailing lists in ActiveCampaign for subscription management, including list IDs and information. Supports name filtering and pagination via limit and offset.

Input Parameters

integer
Number of lists to return. Default is 20
integer
Offset for pagination. Use to retrieve subsequent pages of results
string
Filter lists by name. Returns lists whose name contains this value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_LOGGED_IN_USERRetrieve information about the currently authenticated user (the user whose API token is being used). Use when you need to identify the current user or access their account details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_NOTETool to retrieve a specific note from ActiveCampaign by its ID. Use when you need to get details about a particular note including its content, creation date, and related entity.

Input Parameters

string
required
The note’s identifier that you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_ORDERRetrieve a single order from ActiveCampaign by legacy connection ID and store order ID. Use this to fetch complete order details including customer information, line items, addresses, and order status.

Input Parameters

string
required
The order’s store order ID. This is the unique identifier for the order in your e-commerce system (e.g., ‘order-12345’, ‘graphql-test-order-002’).
integer
required
The order’s legacy connection ID. This identifies which e-commerce connection to use for retrieving the order. You can find this ID in your ActiveCampaign DeepData Connections settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_PRODUCT_BY_IDRetrieve a single product by its ID from ActiveCampaign’s e-commerce catalog. Use when you need to fetch detailed information about a specific product, including its name, SKU, pricing, and description.

Input Parameters

string
required
The unique identifier of the product to retrieve. This is the product ID returned when creating or listing products in ActiveCampaign’s e-commerce system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_RECENT_SEGMENT_COUNTSRetrieve the most recent result count for segments that were run without additional criteria. Use when you need to check segment sizes or monitor segment growth over time.

Input Parameters

string
required
A comma-separated list of segment IDs. Example: 1,2,3 or id1,id2,id24,uuid-string,id5454. Maximum 100 segment IDs per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_RECORD_BY_EXTERNAL_IDRetrieve a custom object record from ActiveCampaign by schema ID and external ID.

Input Parameters

string
required
The ID of the custom object schema
string
required
The external ID of the record to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_RECORD_BY_IDTool to retrieve a custom object record from ActiveCampaign by schema ID and record ID. Use when you need to get detailed information about a specific custom object record including its fields, values, and timestamps.

Input Parameters

string
required
The ID of the specific record to retrieve
string
required
The ID of the custom object schema

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SAVED_RESPONSETool to retrieve a specific saved response from ActiveCampaign by its ID. Use when you need to fetch details of a saved response including title, subject, and body content.

Input Parameters

integer
required
The saved response identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SCHEMA_BY_IDRetrieve a specific custom object schema by ID in ActiveCampaign. Use this to get detailed information about a schema including its fields, relationships, and metadata. Optionally include deleted fields by setting show_fields to ‘all’.

Input Parameters

string
required
The unique identifier (UUID) for the schema to retrieve
string
Optional parameter; use ‘all’ to display all fields including deleted ones (marked with status: marked_for_deletion)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SECONDARY_CONTACTTool to retrieve a specific secondary contact (contact-deal association) by ID in ActiveCampaign. Use when you need to get details about a particular secondary contact associated with a deal.

Input Parameters

integer
required
The ID of the secondary contact (contactDeal) to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_COUNT_BY_TIMESTAMPTool to retrieve all result counts for a segment that were run without an AdditionalCriteria. Use when you need to access historical segment count data before a specific timestamp. Returns up to 50 segment count history records.

Input Parameters

integer
required
Epoch seconds. Exclusive. Retrieves up to 50 segment count history records that occurred before this point in time
string
required
A unique segment identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_COUNT_HISTORYTool to retrieve all historical result counts for a given segment that were run without additional criteria. Use when you need to track segment size changes over time or audit segment evaluation history. Returns up to 50 results with data available for the past 90 days.

Input Parameters

string
required
The unique identifier for the segment to retrieve count history for. This is the UUID of the segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_MATCHRetrieve segment match evaluation for a contact in ActiveCampaign. Use this to determine if a specific contact matches the criteria of a given segment.

Input Parameters

string
required
The contact identifier to evaluate against the segment
string
required
The segment identifier, accepting either UUID or numeric formats

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_MATCH_ALL_RESULTTool to retrieve segment match-all result set by ID. Use when you need to check the status and results of a segment match-all request. The is_ready attribute indicates if results are complete (true) or still processing (false). If is_ready is false and run_id_end is populated, the request has errored.

Input Parameters

integer
Page number for pagination (default: 1)
string
Field ordering (defaults to id). Supports: id, email, phone, first_name, last_name, full_name, cdate, udate, account_name, score. Prepend with - for descending order (e.g., ‘-email’)
string
required
The unique identifier from a match-all request (results viewable for 90 days)
integer
Results per page, maximum 10,000 (default: 20)
string
required
The segment identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_MATCH_BY_EXTERNAL_IDCheck if a contact matches a segment using segment ID, contact ID, and external ID. Use when you need to verify if a specific contact belongs to a segment and get match evaluation details.

Input Parameters

integer
required
The identifier for the contact being checked
string
required
The identifier for the segment being evaluated
string
required
External ID value for additional validation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENT_MATCH_SOME_RESULTTool to retrieve segment match result set by run ID in ActiveCampaign. Use when you need to fetch the results of a segment evaluation request, including which contacts match the segment criteria. The is_ready field indicates if results are available.

Input Parameters

integer
Page number to retrieve. Defaults to 1 if not specified.
string
required
Unique identifier for a specific segment evaluation request. Results are viewable for 90 days after creation.
integer
Number of results to return per page. Defaults to 20, maximum is 10,000.
string
required
Identifier for the segment being queried. Accepts both numeric and UUID formats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENTS_V2Tool to retrieve a specific segment by its ID in ActiveCampaign. Use when you need detailed information about a segment including its conditions, groups, and metadata.

Input Parameters

string
required
A unique identifier for the segment being retrieved (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SEGMENTS_V2_CREATED_DATERetrieve a historical ActiveCampaign segment definition by segment ID and timestamp. Only non-numeric segment IDs are supported; a not-found response with a valid segment response body can be returned rather than raised as an error.

Input Parameters

string
required
Unix timestamp representing the point in time to retrieve the segment state
string
required
The segment identifier to retrieve (non-numeric IDs only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SITE_TRACKING_CODETool to retrieve the site tracking JavaScript code for your ActiveCampaign account. Use when you need to get the tracking code snippet to embed on your website for visitor tracking and behavior monitoring. The returned code enables site tracking features like page view tracking, visitor identification, and site-based automation triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SITE_TRACKING_STATUSTool to retrieve the site tracking status for your ActiveCampaign account. Use this to check whether site tracking is enabled or disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SMS_BROADCAST_METRICS_SNAPSHOTTool to retrieve snapshot data for all SMS broadcasts in ActiveCampaign. Use when you need aggregate metrics including campaigns, sends, deliveries, clicks, replies, failures, and opt-outs.

Input Parameters

string
End date for snapshot in YYYY-MM-DD format (e.g., 2024-12-31)
string
Start date for snapshot in YYYY-MM-DD format (e.g., 2024-01-01)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_SMS_CREDITSTool to retrieve the current period’s SMS credit usage and remaining balance. Use when you need to check how many SMS credits are available, used, or included in the billing cycle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_TAGTool to retrieve a tag from ActiveCampaign by its ID. Use when you need to get detailed information about a specific tag including its name, type, description, and subscriber count.

Input Parameters

string
required
The tag’s unique identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_TASKOUTCOMETool to retrieve a specific task outcome from ActiveCampaign by its ID. Use when you need to get details about a task outcome including its title, sentiment, and associated deal task types.

Input Parameters

string
required
The task outcome identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_TEMPLATERetrieve a single template by its ID from ActiveCampaign. Returns comprehensive template details including content, subject, and configuration settings.

Input Parameters

integer
required
The ID of the template to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_USERTool to retrieve a specific ActiveCampaign account user (team member/staff) by their ID. Use when you need to get detailed information about a specific user including username, email, name, phone, signature, language, timezone, and MFA status.

Input Parameters

string
required
The ID of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_USER_BY_USERNAMETool to retrieve an ActiveCampaign account user (team member/staff) by their username. Use when you need to get detailed information about a specific user by username.

Input Parameters

string
required
The username to look up

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_USERSTool to retrieve all ActiveCampaign account users (team members/staff). Use when you need to list all users in the account with pagination and sorting options.

Input Parameters

integer
Number of users to return per page (default=20, max=100)
integer
Starting point for result set, zero-based index for pagination
object
Orders model for sorting users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_USERS_BY_GROUPRetrieve user-group relationships for a specific ActiveCampaign group, including associated user IDs.

Input Parameters

integer
required
The unique identifier of the group to retrieve users for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_VARIABLETool to retrieve a personalization variable from ActiveCampaign by its ID. Use when you need to get details about a specific variable including its name, tag, content, format, and associated lists.

Input Parameters

string
required
The unique identifier for the personalization variable to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_VARIABLESRetrieve personalization variables from ActiveCampaign, with limit and offset pagination. Use this to list custom variables used for personalization in campaigns and automations.

Input Parameters

integer
Maximum number of personalizations to return. Use this to control page size when paginating through results.
integer
Number of personalizations to skip for pagination. Use with limit to retrieve specific pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_GET_WEBHOOKRetrieve an existing webhook by ID from ActiveCampaign. Use this when you need to get detailed information about a specific webhook including its URL, events, sources, and current state.

Input Parameters

integer
required
The webhook identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ACCOUNT_CONTACTSLists account-contact associations in ActiveCampaign, with optional account and contact filters. Results are paginated using limit and offset.

Input Parameters

integer
Maximum number of associations to return (default is 20)
integer
Number of associations to skip for pagination (use with limit)
integer
Filter by Account ID to retrieve associations for a specific account
integer
Filter by Contact ID to retrieve associations for a specific contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ACCOUNT_CUSTOM_FIELD_DATALists a page of account custom field values in ActiveCampaign, including field IDs, values, account associations, and timestamps when available. The request accepts a limit of up to 100 records.

Input Parameters

integer
Number of records to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ACCOUNT_CUSTOM_FIELD_METALists a page of account custom field metadata in ActiveCampaign, including field types, labels, options, and required-field settings. Supports limit and offset pagination.

Input Parameters

integer
Number of fields returned per request (default: 100)
integer
Number of records to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ADDRESSESTool to list all addresses in the ActiveCampaign account. Use when you need to retrieve all configured addresses. Returns an array of address objects with company name, address details, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_ACCOUNTSTool to list all accounts in ActiveCampaign. Use when you need to retrieve all existing accounts, optionally filtered by name search. Can include contact and deal counts for each account.

Input Parameters

integer
Maximum number of accounts to return (default is 20)
integer
Number of accounts to skip for pagination (use with limit)
string
Search accounts by name. Filter results to only include accounts whose name matches the search term.
string ("true" | "false")
Enum for count_deals parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_CONTACTSList all contacts in ActiveCampaign. This action allows you to: 1. List all contacts with pagination 2. Search contacts by name, organization, phone, or email 3. Filter contacts by email pattern 4. Sort contacts by various fields 5. Filter contacts by creation and update dates 6. Filter contacts by list, tag, or segment

Input Parameters

integer
Number of contacts to return per page
integer
Filter contacts associated with the given tag
string
Filter contacts associated with the given list
object
Orders model for sorting contacts.
string
Filter contacts by searching in names, organization, phone, or email
object
Filters model for filtering contacts by date.
integer
Only include contacts with an ID less than the given ID
integer
Return only contacts that match a list segment
string
Filter contacts that contain the given value in the email address
integer
Only include contacts with an ID greater than the given ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_CUSTOM_FIELDS2Tool to list all custom fields in ActiveCampaign with pagination support. Use when you need to retrieve information about custom fields with control over the number of results returned per request.

Input Parameters

integer
The number of fields returned per request. Default: 100
integer
Number of records to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_CUSTOM_FIELD_VALUESList custom field values across ActiveCampaign contacts, including field IDs, values, contact associations, and timestamps. Returns up to 100 values per request.

Input Parameters

integer
Number of field values to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_EVENTS_NAME_ONLYTool to list all whitelisted event tracking events in ActiveCampaign. Use when you need to retrieve the names of all events that are whitelisted for tracking and can be used in automations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_SCHEMASTool to list all custom object schemas in ActiveCampaign. Use when you need to retrieve all schema definitions including their fields, relationships, and metadata.

Input Parameters

string
Set to ‘all’ to display all field details. Recommended when programmatically creating schema fields to ensure field ID uniqueness. Deleted fields will include a ‘status: marked_for_deletion’ attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_TAGS2Tool to retrieve all tags in ActiveCampaign with search functionality. Use when you need to list or search for tags.

Input Parameters

integer
Number of tags to return per request (default: 20)
integer
Number of items to skip for pagination
string
Search by tag name to filter results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ALL_WHITE_LISTED_DOMAINSTool to list all whitelisted domains for site tracking in ActiveCampaign. Use when you need to retrieve all domains that are allowed for site tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_AUDIENCESList saved segment summaries (audiences) in ActiveCampaign, with optional page and page size. Results may include configuration, conditions, and metadata.

Input Parameters

integer
Page number to return (default is 1)
integer
Number of segments per page (default is 20)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_AUTOMATIONSList all automations in ActiveCampaign. Use this to retrieve all automation workflows in your account. Supports pagination via limit and offset parameters for handling large numbers of automations.

Input Parameters

integer
Number of automations to return per page. Use for pagination.
integer
Pagination offset for retrieving additional results. Use with limit to navigate through pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_BULK_IMPORT_STATUSTool to monitor bulk import progress in ActiveCampaign. Use this after sending bulk data via POST endpoint to track the status of outstanding and recently completed batches. Requires the batchId returned from the bulk import POST request.

Input Parameters

string
required
Identifier for tracking the bulk import batch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_BULK_IMPORT_STATUS_AGGREGATETool to retrieve aggregate progress data for all bulk import jobs in ActiveCampaign. Returns daily summaries of outstanding and recently completed batch jobs in a rolling 7-day window. Use this to monitor overall bulk import progress across all batches without needing a specific batch ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_CALENDARSTool to list all calendar feeds in ActiveCampaign. Use when you need to retrieve all available calendar feeds for the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_CAMPAIGNSList ActiveCampaign campaigns, including standard and automation campaigns. Results are paginated, with optional automation filtering and sorting.

Input Parameters

integer
Maximum number of campaigns to return (default is 20)
integer
Number of campaigns to skip for pagination (use with limit)
object
Orders model for sorting campaigns.
object
Filters model for filtering campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_CONTACT_AUTOMATIONSList a page of contact automation enrollments in ActiveCampaign, with optional limit and offset. Enrollment details can include status, dates, and progress.

Input Parameters

integer
Number of records to return per page (typically between 1-100)
integer
Number of records to skip for pagination (0-based indexing)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_CONTACT_DEALSList a page of secondary contacts (contact-deal associations) in ActiveCampaign, using limit and offset to paginate.

Input Parameters

integer
Number of records to return per page
integer
Offset for pagination - number of records to skip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_ACTIVITIESLists a page of deal activities across ActiveCampaign deals, including activity history such as notes, tasks, and other interactions. Supports limit and offset pagination.

Input Parameters

integer
Number of records to return per page
integer
Offset for pagination - number of records to skip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_CUSTOM_FIELD_DATALists a page of deal custom field values in ActiveCampaign, including field IDs, values, deal associations, and timestamps. Supports limit and offset pagination.

Input Parameters

integer
Number of records to return per page (default 20, max 100)
integer
Offset for pagination (number of records to skip)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_CUSTOM_FIELD_METAList deal custom field metadata in ActiveCampaign, including field types, labels, options, and required status. Results are paginated using limit and offset; deal management permissions are required.

Input Parameters

integer
Number of fields returned per request (default: 100)
integer
Number of records to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEALGROUPSList deal pipelines in ActiveCampaign, optionally filtering by title. Results can be paginated using a limit and offset.

Input Parameters

integer
Maximum number of pipelines to return. Use for pagination.
integer
Number of pipelines to skip before starting to return results. Use for pagination.
string
Filter pipelines by title. Use this to search for pipelines with a specific name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_ROLESTool to retrieve all deal roles in ActiveCampaign. Use when you need to view available deal roles that can be assigned to contacts in deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEALS2List deals from ActiveCampaign with title search and filters for stage, pipeline, owner, or status. Results can be paginated using a limit and offset.

Input Parameters

integer
Number of deals to return per page. Maximum value is typically 100.
integer
Pagination offset - number of records to skip before returning results.
integer
Filter by pipeline ID (also called group). Specify the pipeline ID to only return deals in that pipeline.
integer
Filter by owner ID. Specify the user ID to only return deals owned by that user.
integer
Filter by deal stage ID. Specify the stage ID to only return deals in that stage.
Search deals by title. Use this to find deals matching a search term.
integer
Filter by deal status. Use 0 for open deals, 1 for won deals, 2 for lost deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_STAGESList ActiveCampaign deal stages and mappings from stage titles to IDs, useful when updating or moving deals. Filter by pipeline ID or a case-insensitive title substring, and use limit and offset to paginate results. Title searches may not cover all stages.

Input Parameters

integer
Maximum number of stages to return. Use for pagination.
string
Filter stages by title using case-insensitive contains match. Applied as client-side filter.
integer
Number of stages to skip before starting to return results. Use for pagination.
integer
Filter stages by pipeline (deal group) ID. If not provided, returns stages from all pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_DEAL_TASK_TYPESTool to retrieve all existing task types for deals in ActiveCampaign. Use when you need to view available task type categories that can be assigned to deal tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_EMAIL_ACTIVITIESTool to list all email activities in ActiveCampaign. Use when you need to retrieve email activity records for a specific subscriber or deal. At least one filter parameter (subscriber ID or deal ID) should be provided for optimal performance.

Input Parameters

integer
Maximum number of email activities to return (default is 20)
integer
Number of email activities to skip for pagination (use with limit)
integer
Set this parameter to return only email activities belonging to a given deal
integer
Set this parameter to return only email activities belonging to a given subscriber

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_FORMSList ActiveCampaign forms with limit and offset pagination. Returned form information can include configurations, fields, and styling.

Input Parameters

integer
Maximum number of forms to return (default is 20)
integer
Number of forms to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_GROUP_MEMBERSList ActiveCampaign group members linking custom fields to their display groups. Supports pagination with limit and offset.

Input Parameters

integer
Number of group members to return per page (default 20, max 100)
integer
Offset for pagination - number of records to skip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_GROUPSTool to retrieve all permission groups from ActiveCampaign. Use when you need to list user groups with their permission settings. Supports pagination via limit and offset parameters.

Input Parameters

integer
Maximum number of groups to return per page. Use for pagination.
integer
Number of groups to skip before starting to return results. Use for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_MESSAGESList messages in ActiveCampaign, with pagination and optional filters. Results can include email content, sender details, and metadata.

Input Parameters

integer
Number of messages to return per page
integer
Filter messages associated with the given tag ID
integer
Filter messages associated with the given form ID
integer
Filter messages associated with the given list ID
integer
Offset for pagination - number of records to skip
string
Filter messages by searching in message name or subject
integer
Filter messages associated with the given wait ID
integer
Filter messages associated with the given series/automation ID
integer
Filter messages associated with the given segment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_NOTESList notes in ActiveCampaign across related entities, with pagination support.

Input Parameters

integer
Maximum number of notes to return (default is 20)
integer
Number of notes to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_ORDER_PRODUCTSTool to list all e-commerce order products in ActiveCampaign. Use when you need to retrieve all order products with pagination support.

Input Parameters

integer
Number of order products to return per page (default: 20, max: 100)
integer
Starting point for the result set (zero-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_PRISM_URL_WHITELISTINGSTool to list all whitelisted site tracking domains in ActiveCampaign. Use when you need to retrieve domains that are allowed for site tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_RECORDS_FOR_SCHEMATool to list custom object records for a specific schema in ActiveCampaign. Use when you need to retrieve records created from a custom object schema. Note: Non-admin users must provide a filter parameter for contact, account, or deal.

Input Parameters

integer
Number of records to return per page (default: 20, max: 100)
integer
Offset for pagination (default: 0)
object
Filter by contact, account, or deal. Required for non-admin users. Example: {‘relationships.primary-contact’: {‘eq’: ‘55’}}
string
required
The ID of the custom object schema to list records for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_SAVED_RESPONSESList saved responses in ActiveCampaign for one-off personal emails. Results are paginated using limit and offset.

Input Parameters

integer
Maximum number of saved responses to return (default is 20)
integer
Number of saved responses to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_SCORESTool to list all scoring rules configured in ActiveCampaign. Use when you need to retrieve all available scores for contacts or deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_SEGMENT_MATCH_ALLInitiate a match-all request for contacts in a segment. If results are not ready within 4 seconds, returns immediately with is_ready=False and a run_id. Use when you need to retrieve all contacts that match a specific segment’s criteria, especially for large segments where immediate results may not be available.

Input Parameters

integer
Page number for pagination. Defaults to 1 if not specified.
string
Comma-delimited field list for result ordering (e.g., ‘id’, ‘email’, ‘phone’, ‘first_name’, ‘last_name’). Defaults to ‘id’ if not specified.
string
When present (any value), returns immediately with a runId without waiting for results. Use this for large segments to avoid timeout.
integer
Results per page. Maximum 10000, defaults to 20 if not specified.
string
required
The segment identifier to query for matching contacts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_SMS_BROADCAST_LISTSTool to retrieve a paged list of all SMS broadcast lists in ActiveCampaign. Use when you need to view available SMS broadcast lists, optionally filtered by name.

Input Parameters

integer
Number of SMS broadcast lists to return per request. Maximum value depends on API limits.
integer
Starting position for pagination. Use to skip the first N results.
string
Filter results by broadcast list name. Partial matches are supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_SMS_BROADCASTSTool to list all SMS broadcasts in ActiveCampaign with optional filtering and pagination. Use when you need to retrieve broadcast messages, check their status, or search for specific broadcasts by name or date range.

Input Parameters

integer
Number of items to return per page. Maximum is typically 100.
integer
Offset for pagination. Use to skip a certain number of results.
string
Filter broadcasts up to this date. Use YYYY-MM-DD format.
string
Filter broadcasts starting from this date. Use YYYY-MM-DD format.
string
Filter broadcasts by name. Searches for broadcasts containing this text.
string
Filter by broadcast type (future feature). Not currently used by the API.
string
Field name to sort results by (e.g., ‘name’, ‘created_at’, ‘sent_date’).
string ("draft" | "scheduled" | "sent" | "pending_review" | "sending")
Status of an SMS broadcast.
string ("ASC" | "DESC")
Sort order for listing broadcasts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_TASK_OUTCOMESTool to retrieve all existing task outcomes from ActiveCampaign. Use when you need to list all available task outcome options that can be assigned to tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_WEBHOOK_EVENTSList all available webhook events in ActiveCampaign. Use this action when you need to discover what webhook events are available for subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LIST_WEBHOOKSTool to list all existing webhooks in ActiveCampaign. Use when you need to retrieve all configured webhooks including their names, URLs, events, and sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_LOCK_PERSONALIZATIONTool to lock a personalization variable in ActiveCampaign. Use when you need to prevent modifications to a personalization variable. Once locked, the variable cannot be edited.

Input Parameters

string
required
The identifier of the personalization variable to lock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_MANAGE_CONTACT_TAGAdd or remove tags for an ActiveCampaign contact identified by ID or email; adding a tag may create it if no case-insensitive exact name match is found. Check individual results for removal success.

Input Parameters

string
required
Tags to add/remove. Can be a comma-separated string or list of strings
string ("Add" | "Remove")
required
The action to perform on the tags
string
The ID of the contact to manage tags for
string
The email of the contact (used if contact_id is not provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_REMOVE_CONTACT_FROM_AUTOMATIONRemove automation enrollments for a contact found by email and a specified automation ID. Deletes either all enrollments returned by a single lookup or the one with the latest last-activity date; this is a destructive operation.

Input Parameters

string
required
The numeric ID of the automation from which to remove the contact. You can get automation IDs by listing automations in your account.
string
required
Email address of the contact to remove from automation
string ("all" | "latest")
Specifies which automation runs to remove. Use ‘all’ to remove the contact from all instances of this automation (if they were enrolled multiple times), or ‘latest’ to remove only from the most recent enrollment. Default is ‘all’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_REMOVE_DOMAIN_FROM_WHITELISTRemove a domain from ActiveCampaign’s URL whitelist. Use this to revoke site tracking access for a specific domain that was previously whitelisted.

Input Parameters

string
required
The unique identifier of the domain to remove from the whitelist. This ID can be obtained from the list of whitelisted domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_REMOVE_TAG_FROM_CONTACTTool to remove a tag from a contact in ActiveCampaign. Use when you need to disassociate a tag from a contact. Requires the contactTag ID (the relationship ID, not the tag ID itself).

Input Parameters

string
required
The contactTag ID (association ID between contact and tag) to remove. This is NOT the tag ID itself, but the ID of the contact-tag relationship. You can obtain this ID from ACTIVE_CAMPAIGN_GET_CONTACT_TAGS or ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACT actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ACCOUNTTool to retrieve an account from ActiveCampaign by its ID. Use when you need to get detailed information about a specific account including its name, URL, timestamps, and custom fields.

Input Parameters

string
required
The ID of the account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_A_DEALTool to retrieve a specific deal by its ID in ActiveCampaign. Use when you need detailed information about a single deal including its title, value, stage, status, and associated contacts or organizations.

Input Parameters

integer
required
The ID of the deal to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ALL_CONNECTIONSTool to retrieve all Deep Data connection resources in ActiveCampaign. Use when you need to list connections between the ActiveCampaign account and external services like Shopify or other e-commerce platforms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ALL_CUSTOMERSTool to retrieve all e-commerce customer resources from ActiveCampaign. Use when you need to list customers from external e-commerce services like Shopify, including aggregated metrics such as total revenue, orders, and products.

Input Parameters

integer
Maximum number of customers to return (default is 20)
integer
Number of customers to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ALL_DEALSTool to retrieve all deals from ActiveCampaign with filtering and pagination support. Use when you need to list deals, optionally filtered by stage, contact, organization, status, or value range.

Input Parameters

integer
Number of deals to return per page (default: 20, max: 100)
integer
Offset for pagination - number of records to skip
object
Orders model for sorting deals.
object
Filters model for filtering deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ALL_ORDERSList ActiveCampaign e-commerce orders with pagination, including total price, customer information, product counts, and order-product references.

Input Parameters

integer
Number of orders to return per page (default: 20, max: 100)
integer
Starting point for the result set (zero-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_ALL_PRODUCTS_FOR_ORDERTool to retrieve all products associated with a specific e-commerce order in ActiveCampaign. Use when you need to list all products that belong to a particular order.

Input Parameters

string
required
The ID of the e-commerce order to retrieve products for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_AN_ORDERRetrieve an ActiveCampaign e-commerce order by ID, including available customer, pricing, and status information, product count, and a link to its order products.

Input Parameters

string
required
The unique identifier of the e-commerce order to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_AN_ORDER_PRODUCTTool to retrieve an ecommerce order product from ActiveCampaign by its ID. Use when you need to get detailed information about a specific order product including SKU, price, quantity, and related order details.

Input Parameters

string
required
The ID of the ecommerce order product to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_CONNECTIONTool to retrieve a connection from ActiveCampaign by its ID. Use when you need to get detailed information about a specific connection including service type, status, and synchronization details.

Input Parameters

string
required
The connection identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_CUSTOMERTool to retrieve an e-commerce customer from ActiveCampaign by their ID. Use when you need to get detailed information about a specific customer including email, revenue, order statistics, and connection details.

Input Parameters

string
required
The unique identifier of the e-commerce customer to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_DEAL_ACTIVITIESRetrieves a page of activities associated with a specific deal in ActiveCampaign, including changes and interactions such as contact additions, notes, stage changes, and custom field updates. Supports limit and offset pagination.

Input Parameters

string
required
The ID of the deal to retrieve activities for
integer
Maximum number of activities to return (default is 20)
integer
Number of activities to skip for pagination (use with limit)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_LISTTool to retrieve a specific list from ActiveCampaign by its ID. Use when you need to get detailed information about a list including its name, description, tracking settings, and configuration.

Input Parameters

string
required
The list’s ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_RETRIEVE_MESSAGETool to retrieve a specific message by its ID in ActiveCampaign. Use when you need detailed information about a single message including its subject, content (HTML and text), sender information, and configuration settings.

Input Parameters

string
required
The ID of the message to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_SAVE_BROWSE_SESSIONCreate a browse session in ActiveCampaign for testing purposes. Use this to simulate customer browsing behavior in a specified state. This action creates a new browse session with the specified status, products, and metadata. It is intended for testing and development purposes only, not for production integrations. The action will always create a new session rather than updating an existing one. Note that sessions created in an ABANDONED state will NOT generate Browse Abandonment custom objects.

Input Parameters

string
required
Email address of the contact associated with this browse session. The contact should exist in ActiveCampaign.
array
Optional array of products that were viewed during the browse session. Each product must have a matching storePrimaryId in your ActiveCampaign product catalog.
string
Optional timestamp of when the browse session should be marked as abandoned in ISO 8601 format (e.g., ‘2023-02-11T10:48:23Z’). If not provided, the session will not have an abandonment date set.
string ("ACTIVE" | "ABANDONED" | "ADDED_TO_CART" | "ERRORED")
required
The status of the browse session. ACTIVE indicates an ongoing session, ABANDONED means the customer left without completing, ADDED_TO_CART means items were added to cart, and ERRORED indicates an error occurred.
integer
required
Integer connection identifier matching the v3 API DeepData Connection ID. This identifies which e-commerce connection to use for the browse session. You can find this ID in your ActiveCampaign DeepData Connections settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_SEARCH_BROWSE_SESSIONSearch for browse sessions matching specified criteria in ActiveCampaign. Use when you need to find browse sessions for a specific contact, connection, and status combination.

Input Parameters

string
required
Email address to search for browse sessions. This will find all browse sessions associated with the specified contact email.
string ("ACTIVE" | "ABANDONED" | "ADDED_TO_CART" | "ERRORED")
required
The normalized status of the browse session to search for. ACTIVE indicates an ongoing session, ABANDONED indicates a session where the user left without completing a purchase, ADDED_TO_CART indicates a session where items were added to cart, and ERRORED indicates a session that encountered an error state.
integer
required
Integer connection identifier matching the v3 API DeepData Connection ID. This identifies which e-commerce connection to search within. You can find this ID in your ActiveCampaign DeepData Connections settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_SEARCH_PRODUCTSearch ActiveCampaign’s e-commerce catalog by product name or status, with pagination and sorting support.

Input Parameters

integer
Number of products to return per page. Minimum is 1, maximum is 100.
integer
The offset of the page for pagination. Minimum value is 0.
string ("ASC" | "DESC")
Enum for sort order.
string
Filter by product status. Common values include ‘active’, ‘archived’, or custom status values.
string ("ASC" | "DESC")
Enum for sort order.
string ("EQ" | "LT" | "LTE" | "GT" | "GTE" | "CONTAINS" | "IN")
Enum for filter operators.
string
Filter by product name. Use with base_product_name_filter_operator to specify how to match (e.g., exact match with EQ or partial match with CONTAINS).
string ("EQ" | "LT" | "LTE" | "GT" | "GTE" | "CONTAINS" | "IN")
Enum for filter operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_SEARCH_RECURRING_PAYMENTSearch for recurring payment records based on filter criteria. Use when you need to find subscription payments by email, status, connection, or other attributes.

Input Parameters

object
required
Filter criteria to search recurring payments. Provide at least one filter field to narrow down the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_TEST_TRACKING_EVENTSimulate a tracking event coming into the Browse Session system with debug output for testing URL patterns. This action allows you to test how ActiveCampaign’s Browse Session system will process tracking events and identify products from URLs. It’s useful for validating URL patterns and understanding how browsing events will be handled before implementing live tracking.

Input Parameters

string
required
The webpage URL that was browsed. This should be a fully qualified URL (e.g., ‘https://example.com/products/test-product’). The system will analyze this URL for product patterns.
string
required
Customer email address associated with the browsing event. This identifies which contact the browse session belongs to.
string
Timestamp of when the browsing event happened in ISO 8601 format (e.g., ‘2026-02-12T10:00:00Z’). If not provided, the current server time will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_TRACK_EVENTTrack a custom event for an existing ActiveCampaign contact by email. Requires the Event Tracking account ID and event key; events can be used to trigger automations.

Input Parameters

string
required
Your Event Key from ActiveCampaign. Find this in Settings > Tracking > Event Tracking in your ActiveCampaign account. It’s a long alphanumeric string (e.g., ‘c12973b078007927842301eff932e7d78b74b3e’).
string
required
Name of the event to track (max 32 characters). This identifies the type of action being recorded. For automation triggers, ensure the event name is whitelisted in your ActiveCampaign automations. Use descriptive, consistent naming (e.g., ‘file_download’, ‘purchase_complete’, ‘trial_started’).
string
required
Your ActiveCampaign Account ID (actid). Find this in Settings > Tracking > Event Tracking API (click the button to see the modal with your actid). It’s typically a 9-10 digit number.
string
Optional additional data to store with the event. Can be used to pass context like URLs, product names, transaction IDs, or any relevant string value. This data can be referenced later in automations.
string
required
Email address of the contact for whom the event is being tracked. Must be an existing contact in ActiveCampaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UNLOCK_PERSONALIZATIONTool to unlock a personalization variable in ActiveCampaign. Use when you need to allow modifications to a personalization variable. Once unlocked, the variable can be edited.

Input Parameters

string
required
The identifier of the personalization variable to unlock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNTThis tool updates an existing account in ActiveCampaign. It allows modification of account details such as name, website URL, and custom fields. It complements the existing ACTIVE_CAMPAIGN_CREATE_ACCOUNT action and provides the ability to modify account details after creation, which is a crucial functionality for account management.

Input Parameters

string
The updated name of the account
integer
The ID of the user who owns the account
array
List of custom fields to update
string
The updated URL associated with the account
string
required
The ID of the account to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNT_CONTACTTool to update an existing account-contact association in ActiveCampaign. Use when you need to modify the relationship between an account and contact, such as updating the contact’s job title at that account.

Input Parameters

integer
required
The ID of the account-contact association to update
integer
Account ID to associate with the contact
integer
Contact ID to associate with the account
string
Job title of the contact at the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNT_CUSTOM_FIELD_DATAUpdates a custom account field value in ActiveCampaign. Use when you need to modify an existing custom field value for an account. Requires account permission to manage accounts.

Input Parameters

integer
required
The ID of the custom field value record to update
string
required
The updated value for the field. Format varies by field type: text/textarea/hidden (plain string), dropdown/radio (pipe-delimited format: ||option1||option2||), multiselect/checkbox (array format: [“option1”, “option2”]), currency (numeric cents), number (decimal string), date (ISO format YYYY-MM-DD), datetime (ISO 8601 format)
integer
required
The ID of the custom field metadata this field value relates to
string
Required only for currency field types; specify the three-letter currency code (e.g., USD, EUR, GBP, CAD)
integer
required
The ID of the account this field value relates to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNT_CUSTOM_FIELD_DATA_BULKTool to bulk update multiple custom account field values in a single request. Use when you need to update existing accountCustomFieldData records by their IDs with new field values. This is more efficient than making individual update requests when modifying multiple field values.

Input Parameters

array
required
Array of account custom field data updates. Each object specifies the record ID and the new value to set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNT_CUSTOM_FIELD_METAUpdate metadata for an account custom field. Allows modification of field label, options, default value, visibility, and display order.

Input Parameters

integer
required
ID of the account custom field to update
string
Updated label for the custom field displayed in the UI
integer
Updated display sequence on the Manage Fields page
string
Updated default value for the custom field
array
Updated options for dropdown, multiselect, radio, or checkbox field types. Should be a list of strings.
integer
Whether the field appears on forms. Use 1 for visible, 0 for hidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ACCOUNT_NOTETool to update an existing account note in ActiveCampaign. Use when you need to modify the content of an existing note attached to a specific account. The note will be updated for the account specified by the account ID and note ID.

Input Parameters

string
required
Account’s id that the note belongs to. This is the unique identifier of the account.
object
required
The note object containing the updated note content
string
required
Account note’s id to update. This is the unique identifier of the note to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_ADDRESSTool to update an existing address in ActiveCampaign. Use when you need to modify address details such as company name, street address, city, state, zip code, or country for an existing address record.

Input Parameters

integer
required
The address ID to update
object
required
Address object containing fields to update. At least one field must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_A_DEALTool to update an existing deal in ActiveCampaign. Use when you need to modify deal properties such as title, value, stage, or status.

Input Parameters

integer
required
The ID of the deal to update
string
The ID of the pipeline (deal group) for this deal
string
The ID of the user who owns this deal
integer
The ID of the stage within the pipeline
string
The updated title of the deal
integer
The updated value of the deal in cents (e.g., $1850.00 should be 185000)
integer
The status of the deal. Use 0 for open, 1 for won, 2 for lost
string
The ID of the account associated with this deal
string
The ID of the primary contact associated with this deal
integer
The percentage of completion for the deal
string
The currency code for the deal in 3-digit ISO format, lowercase (e.g., ‘usd’, ‘eur’, ‘gbp’)
string
A description of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_A_DEAL_NOTETool to update an existing note for a specific deal in ActiveCampaign. Use when you need to modify the content of an existing note attached to a deal record.

Input Parameters

object
required
The note object containing the updated note content
string
required
The deal’s ID that the note belongs to. This is the unique identifier of the deal.
string
required
The note’s ID to update. This is the unique identifier of the note to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_AN_ORDERTool to update an existing e-commerce order in ActiveCampaign. Use when you need to modify order details such as pricing, shipping, or customer information.

Input Parameters

string
Updated customer email address for the order
integer
Source of the order (0=placed, 1=pending, 2=shipped, 3=refunded, 4=cancelled)
string
Three-letter ISO 4217 currency code
string
URL to view the order in your e-commerce platform
string
Order date in ISO 8601 format
integer
Tax amount in cents
integer
Customer ID in ActiveCampaign associated with this order.
string
External order ID from your e-commerce platform
integer
Updated total order price in cents (e.g., 8000 for $80.00)
string
required
The unique identifier of the e-commerce order to update
string
Human-readable order number
integer
E-commerce connection ID in ActiveCampaign. Find this in Settings > Integrations.
string
Date the order was abandoned in ISO 8601 format
integer
Discount amount in cents
integer
Shipping cost in cents
string
Shipping method used for the order
string
External checkout ID from your e-commerce platform
string
Order creation date in ISO 8601 format (e.g., ‘2024-01-15T12:00:00-06:00’)
string
Order last update date in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_A_TAGTool to update an existing tag in ActiveCampaign. Use when you need to modify a tag’s name, type, or description. Requires the tag ID and at least the tag name and type.

Input Parameters

string
required
The updated name of the tag
string
required
The ID of the tag to update
string ("contact" | "template")
required
The type of tag. Must be ‘contact’ or ‘template’
string
The updated description for the tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_BRANDINGTool to update an existing branding resource in ActiveCampaign. Use when you need to modify branding configuration such as site name, logos, templates, styling, or other branding-related settings.

Input Parameters

string
required
The branding resource identifier to update
string
Help text or URL for the branding
string
Path or URL to the favicon
string
Group ID to associate with the branding
string
License information for the branding
string
Version number of the branding
Path or URL to the site logo
string
Site name for the branding
Copyright text for the branding
string
Path or URL to the small site logo
Footer HTML content for the branding
Footer text content for the branding
string
Header HTML content for the branding
string
Header text content for the branding
string
Admin template CSS content
string
Admin template HTML content
string
Public template CSS content
string
Public template HTML content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CALENDARTool to update an existing calendar feed in ActiveCampaign. Use when you need to modify calendar properties like title, type, or notification settings.

Input Parameters

string
required
The calendar feed identifier to be updated
string
The updated type of calendar feed. Common values include ‘All’ for all events or ‘Deals’ for deal-related events
string
The updated title or name of the calendar feed
integer
Updated notification setting for the calendar (1 = enabled, 0 = disabled)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CONFIGSTool to update an existing configuration in ActiveCampaign. Use when you need to modify configuration settings like pagination preferences or onboarding states for users.

Input Parameters

object
required
Configuration object containing the key name and value to update
string
required
The ID of the configuration to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CONNECTIONTool to update an existing connection in ActiveCampaign. Use when you need to modify connection details such as service name, external ID, display name, logo URL, or link URL.

Input Parameters

string
Display name for the connection
URL link to the external service
string
URL to the logo image for the service
string
The name of the external service
string
External identifier for the connection
string
required
The ID of the connection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CONTACTUpdate an existing ActiveCampaign contact by ID, changing its email, first name, last name, or phone number. At least one of these fields is required.

Input Parameters

integer
required
The ID of the contact to update
string
The updated email address of the contact
string
The updated phone number of the contact
string
The updated last name of the contact
string
The updated first name of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CONTACT_DEALSTool to update an existing secondary contact (contact-deal association) in ActiveCampaign. Use when you need to modify the contact, deal, or role assignment for a secondary contact.

Input Parameters

integer
required
The ID of the secondary contact (contactDeal) to update
integer
The ID of the deal
integer
The role ID to assign to the contact on the deal
integer
The ID of the contact to associate with the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CUSTOMERTool to update an existing e-commerce customer in ActiveCampaign. Use when you need to modify customer details such as email, external ID, connection ID, or marketing preferences.

Input Parameters

string
Customer email address. Used to associate the customer with a contact in ActiveCampaign.
string
External customer ID from your e-commerce platform. Must be unique per connection.
string
required
The unique identifier of the e-commerce customer to update
integer
E-commerce connection ID in ActiveCampaign to update for this customer
string
Marketing acceptance status. Use ‘1’ for accepts marketing, ‘0’ for does not accept.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CUSTOM_FIELDTool to update an existing custom field in ActiveCampaign. Use when you need to modify field properties such as label, type, options, default value, visibility, or display order.

Input Parameters

integer
required
The ID of the custom field to update
string
The type of field: text, textarea, dropdown, date, datetime, radio, checkbox, hidden, currency, number, multiselect, or listbox
string
The label/name of the field as displayed to users
boolean
Whether the field is required
integer
The display order of the field (lower numbers appear first)
string
Default value for the field
array
Options for dropdown, multiselect, radio, or checkbox fields. Each option should be a string value.
boolean
Whether the field should be visible in forms
string
Default currency code for currency-type fields (e.g., USD, EUR)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CUSTOM_FIELD_FIELD_GROUPTool to update a custom field field group member in ActiveCampaign. Use when you need to change the display order or group association of a custom field within a field group.

Input Parameters

string
required
The field ID to associate with the group
string
required
The target group ID
integer
required
Display order number for the field in the group. Must be explicitly provided to avoid unintended resets.
string
required
The ID of the groupMember to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_CUSTOM_FIELD_VALUE_FOR_CONTACTUpdates an existing contact custom field value in ActiveCampaign by field value record ID, supplying the contact, field and new value.

Input Parameters

integer
required
The custom field ID being updated
string
required
The actual value to assign to the field
integer
required
The contact ID to associate with this field value
string
Required only for currency field types; specify the three-letter currency code (e.g., USD, EUR, GBP)
integer
required
The ID of the existing field value record to update. This is the unique identifier of the field-value association, not the field ID itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_CUSTOM_FIELD_DATAUpdates a custom deal field value in ActiveCampaign. Use when you need to modify an existing custom field value for a deal. Requires deal permission and pipeline-specific permission.

Input Parameters

integer
required
The ID of the custom field value record to update
string
required
The updated value for the field. For currency field types, this needs to be in cents not dollars. Format varies by field type: text/textarea/hidden (plain string), dropdown/radio (pipe-delimited format: ||option1||), multiselect/checkbox (array format), currency (numeric cents), number (decimal string), date (ISO format YYYY-MM-DD), datetime (ISO 8601 format)
string
Required only for currency field types; specify the three-letter currency code (e.g., USD, EUR, GBP, CAD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_CUSTOM_FIELD_METAUpdates a custom deal field metadata in ActiveCampaign. Use when you need to modify the definition of a custom field (label, options, default value, visibility, display order). Requires deal management permission and pipeline-specific permission.

Input Parameters

integer
required
The ID of the custom deal field to update
string
The updated label/name for the custom field
integer
The order in which the field should be displayed in the UI
string
The default value for the custom field
array
Array of options for dropdown, radio, checkbox, or multiselect field types. Not applicable for other field types.
boolean
Whether the field should be visible in forms

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_GROUPSTool to update an existing pipeline (deal group) in ActiveCampaign. Use when you need to modify pipeline properties such as the title, currency, or permission settings. Only the fields provided in the dealGroup object will be updated; other fields remain unchanged.

Input Parameters

string
required
The unique identifier of the pipeline to update
object
required
Object containing the fields to update for the pipeline. Only include fields you want to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_OWNERS_BULKTool to bulk update deal owners in ActiveCampaign. Use when you need to reassign multiple deals to new owners in a single API call. Requires deal management permissions, pipeline-specific permissions, and deal reassign permission.

Input Parameters

array
required
Array of deal objects to update with new owner assignments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_STAGETool to update an existing stage in an ActiveCampaign deal pipeline. Use when you need to modify a stage’s title, move it to a different pipeline, or change its display order.

Input Parameters

integer
required
The unique identifier of the deal stage to update
string
The updated name/title of the deal stage
integer
The ID of the pipeline (deal group) this stage belongs to. Use this to move the stage to a different pipeline.
integer
The updated display order/position of the stage within the pipeline. Lower numbers appear first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEALSTAGES_DEALSTool to move all deals from one stage to another stage in ActiveCampaign. Use when you need to bulk-move all deals in a specific stage to a different stage within the same pipeline. The source and target stages must belong to the same pipeline, otherwise a 422 error will be returned.

Input Parameters

integer
required
The deal stage ID from which all deals will be moved. This is the source stage ID.
object
required
Object containing the target stage ID where deals should be moved to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_TASKTool to update an existing task in ActiveCampaign. Use when you need to modify task details such as title, description, due date, assignee, status, or associated records (deal, contact, account).

Input Parameters

integer
required
The task identifier to update
integer
Updated associated deal ID
string
Updated task details or notes
integer
Updated user ID assigned as task owner
string
Updated title/name of the task
integer
Updated associated account ID
integer
Updated associated contact ID
string
Updated due date in ISO 8601 format (e.g., ‘2025-01-15T14:30:00-05:00’)
integer
Updated task type ID from available Task Types in your account
integer
Updated task status/outcome ID. Use 0 for incomplete, 1 for complete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_DEAL_TASK_TYPETool to update an existing deal task type in ActiveCampaign. Use when you need to modify the title or status of a task type used for categorizing deal tasks.

Input Parameters

integer
required
The task type identifier to update
string
Updated title/name of the task type
integer
Updated status of the task type (0=inactive, 1=active, 2=archived)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_EDIT_VARIABLETool to edit an existing personalization variable in ActiveCampaign. Use when you need to update the name, tag, content, format, or associated lists of a variable.

Input Parameters

string
required
The unique identifier of the personalization variable to update
object
required
The personalization variable object containing fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_EVENT_TRACKING_STATUSTool to enable or disable event tracking for your ActiveCampaign account. Use this to toggle event tracking on or off based on your tracking requirements.

Input Parameters

object
required
Event tracking configuration object containing the enabled status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_FIELD_VALUETool to update a custom field value by its field value ID in ActiveCampaign. Use when you need to modify an existing field value record directly. Datetime field values are converted to the account’s timezone when saved.

Input Parameters

integer
required
The field value record identifier to be updated
integer
required
The custom field ID
string
required
The updated field value. For currency fields, provide amount in cents. For date fields use YYYY-MM-DD format. For datetime fields use ISO 8601 format. For multiselect fields use ||Option1||Option2|| format.
integer
required
The contact ID associated with this field value
string
Required only for currency field types; use three-letter currency codes (e.g., USD, GBP)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_GROUPTool to update an existing permission group in ActiveCampaign. Use when you need to modify a group’s title or description.

Input Parameters

integer
required
The group’s identifier
string
The group’s name/title to update
string
Description of the group to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_MESSAGETool to update an existing message in ActiveCampaign. Use when you need to modify message properties such as subject line, sender information, content, or other email configuration settings.

Input Parameters

integer
required
The ID of the message to update
string
The HTML content of the email message
string
The internal name of the message for identification purposes
string
The plain text content of the email message
string
Message format type: ‘html’, ‘text’, or ‘mime’ (both html and text)
string
The ‘Reply To’ email address where replies will be sent
string
Character set used for the message content
string
The subject line of the email message
string
Encoding method used for the message
string
The sender’s display name that appears in the ‘From’ field
integer
The priority level of the message: 1 (high), 3 (medium/default), 5 (low)
string
The sender’s email address that appears in the ‘From’ field
string
The preheader text that appears in email client previews

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_NOTETool to update an existing note in ActiveCampaign by its ID. Use when you need to modify the content of any existing note. This is a generic note update tool that works for notes related to contacts, deals, or accounts.

Input Parameters

string
required
The unique identifier of the note to update
object
required
The note object containing the updated note content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_PRODUCTUpdate an existing product in ActiveCampaign’s e-commerce system using GraphQL. The product variant name, external store ID, and connection ID must all be supplied for an update.

Input Parameters

string
required
The unique ActiveCampaign product ID to update. This is the internal ID assigned by ActiveCampaign (e.g., ‘pr-3634478-6-UPDATE-TEST-001’).
object
required
Product fields to update. All three fields (variantName, storePrimaryId, legacyConnectionId) are required even for updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_SAVED_RESPONSETool to update an existing saved response in ActiveCampaign. Use when you need to modify the title, subject, or body of a saved response template.

Input Parameters

string
required
The ID of the saved response to update
object
required
Saved response object containing the fields to update (title, subject, and/or body)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_SCHEMATool to update a custom object schema in ActiveCampaign. Use when you need to modify schema properties or add new options to dropdown/multi-select fields. Note: For child schemas, you can only add new options to existing dropdown/multi-select fields.

Input Parameters

object
required
The schema object containing the fields and properties to update
string
required
The unique identifier (UUID) of the schema to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_SEGMENTS_V2Tool to update existing segments in ActiveCampaign using the V2 segments API. Use when you need to modify segment configurations, including filtering conditions, descriptions, or metadata. The segment ID must be in UUID format (e.g., ‘f0390c20-ce33-46ae-8c19-468f770fd1f7’), not numeric format.

Input Parameters

array
required
Array containing the segment data. Must contain a single segment object with matching ID
string
required
The unique identifier of the segment to update (must be UUID format, not numeric ID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_SEGMENTS_V2_CREATED_DATEUpdate an ActiveCampaign segment at a historic timestamp using a supplied segment definition. Only non-numeric segment IDs are supported; a valid empty response may be returned when the segment or historic state is not found.

Input Parameters

object
required
Complete segment definition with conditions, condition groups, and operators to revert to
string
required
Unix EPOCH timestamp representing the point in time to revert the segment to
string
required
The non-numeric segment identifier to revert. Only non-numeric segment IDs are supported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_SITE_TRACKINGTool to enable or disable site tracking for your ActiveCampaign account. Use this when you need to toggle site tracking functionality on or off.

Input Parameters

boolean
required
Set to true to enable site tracking, or false to disable it. Site tracking allows you to track visitor behavior on your website and trigger automations based on site visits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_USERTool to update an existing ActiveCampaign user (team member/staff account) by ID. Use when you need to modify user details such as name, email, phone, username, or group assignment. Group assignment is required.

Input Parameters

string
User’s email address
integer
required
Group ID to assign the user to. REQUIRED field. Use GET /api/3/groups to retrieve available group IDs.
string
User’s phone number
integer
required
The ID of the user to update
string
User’s last name
string
User’s username
string
User’s first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPDATE_WEBHOOKUpdate an existing webhook in ActiveCampaign to modify its configuration such as URL, events, or sources. Use this when you need to change the settings of an already created webhook.

Input Parameters

integer
required
The webhook identifier to be updated
string
The updated URL endpoint where webhook data will be posted. Must be a valid HTTP/HTTPS URL that can accept POST requests
string
The updated name of the webhook to identify it
array
Updated array of event types that will trigger the webhook. Common events include ‘subscribe’, ‘unsubscribe’, ‘sent’, ‘open’, ‘click’, ‘bounce’, ‘reply’. Use the List Webhook Events action to see all available events
array
Updated array of actions to trigger the webhook. This specifies which actions should trigger the webhook
array
Updated array of sources that can trigger the webhook. Common sources are ‘public’, ‘system’, ‘admin’, ‘api’. ‘public’ allows events from public pages, ‘system’ from internal processes, ‘admin’ from admin actions, ‘api’ from API calls
string
External identifier for the webhook. This can be used to reference the webhook from external systems

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_ACCOUNTCreate or update an ActiveCampaign account by name. Searches one page of accounts and updates the first exact name match, or creates an account if no match is returned; the account URL is required, with owner and custom fields optional.

Input Parameters

string
required
The name of the account. This is used to match existing accounts - if an account with this exact name exists, it will be updated; otherwise, a new account will be created.
integer
The user ID of the account owner in ActiveCampaign. Must be a valid user ID from your ActiveCampaign account.
array
List of custom field values to set on the account. Each field requires a customFieldId and fieldValue.
string
required
The website URL associated with the account (e.g., company website)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_ORDERCreate a new order or update an existing order in ActiveCampaign. Existence is determined by the combination of legacyConnectionId and storeOrderId. Use this to sync order data from your e-commerce platform.

Input Parameters

string
Customer email address. If provided, the order will be associated with the contact having this email.
array
List of order-related notes
string
Associated cart identifier if the order originated from a cart
string
Currency code (ISO 4217 format, e.g., USD, EUR, GBP)
string
URL to view the order in the store
string
Store location identifier
number
required
Final order amount (total paid including tax and shipping). Must be a positive number.
string
Human-readable order number displayed to customers
string
Store-defined order status (free-form text)
boolean
Flag indicating if this is a test order
string
Sales channel through which the order was placed
string
required
Unique order ID from the store. This is used with legacyConnectionId to identify existing orders for updates.
string ("REAL_TIME" | "HISTORICAL")
required
Source of order creation. Use REAL_TIME for orders created in real-time or HISTORICAL for imported historical orders.
string
Customer’s locale/language preference
number
Shipping cost
string
Shipping method used
boolean
Whether the customer accepts marketing communications
string ("PENDING" | "COMPLETED" | "ABANDONED" | "REFUNDED" | "CANCELLED")
Predefined ActiveCampaign order state.
string
Store’s customer identifier for associating the order with a customer
string
required
ISO 8601 timestamp when order was created in the store (e.g., ‘2026-02-12T10:00:00Z’). Must be in UTC format.
string
ISO 8601 timestamp when order was last modified in the store
integer
required
ID of the ecommerce connection (must exist in the account). This identifies which e-commerce connection to use for the order. You can find this ID in your ActiveCampaign DeepData Connections settings.
string
Externally-sourced order ID from another system
boolean
Whether this order was created by a recurring payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_ORDERS_BULKInsert multiple orders or update them if they already exist in ActiveCampaign. This action uses the GraphQL bulkUpsertOrders mutation to synchronously create or update multiple e-commerce orders in a single request. Orders are matched by storeOrderId - if an order with the same storeOrderId exists for the given connection, it will be updated; otherwise, a new order will be created. Use this action when you need to sync multiple orders from your e-commerce system to ActiveCampaign in an efficient manner. This is ideal for batch imports, periodic syncs, or processing multiple orders at once.

Input Parameters

array
required
Array of order objects to create or update. Each order will be upserted based on the storeOrderId - if an order with that ID exists, it will be updated; otherwise, a new order will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_ORDERS_BULK_ASYNCTool to insert or update multiple orders asynchronously in ActiveCampaign with high throughput. This action performs data store writes completely asynchronously, making it much faster than synchronous bulk operations. Recommended for all stores processing large volumes of orders. Use when you need to import historical orders or sync real-time order data from e-commerce platforms.

Input Parameters

array
required
Array of order objects to insert or update. Each order will be created if it doesn’t exist (based on storeOrderId and legacyConnectionId), or updated if it already exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_PRODUCTSCreate or update multiple products in a single request using ActiveCampaign’s GraphQL API. This action uses the bulkUpsertProducts mutation to efficiently create or update multiple products at once. The API automatically deduplicates entries with identical storePrimaryId and legacyConnectionId combinations, ensuring no duplicate products are created.

Input Parameters

array
required
Array of products to create or update. Entries with identical storePrimaryId and legacyConnectionId combinations will be deduplicated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_CAMPAIGN_UPSERT_RECURRING_PAYMENTS_BULKCreate or update multiple recurring payments asynchronously in ActiveCampaign. Use this action to sync subscription data from your e-commerce platform to ActiveCampaign for automated marketing and customer tracking.

Input Parameters

array
required
Array of recurring payment objects to create or update. Each payment is uniquely identified by the combination of legacyConnectionId and storeRecurringPaymentId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not