ActiveCampaign is a marketing automation and CRM platform enabling businesses to manage email campaigns, sales pipelines, and customer segmentation to boost engagement and drive growth
Set 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.
Add 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.
Adds 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.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
Add 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.
Add 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.
Add 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.
Adds 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.
Tool 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.
Apply up to 100 distinct tags to a contact in one idempotent request. Supply tag names, existing tag IDs, or both (at most 200 references after deduplication within each array). Unknown names create account-wide tags by default and require pg_tag_manage; set createMissing=false or use tagIds to avoid creation. Applying existing tags requires contact edit permission and access to the contact. Repeats return the existing associations.
Create a business goal and associated segment/conversion tracking from a JSON-encoded schema. Supply schema as a string containing JSON, including businessGoal.name. The provider does not document the full internal schema. This operation can fail when segment generation is unavailable or the goal name already exists.
Tool 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.
Associate conversions with labels (folders) in bulk. Creates associations, not conversions or labels. The provider can reject individual items while creating others; inspect added, errors and meta rather than treating HTTP success as proof that every item was created.
Create multiple deal custom field values in one request. Requires permission to manage the deals and their pipelines. Supply existing deal and custom-field metadata IDs; this does not define fields or create deals. The acknowledgement does not include individual value-record IDs.
Delete multiple conversion-to-label associations by their association IDs. Removes associations, not the conversions or labels themselves. Returns the provider's JSON object without assuming a particular success envelope.
Tool 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.
Activate or deactivate the automations listed in seriesIds in one call. This mutates every listed automation; it does not list automations or change workflow contents. Status 1 activates and status 2 makes inactive. Discover IDs with List Automations. Omitted options retain provider defaults.
Bulk 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.
Queue up to 250 email-matched contact creates or updates asynchronously. Returns a process ID with HTTP 202, not individual row outcomes. Invalid or inaccessible rows are skipped independently without failing the batch and their outcomes are not available through the API. Reads may lag acceptance. Use single-contact sync for individual write results, or bulk import for row-level reporting, list subscriptions, and tags. Requires pg_subscriber_add.
Tool 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.
Replace multiple existing deal custom field values in one call. Supply value-record IDs obtained from deal custom field data, not deal IDs or custom field definition IDs. This does not create fields or value records.
Tool 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.
Insert 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.
Tool 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.
Create 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.
Tool 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.
Creates 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.
Tool 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.
Creates 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.
Tool 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.
Tool 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.
Tool 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.
Associate a sender address with a user group using their IDs. A new association returns 201 and side-loads the saved address. A duplicate returns the existing association with 200. IMPORTANT: creating a new association clears allgroup on this address AND every other address that has it set, restricting those addresses to their explicit group associations.
Associate a sender address with a list using their IDs. Creates an association with 201, or returns the existing record with 200 if the same address and list are already associated. Does not subscribe contacts or send messages.
Tool 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.
Create an ActiveCampaign brand kit from a public website or manually supplied brand data. Manual data takes precedence when both sources are supplied. Enrichment of tone and competitors is asynchronous.
Tool 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.
Tool to create a new campaign in ActiveCampaign. Use when you need to create a broadcast email campaign or automation campaign.
Associate a message with a campaign, including a recipient share for split (A/B) campaigns. Does not send the campaign. Requires the campaigns feature and access to the campaign; sending statistics are read-only.
Tool 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.
Tool 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.
Create a brand-new contact in ActiveCampaign; duplicate emails fail with 422. Requires add contacts permission. Use Create or Update Contact to upsert by email instead. Optional lists/forms can send messages or run automations; tags/accounts may be created even if the contact subsequently fails validation.
Create 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.
Create a conversion definition for measuring campaign or automation effectiveness. Optionally configure a dollar value, currency, dynamic-value field and per-contact trigger limit. This creates the definition, not a contact conversion event.
Associate an existing conversion with an existing label/folder. Creates the association row, not the label itself. If the pair already exists, returns the provider's message instead of creating another association.
Create a named custom field group within an existing group type. Discover valid groupType IDs with GET /groupTypes. This creates the group container; it does not create fields or assign fields to the group.
Create a custom object schema defining fields and relationships in ActiveCampaign. Use before creating custom object records. Requires custom objects access on the connected account; schema slugs must be unique.
Tool 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.
Create a new ActiveCampaign deal in a pipeline. Supply an account or primary contact and a pipeline or stage. Supply an owner when auto-assignment is disabled. An unmatched contact email creates a contact.
Tool 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.
Creates 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.'
Tool 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.
Tool 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.
This 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.
Tool to duplicate an existing campaign in ActiveCampaign. Use when you need to create a copy of a campaign with the same configuration and content.
Create a reusable email template; this does not send an email or campaign. Requires CreateEmailTemplates permission. Templates are available to the authenticated user's accessible lists; administrators create account-wide templates. Supply a name and optionally content, default subject, designer settings or a source campaign/template to copy.
Tool 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.
Add one option to an existing dropdown, listbox, radio or checkbox custom field. Confirm the field definition ID with GET /fields/{id} first: the provider silently creates orphan options for invalid IDs. An existing option with the same value is returned unchanged (200); otherwise an option is created (201). For several options use Add Custom Field Options instead.
Create a form; requires permission to edit forms. Does not submit the form. New forms start active even if options.paused is supplied. Non-inline/ipad/chat layouts require plan support; Preference Centers are limited to 20 per account. Creating a chat layout returns the existing chat form if there is one.
Submit 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.
Create a new permission group with a title and optional initial permissions. This creates a group; it does not assign users or alter existing groups. Omitted settings use provider defaults. Returns the created group's ID.
Tool to create a new list in ActiveCampaign. Use when you need to create a subscriber list for organizing contacts and sending campaigns.
Creates 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.
Save a new segment with a 24-hour TTL and start a match-all contact request. Returns one page if ready within four seconds, otherwise segment_id and run_id for polling. Use instant='' to return immediately. This creates a segment; it does not send messages to the matching contacts.
Create a match-some evaluation of a saved segment with additional criteria. Returns one page of matching contact IDs and a run ID for later result retrieval. Use instant='' to start asynchronously, then poll the match-some result endpoint.
Tool 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).
Tool 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.
Create 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.
Create a note on a contact by ID, authored by the authenticated API user. Requires edit contacts permission. Published notes fire contact-note webhooks; use is_draft=1 to suppress them. Mentions notify matching users. The path determines ownership; use Add Contact Note instead to look up a contact by email.
Create 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.
Tool 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.
Create 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.
Create a public custom object schema associated with an application. Use public schemas as parents for child schemas shared across customers. Supply the application's CX App Studio ID in schema.appId.
Tool to create a new saved response in ActiveCampaign. Use when you need to create a reusable email template with title, subject, and body content.
Tool 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.
Tool to create a shareable link for a campaign template in ActiveCampaign. Use when you need to generate a URL that can be shared with others to access a specific campaign template.
Create an SMS broadcast draft with a name and message body. This operation does not send SMS. Only draft status is accepted. Sending to U.S. numbers separately requires approved A2P 10DLC registration, submitted by an admin under SMS > Registration; draft creation does not prove readiness to send.
Request AI-generated SMS broadcast draft content from a prompt and tone. Returns a requestId for asynchronous generation, not a completed message or a send confirmation. Does not schedule or send SMS. The account must have SMS access and satisfy the provider's SMS registration prerequisites.
Tool 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).
Tool 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.
Create 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.
Link a task outcome to a deal task type. The provider labels this operation WIP. Requires Task Outcomes to be enabled on the account. Returns the created relation and its resource links.
Creates 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).
Create a reusable personalization variable for campaign content. Supply its tag, name, format and content in personalization. Associate it with comma-separated list IDs (the provider may require these). Creating a locked variable is refused by the provider; omit isLocked or set it to false.
Create 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.
Permanently 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.
Deletes 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.
Tool 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.
Tool 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.
Permanently 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.
Tool 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.
Delete an address-to-list association by its AddressList record ID. Removes the association, leaving the address and list intact. Returns the provider JSON object, normally empty. A missing association returns 404.
Tool 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.
Remove an address's association with a user group using address and group IDs. Does not require the addressGroup record ID and does not delete the address or the user group. Returns the provider JSON object (normally empty). A missing association returns 404; both IDs must be positive integers.
Remove an address-to-list association using address and list IDs. Use when the addressList record ID is unavailable. Does not delete the address or list. Both IDs must be positive integers. Returns the provider JSON object (normally empty); a missing association returns 404.
Permanently delete a brand kit and its generated templates, preview images, and brand history. Deleting the primary kit makes the most recently created remaining kit primary. Returns an empty object for HTTP 204; a missing kit produces a provider error.
Tool 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.
Tool 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.
Delete an existing campaign by archiving its row. Removes folder associations, pending approval requests, queued automation sends, and campaigns referencing this campaign as their source. Missing campaigns and insufficient delete permission raise an error even if the provider returns 200.
Delete the association between a campaign and a message. The underlying message is not deleted. Requires the campaigns feature and access to the associated campaign. Use the campaign-message association ID, rather than the campaign ID or message ID.
Permanently 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.
Permanently 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.
Delete a conversion definition by ID. Also deletes its triggers, contact-conversion records and business-goal (ConversionFolder) associations. Use List Conversions to discover IDs before this destructive operation.
Remove a conversion's association with a label by the association's ID. Does not delete the label/folder or the conversion itself. Returns the provider's JSON object without assuming an undocumented success envelope.
Tool 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.
Tool 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.
Permanently 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.
Irreversibly delete a field and its associated record data from a private schema. Requires an admin user; public and child schemas cannot be changed this way. The API accepts deletion asynchronously (202). Deleted field IDs are not immediately reusable; showFields='all' exposes marked_for_deletion fields.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
This 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.
Tool to delete an existing deal role in ActiveCampaign. Use when you need to permanently remove a deal role that is no longer needed.
Delete 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.
Permanently 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.
Permanently delete an existing email template by ID. Associated designer instances and list associations are also removed.
Tool to delete an event tracking event from ActiveCampaign. Use when you need to remove an event name from the tracking whitelist.
Delete one dropdown, listbox, radio or checkbox custom field option. Leaves the field and its other options intact. Existing contact values equal to the deleted option remain unchanged until those contacts are edited. Use a field option ID, never the parent custom field definition ID. Returns 404 when the option does not exist.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
Permanently 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.
Remove a user group's access to a list by permission record ID. Discover the permission record ID with GET /listGroups. This removes the group's list access and rebuilds list permissions for every user in the account. It does not delete the list or group. Returns the provider's JSON object (normally empty); missing records return 404 and forbidden ones 403.
Permanently 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.
Permanently delete multiple campaigns by IDs or delete the oldest 1–10. Requires campaign-delete permission and the Campaigns module. Deletions are not transactional: inspect both deleted and failed for partial success. When no campaigns can be deleted, the provider returns an error.
Delete multiple contacts by IDs or all actively subscribed contacts on accessible lists. Optionally restrict list removal with listids. Contacts left on no list are deleted and archived for 360 days. Deletion is synchronous and nontransactional; inspect deleted and failed for partial success. Requires delete permission and an accessible list; large requests may time out or hit the plan's delete allowance.
Permanently delete several user permission groups in one request. Users and deal groups are reassigned to the surviving group specified by `to`. Deleted groups are also removed from automations. Select source and destination groups carefully to preserve users' access and permissions.
Permanently 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.
Permanently delete a note from its owning contact. Requires edit contacts permission and the note's author or an admin user. A note belonging to another contact, a deal, or an account returns 404. Returns the provider's empty JSON object after successful deletion.
Delete a product from ActiveCampaign's e-commerce catalog by ID using the deleteProduct GraphQL mutation. Returns the mutation's boolean result.
Delete a custom object record from ActiveCampaign by schema ID and external ID. Returns the supplied schema ID and external ID on a successful response.
Tool 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.
Permanently 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.
Permanently 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.
Permanently delete a segment from ActiveCampaign by its UUID, including its historic versions. The response may include data returned by the API after deletion.
Soft-delete an SMS broadcast by ID and return its details. Does not send SMS.
Tool 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.
Permanently delete an existing task outcome by its ID. Returns the provider's JSON object, normally empty. Use only for an outcome you intend to remove; this does not delete a task or a task type.
Delete an existing relation between a task type and a task outcome. Requires Task Outcomes to be enabled for the account. Deletes only the relation, not the task type or outcome. Returns the provider's JSON object, normally empty.
Permanently 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.
Permanently 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.
Permanently 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.
Disable a conversion's target for a business goal using its conversion-label association ID. This removes the target, not the conversion or business goal. Returns the provider's confirmation and any additional response fields.
Disable a conversion's target for a business goal using their IDs. Returns the provider's JSON object without assuming an undocumented envelope.
Generate a workflow proposal from a prompt without saving an automation. Persisting the proposal requires a separate automation build call. Requires permission to manage automations. Returns removed action and trigger types that the account cannot use; the proposal must contain exactly one workflow.
Update the name of an existing ActiveCampaign campaign by its ID.
Export an SMS broadcast's recipients, including full contact records, as CSV. Optional date, engagement, deliverability, search and ordering filters are sent in a JSON body. This does not send or schedule SMS messages.
Export existing SMS broadcast performance metrics as CSV, optionally selecting broadcast IDs. Reads reporting state only; does not send or schedule SMS messages.
Find 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.
Find 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.
Find 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.
Tool 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.
Retrieves 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.
Retrieve metadata for a specific account custom field by ID. Returns details including field label, type, options, default value, visibility settings, and timestamps.
Retrieve one contact activity entry by its activity ID from GET /activities. Does not refresh the feed or attach the underlying record, notes or recipients. Use reference.type and reference.id to read the underlying record separately. A missing entry or one hidden by caller permissions returns 404.
Retrieves 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.
Retrieve an address-to-user-group association by its association record ID. Discover association IDs with GET /addressGroups. The association ID is distinct from the address ID and user group ID. Returns those IDs, timestamps and links. A missing association returns 404.
Retrieve one address-to-list association by its association record ID. Discover IDs with List Address List Associations (GET /addressLists). The association ID differs from its address and list IDs. Returns related IDs and timestamps; a nonexistent association returns 404.
Retrieve the status of an asynchronous AI SMS broadcast generation or update. Supply the requestId returned by the AI creation or update operation, not a broadcast ID. Returns the execution status and broadcastId when available. Reads status only; does not generate content, schedule, or send SMS.
Get 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.
Retrieve one archived contact using its original contact ID. Returns the snapshot at archive time and its deleted_at timestamp. Unlike listing archives, this read is not Admin-only, has no 360-day limit, and includes no is_restorable flag. Active or permanently deleted contacts return 404. Use List Archived Contacts to discover archived IDs.
Retrieve 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.
Retrieve one automation's metadata by ID, including its name and status. Does not return workflow triggers, actions, or conditions. Discover the ID with List Automations; use the automation blocks endpoint for workflow contents.
Retrieve the trigger, actions, waits, conditions, and goals inside one automation. Use List Automations to discover its ID. Returns block IDs, parent/order, types, and parameters; this is not contact run history or an account-wide list.
Retrieve a contact automation run's status, progress and optional end record. Use a contactAutomation enrollment ID, not an automation or contact ID. Non-admin users can read only contacts on accessible lists or on no list. Missing runs return 404 for admins and 403 for other users. No pagination.
Read one automation's start triggers to understand how contacts enter it. Returns trigger IDs, types, and trigger-specific params. Use List Automations to find the automation ID. This is not the account-wide trigger-type catalog or a contact's automation run history.
Retrieve one brand kit by UUID, including brand data and primary-kit status. Obtain the UUID from List All Brand Kits. Competitors and tone are returned by their separate retrieval endpoints, not by this operation.
Retrieve competitors and their extraction status for any brand kit. Competitors are stored separately and are absent from Get Brand Kit and List Brand Kits. An empty list is final only when status is complete. This read does not start or refresh extraction.
Retrieve the voice and tone of any brand kit, with extraction status. Tone is stored separately and is absent from Get Brand Kit and List Brand Kits. An empty tone is final only when status is complete. This read does not start or refresh extraction.
Tool 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.
Retrieve 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.
Fetch 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.
Tool 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.
Tool 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.
Retrieve one business goal (initiative/folder) by ID. Discover initiativeId with List Business Goals. Optionally include linked conversion labels and asset association counts. This does not list individual linked assets; use Get Business Goal Data for those details.
Retrieve one business goal by ID with linked assets and conversion trigger details. Discover initiativeId using List Business Goals. Unlike the listing, this read always includes linked assets and available conversionEvents; no include flag or pagination is needed.
Tool to retrieve a specific calendar feed from ActiveCampaign by its ID. Returns calendar details including title, type, token, notification settings, and creation/modification dates.
Tool 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.
Get automation information associated with a specific campaign in ActiveCampaign. This action retrieves automation details linked to a campaign ID.
Retrieve a single campaign by its ID from ActiveCampaign. Returns comprehensive campaign details including engagement metrics, content configuration, and automation settings.
Get all links associated with a specific campaign in ActiveCampaign. Use when you need to retrieve tracking links, read trackers, and other URLs associated with a campaign.
Get the message associated with a specific campaign in ActiveCampaign. Returns message details including subject, content (HTML and text), sender information, and configuration settings.
Get campaign messages associated with a specific campaign in ActiveCampaign. Returns an array of message objects linked to the campaign ID.
Get 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.
Retrieve 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.
Tool to retrieve the number of times a contact has entered each automation. Use when you need to understand a contact's automation engagement history.
Retrieve recorded steps and skip reasons for one contact automation run. Discover the enrollment ID through List Contact Automations or a contact's automations. An existing enrollment with no recorded steps returns an empty list; this does not explain why a contact never entered. A run not belonging to the specified automation returns 404. No pagination is documented.
Retrieve all automations that a specific contact is enrolled in or has been enrolled in. Returns automation enrollment details including status, progress, and completion information.
Retrieve all bounce log entries for a contact, including bounce dates, codes and campaigns. Returns an empty list if the contact has no bounces. This path returns every entry in one call; date filters and pagination are not supported.
Retrieve the contact that owns a tracking-log entry. Discover eventId from GET /trackingLogs or GET /contacts/{id}/trackingLogs. This is not an event name or contact ID; use GET /contacts/{id} for contact lookup by contact ID. Missing tracking-log entries return 404.
Retrieve 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.
Retrieve one contact data record by its own ID (not the contact ID). Returns geographic data and legacy social/analytics columns. Discover record IDs via GET /contactData or GET /contacts/{id}/contactData. A deleted contact may still have a data record; missing record IDs return 404.
Retrieve the deal associations where a contact is a secondary contact. Returns contactDeals with sideloaded deals and their primary contacts. For deals where this contact is primary, use Get Contact Deals instead. All links are returned in one call: this endpoint ignores limit/offset and guarantees no ordering. Users without permission to list all deals see only their owned deals. A nonexistent contact returns 404.
Tool 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.
Tool 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.
Tool 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.
Retrieve 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.
Retrieve 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.
Retrieve one contact import log row by its row ID from GET /contactImports. Rows cover successful, failed and partly imported contacts from app, API and integration imports. This is not a batch status lookup: use GET /import/info with a batchId for API batch results. Returns 404 when no row has this ID. Any API user can read all account rows, including other groups' emails.
Retrieve one contact list subscription by its membership record ID. Discover IDs using GET /contactLists?contact= or the contact's contactLists link. This is not the list ID or contact ID. Returns membership status, timestamps and related links; missing memberships or deleted lists return 404.
Tool 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.
Tool 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.
Retrieve 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.
Tool 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.
Retrieve a contact's plus append enrichment data from ActiveCampaign, including available social media profile information, profile image URLs, and enrichment service update timestamps.
Retrieve progress of a running or finished contact restore by request ID. Requires an Admin API user; other users receive 404. A nonexistent ID or an ID belonging to another account returns 500. When finished_at is set, contacts_restored + contacts_failed + contacts_to_be_skipped equals contacts_matching. This read does not restore or change contacts.
Tool to retrieve all score values associated with a specific contact in ActiveCampaign. Use when you need to see scoring data for a contact.
Retrieve one contact-to-tag association by its association ID. Discover the ID from contactTags listings or when applying a tag. Returns contact and tag IDs, timestamps and related links. To retrieve the tag definition itself, use Get Tag. A missing association returns 404.
Tool to retrieve all tags associated with a specific contact in ActiveCampaign. Use when you need to see which tags are applied to a contact.
Retrieve 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.
Retrieve daily contact and unsubscribe totals for an inclusive date window. Omit list_id or send 0 for all lists the caller can access. Results reflect current membership rows, not an event log: deleted contacts are absent and resubscribed contacts use their latest subscription date. Returns one report, with no pagination.
Retrieve a Content Manager file's metadata by its integer ID. Returns title, alt text, MIME type, size, dimensions, keywords, storage keys and last-change information. Storage keys resolve against the returned baseUrl, which is not necessarily public. Unlike file searches and lists, retrieval by ID can return a deleted file. A nonexistent file returns 404.
Retrieve one custom Content Manager folder by its ID. Discover folder IDs using List Content Manager Folders. Returns the folder's metadata; this operation has no documented filters or pagination.
Retrieve a conversion's definition by its ID, including its value settings. Use List Conversions to discover IDs. This reads the conversion definition, rather than its associated contact-conversion events or reporting data.
Retrieve a conversion-label association by its association ID. A conversion label links a conversion to a folder; this does not retrieve the folder itself. Optionally enrich the result with conversion details.
Retrieve event, unique-contact and revenue metrics for one conversion ID. Optionally filter by start and end dates. Returns the metric object directly, without a conversion/conversions wrapper, or {} (documented) / [] (observed live) if the range has no data. This operation exposes no pagination parameters.
Retrieve one conversion's counts, values and graph series by conversion ID. Optionally filter dates or include business-goal backfill and overlay data. Returns the conversions array wrapper, not the conversion definition.
Retrieve 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.
Retrieve one custom field's group membership and display order. Use the membership id returned by List All Group Members. This retrieves a groupMember relationship, not a user permission group or group definition.
Tool 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.
Retrieve a conversion's daily event count, unique contacts and total value. Use List Conversions to discover the conversion ID. Optional date filters select a window of at most 30 days. Omitted dates use the provider's default window.
Retrieves 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.
Retrieve 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.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
Retrieve completed/recovered-order customers by store and new, repeat or inactive behavior. Defaults to the last 30 days. Inactivity is measured from endDate using only in-window orders, so windows of 90 days or less have no inactive customers. Groups do not overlap; totals across stores can count a person more than once.
Retrieve ecommerce order counts by state and completion/abandonment percentages. Filter by a paired date window and optionally one store. Defaults to the last 30 days across stores. Total orders includes every state and is not comparable with the revenue summary's order_count. Returns a single summary, not pages.
Retrieve revenue, order counts and distinct customers for completed/recovered orders. Defaults to the last 30 days, based on order creation in the store, not ingestion. Excludes pending and abandoned carts. Totals are separated by currency and store; amounts are numeric strings in minor units with formatted display strings beside them. Returns one summary, without pagination.
Get the stored Stripo designer HTML and CSS for one campaign message. Returns the editable design, not the compiled email. Strings are returned as stored, with escaped conditional-content comment markers restored by the provider. Returns 404 if the message has no stored designer markup, including when the message ID does not exist.
Tool to retrieve the event tracking status for your ActiveCampaign account. Use this to check whether event tracking is enabled or disabled.
Retrieve one exclusion rule by ID, including its phrase and channel scope. Exclusions suppress sends to matching addresses or numbers, even for active contacts. They are not unsubscribed or bounced contacts. Discover IDs with the exclusions list endpoint.
Retrieve account exclusion rules that suppress sends to matching addresses or numbers. Filter by match phrase or list IDs and sort by phrase or lists. Rules can apply to all channels, all email, all SMS, or several lists. These are not unsubscribed or bounced contacts; meta.total counts rules. Returns one provider response.
Retrieve one field option by its option ID, including its label and stored value. Discover the ID using GET /fieldOptions or the fieldOptions array of GET /fields. The returned field property is the parent field definition ID to use on /fields/{id}; option IDs and field definition IDs are separate identifiers. Returns 404 when no option has the requested ID.
Retrieve one custom field-to-list relationship using its relationship ID. Discover relationship IDs using GET /fieldRels. The returned relid is a list ID, or 0 when the field is available on every list. Returns 404 if no relationship has this ID.
Tool 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.
Retrieve the custom Content Manager folders containing an existing file. Supply a file ID discovered using Search Content Manager Files. Returns an unwrapped array of folder IDs and names; an empty array means no custom folder memberships. This operation has no documented pagination parameters.
Retrieve a single form by its ID from ActiveCampaign. Returns comprehensive form details including field configuration, styling, submission behavior, and metadata.
Retrieve one location resolved from contact IP addresses by its location ID. Discover location IDs with List Geographical Addresses. A location is shared by addresses resolving to the same coordinates. Returns 404 if it is absent.
Retrieve one recorded geo IP entry and its resolved location by entry ID. Discover entry IDs with the geo IP listing or a contact's geo IP list. The location array is absent when the entry has no location; missing entries return 404.
Retrieve an automation goal by ID, including its block and relationship links. Discover the ID with List Goals. This is an automation workflow goal, not a business goal or a contact's goal-completion record. This call is read-only.
Retrieve statistics for an automation goal, including entries and reached contacts. Supply an automation goal ID from List Goals, not a business goal ID. Returns the top ten tags and lists plus time-to-goal buckets; there is no pagination.
Retrieve completion statistics for an automation goal, ranked against its peers. Statistics are zero when the automation has not been entered yet.
Retrieve 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.
Tool 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.
Retrieve 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.
Retrieve hosted-account plan, contact limits, trial/credit status and settings. Requires an API key belonging to an Admin-group user. Returns the flat hosted account information, not CRM organizations from /accounts. No pagination.
Retrieve pipelines a given user cannot access for the supplied deal IDs. This is a read-only permission check. Both the user ID and deal IDs are required. The provider documents no pagination for this endpoint.
Retrieve the location resolved from one geo IP entry. Discover entry IDs from geo IP listings. Returns an empty object if the entry has no location, and fails with 404 if the geo IP entry does not exist.
Retrieve a list-group permission by its permission record ID. Discover the record ID using GET /listGroups. Returns the list and user group IDs, read-only permission flags, and related links. The record ID is not the list or user group ID. Missing records return 404; inaccessible ones return 403.
Retrieve mailing lists in ActiveCampaign for subscription management, including list IDs and information. Supports name filtering and pagination via limit and offset.
Retrieve 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.
Tool 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.
Retrieve 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.
Retrieve personalization variables from ActiveCampaign, with limit and offset pagination. Use this to list custom variables used for personalization in campaigns and automations.
Retrieve the account's default (primary) brand kit. Falls back to the most recently created kit if none is marked primary. Optionally include stored site pages or a summary; requesting a summary can generate it from an existing snapshot, but never scrapes the website.
Retrieve 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.
Retrieve a page of ecommerce products ranked by revenue, quantity or order frequency. Counts only completed and recovered orders, excluding abandoned and pending carts. Aggregates by external product ID within each connection: a product sold in two stores appears twice. Omit both dates for the last 30 days.
Retrieve 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.
Retrieve a custom object record from ActiveCampaign by schema ID and external ID.
Tool 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.
Retrieve 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'.
Retrieve one configured score by ID, including its name, status and resource links. Discover IDs with List All Scores. Returns the scoring configuration, rather than the numeric score values assigned to individual contacts or deals.
Tool 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.
Tool 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.
Tool 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.
Retrieve segment match evaluation for a contact in ActiveCampaign. Use this to determine if a specific contact matches the criteria of a given segment.
Check 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.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
Tool to retrieve the site tracking status for your ActiveCampaign account. Use this to check whether site tracking is enabled or disabled.
Retrieve the full details of one SMS broadcast by ID. Does not send SMS.
Tool 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.
Tool 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.
Render a campaign message as raw MIME or parsed headers, bodies and attachments. Personalizes for an address without delivering email. Requires the Campaigns module; use messageId 0 for a non-split campaign.
Tool 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.
Tool 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.
Retrieve one task type/outcome relation by its relation ID. Returns the related task type and outcome IDs, display order, audit timestamps and resource links. Requires Task Outcomes to be enabled in the account.
Retrieve a single template by its ID from ActiveCampaign. Returns comprehensive template details including content, subject, and configuration settings.
Retrieve a single tracking log entry using its entry ID, not a contact ID. Discover IDs with GET /trackingLogs or GET /contacts/{id}/trackingLogs. Returns the event type, value, timestamp and contact link; missing entries return 404.
Tool 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.
Tool 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.
Tool 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.
Retrieve user-group relationships for a specific ActiveCampaign group, including associated user IDs.
Tool 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.
Retrieve 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.
Lists account-contact associations in ActiveCampaign, with optional account and contact filters. Results are paginated using limit and offset.
Lists 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.
Lists a page of account custom field metadata in ActiveCampaign, including field types, labels, options, and required-field settings. Supports limit and offset pagination.
List one page of associations between sender addresses and user groups. Each association links one address to one group. Addresses available to every group use the address's allgroup flag instead and may have no association. The collection supports pagination but no filtering.
List one page of associations between sender addresses and lists. Each record links one address to one list and has its own association ID. The collection supports limit/offset pagination but no filtering. For a single address's associations, use GET /api/3/addresses/{id}/addressList instead.
Tool 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.
Tool 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.
Tool to list all calendar feeds in ActiveCampaign. Use when you need to retrieve all available calendar feeds for the account.
List 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
List custom field values across ActiveCampaign contacts, including field IDs, values, contact associations, and timestamps. Returns up to 100 values per request.
Tool 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.
Lists a page of deal activities across ActiveCampaign deals, including activity history such as notes, tasks, and other interactions. Supports limit and offset pagination.
Tool to retrieve all deal roles in ActiveCampaign. Use when you need to view available deal roles that can be assigned to contacts in deals.
Tool 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.
List deals from ActiveCampaign with title search and filters for stage, pipeline, owner, or status. Results can be paginated using a limit and offset.
Tool 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.
List ActiveCampaign group members linking custom fields to their display groups. Supports pagination with limit and offset.
List notes in ActiveCampaign across related entities, with pagination support.
Tool to list all custom object schemas in ActiveCampaign. Use when you need to retrieve all schema definitions including their fields, relationships, and metadata.
Tool to list all scoring rules configured in ActiveCampaign. Use when you need to retrieve all available scores for contacts or deals.
List a page of secondary contacts (contact-deal associations) in ActiveCampaign, using limit and offset to paginate.
Tool to retrieve all tags in ActiveCampaign with search functionality. Use when you need to list or search for tags.
Tool to list all whitelisted domains for site tracking in ActiveCampaign. Use when you need to retrieve all domains that are allowed for site tracking.
List one page of deleted contacts retained in the archive for 360 days. Requires an API user in the Admin group; other users receive 404. Normal contact listing never includes these records. Supports exact filters, millisecond archive date bounds, sorting, and limit/offset pagination. A single non-email search word ignores date bounds (provider defect).
List saved segment summaries (audiences) in ActiveCampaign, with optional page and page size. Results may include configuration, conditions, and metadata.
List contacts currently in, or that have run through, one automation. Returns a single page of contact enrollment records, not contact profiles. Use limit and offset to page through meta.total. Supports contact, status, last-block and entry-date filters and ordering.
List 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.
List one page of account-wide bounce logs, with contact and exact timestamp filters and timestamp sorting. Timestamp ranges are not supported: sort and page until the desired time boundary. meta.total counts matching entries.
List all brand kits on the account, optionally ordered by creation time. Includes brand identity, styling and the primary-kit flag. The provider documents no pagination parameters for this operation.
List existing ActiveCampaign branding resources, including site logos, headers, footers and templates. Returns one provider response; the documented operation exposes no pagination parameters.
Tool 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.
Tool 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.
List one page of business goals with inline conversions and optional assets. Conversion trigger details are only available from the single-goal endpoint. Association-count and conversion-label flags are accepted but have no effect.
List ActiveCampaign campaigns, including standard and automation campaigns. Results are paginated, with optional automation filtering and sorting.
List a page of contact automation enrollments in ActiveCampaign, with optional limit and offset. Enrollment details can include status, dates, and progress.
List one page of account-wide contact data, mostly geographic information. Select by data record IDs (not contact IDs), or page with limit and offset. There are no filters or ordering options; order is not guaranteed. Records can outlive deleted contacts. Legacy analytics/social fields are no longer written. Any API user can read every contact's record using this endpoint.
List one page of account-wide contact import log rows, optionally by row IDs. Rows have no defined order; filters and ordering are not supported. Each input row writes a log row, or one per skipped subscription for partial imports. Use import history and its detail endpoints for an app/integration import's failures, or import info with batchId for a bulk import. This endpoint cannot filter to an import. Any API user can read all rows, including other groups' import emails.
List one page of contact-to-list subscriptions, with contact, state and source filters. Returns membership rows, not contact profiles. Use limit and offset to page. List/date filters and ordering are unsupported. To list or count contacts on a specific list, use the contacts listing with listid instead.
List one page of contact-tag associations, optionally filtered by contact/tag. Association IDs identify rows to remove with DELETE /contactTags/{id}. Deleted tags' associations are included, but deleted contacts' are omitted. For contacts carrying a tag, use the contacts listing instead. cdate filtering matches an exact timestamp; for a since-date query, order cdate descending and page until the cutoff. Any API user can read account-wide associations.
List all custom Content Manager folders with their IDs and names. The provider documents no filters or pagination for this operation.
List conversion-to-label association rows, optionally including conversion details. A conversion label is the association between a conversion and a folder, not the label itself. Returns one response; this operation documents no pagination.
List event counts, unique contacts, and revenue metrics per conversion. Optionally filter by name or a custom date range of at most 30 days (supply both dates). The documented operation exposes no pagination parameters.
List one page of conversion counts, values and graph series. Supports date filters and business-goal backfill/overlay data. This reads statistics rather than the conversion definitions returned by GET /conversions.
List ActiveCampaign conversions, optionally filtering names and including counts or goal requirements. Returns one provider response; the documented operation exposes no pagination parameters.
Lists a page of deal custom field values in ActiveCampaign, including field IDs, values, deal associations, and timestamps. Supports limit and offset pagination.
List 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.
List deal pipelines in ActiveCampaign, optionally filtering by title. Results can be paginated using a limit and offset.
List 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.
Tool 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.
List one page of email templates with optional filters and pagination. Full HTML is included by default; set exclude='content,preview_content' when searching, counting or identifying templates without needing their bodies.
List one page of dropdown, listbox, radio and checkbox custom contact field options. Supports only field and ids filters, plus limit and offset pagination. Provider defaults to 20 per page. When field is supplied, meta.total is null: continue paging until fewer than limit options are returned. Option IDs are distinct from field definition IDs; use each entry's field on /fields/{id}.
List up to 100 files in a custom Content Manager folder. Discover the folder ID with List Content Manager Folders. This endpoint is not paginated: limit and offset have no effect. The provider's truncation note gives the full count. For larger folders, use Search Content Manager Files with folderId and page. Resolve storage keys against baseUrl; they are not themselves URLs, and the resulting address may not be public.
List Content Manager files carrying a keyword, identified by its integer ID. Discover keyword IDs from a file's keywords. The provider caps this list at 100 files and reports the full count in a truncation note. Pagination is not supported: limit and offset have no effect. For larger lists, search Content Manager files with name set to the keyword and use that search's pagination. Resolve returned storage keys against baseUrl, which may not be public.
List ActiveCampaign forms with limit and offset pagination. Returned form information can include configurations, fields, and styling.
List one page of locations resolved from contact IP addresses. Locations are shared by addresses resolving to the same coordinates. There are no filters or sorting options; use ids to select locations or limit and offset to page. Results have no guaranteed order.
List one page of recorded contact IPv4 addresses across the account. Entries are recorded for contact interactions such as campaign opens, clicks, and form submissions. Locations are included in geoAddresses. There are no filters or sorting options and no guaranteed order; use ids to select entries or limit and offset to page.
List one page of automation goals, optionally with completion statistics. These are automation goals, not business goals. Use limit and offset to page; meta.total reports the matching count. This action does not modify goals.
Tool 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.
Explain errors in one app/file or integration contact import from GET /import/history. Returns at most 500 matching rows, oldest first, without pagination. Partial reasons start with the imported contact ID and explain the skipped subscription. Integration imports return an empty list because they have no per-row log. API bulk imports are absent: use their callback for detailed reasons instead. Requires contact import permission; unknown or inaccessible import IDs return 404.
List one page of app-upload and integration contact imports, newest first. Requires contact import permission. Users outside the main user group see only their group's imports. Bulk API imports are excluded: use import info for those. Use an import ID with history details to inspect failed rows.
List keywords on an existing Content Manager file by file ID. Keywords are the words matched by Content Manager search besides the file title. Returns all keywords; no pagination parameters are documented.
List one page of list-group permissions granting user groups access to lists. Includes legacy read-only permission flags. Use limit and offset to page; meta.total reports the total number of records.
List messages in ActiveCampaign, with pagination and optional filters. Results can include email content, sender details, and metadata.
Tool to list all e-commerce order products in ActiveCampaign. Use when you need to retrieve all order products with pagination support.
List personalization tags available in campaign and automation content. Returns the entire matching catalog without pagination or meta. Categories unavailable on the account's plan are omitted. If reading custom object schemas fails, requests including ECOMMERCE or CUSTOM_OBJECT (including an unfiltered request) fail; request those categories separately to retain the rest of the catalog. Custom-field read failures return error placeholder tags.
Tool to list all whitelisted site tracking domains in ActiveCampaign. Use when you need to retrieve domains that are allowed for site tracking.
List up to 25 recent contact activities of the requested types, one per contact. Contacts with an avatar come first, then newest activities first. Optionally filter by list, campaign or avatar presence. This endpoint has no pagination.
List up to 25 contacts who most recently entered an automation. Contacts with an avatar appear first. Use List Automations to find seriesId. This is a recent-entries snapshot, not a paginated list of all enrolled contacts.
Tool 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.
List unfinished contact restores made in the last 30 days that matched contacts. Requires an API user in the Admin group; other users receive 404. Finished restores are omitted; read them using GET /contactArchives/restoreRequest/{id}. While this list is nonempty, new restore requests and restore-all return 409. Returns all running requests without pagination.
List saved responses in ActiveCampaign for one-off personal emails. Results are paginated using limit and offset.
Initiate 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.
Tool 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.
Tool 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.
List required/default-value settings for built-in contact, deal and account fields. Only fields with a setting are returned. This endpoint does not list custom fields and does not paginate. Optionally filter by record type.
Tool 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.
Retrieve existing relations linking deal task types to task outcomes. Returns one provider response with relation IDs, display order, resource links and total count. This operation documents no filtering or pagination inputs.
List one page of tracked events across contacts, optionally including contacts. Filter by exact contact ID or timestamp, or by event-type substring. Entries are copied in when a contact's activity feed refreshes, so recent events may not appear immediately. Use limit and offset for subsequent pages.
List all available webhook events in ActiveCampaign. Use this action when you need to discover what webhook events are available for subscription.
Tool to list all existing webhooks in ActiveCampaign. Use when you need to retrieve all configured webhooks including their names, URLs, events, and sources.
Tool 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.
Add 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.
Irreversibly merge a source contact into a destination contact. The destination keeps its ID. The source's lists, tags, automations, deals, notes and activity move to the destination, then the source is deleted. Runs synchronously and cannot be undone. Requires pg_subscriber_merge permission. Optional resolution IDs select which contact wins conflicts.
Move every task of a source task type to a destination task type. This is a bulk update, not a move of a single task. The source and destination task types must already exist. Task types themselves are not deleted.
Update only supplied conversion definition fields using PATCH. Omitted fields retain their values; field_data may explicitly be null. This modifies the definition, rather than recording a contact conversion event.
Pause a currently sending campaign, changing status from sending (2) to paused (3). Requires an unfinished sending process. Draft, completed, automation, and already-finished process campaigns cannot be paused. Business-rule refusals are reported as failures even when the provider returns HTTP 200.
Permanently delete one archived contact by its original contact ID. Requires an API user in the Admin group; other users receive 404. The archived contact can no longer be restored or listed. Returns the provider's empty object on success, including when the ID is already gone. This action does not delete active contacts.
Permanently delete 1–100 archived contacts by their original contact IDs. Requires an API user in the Admin group. Contacts can no longer be restored or listed after deletion. Already absent IDs are skipped. Returns the provider's empty object on success; this action does not delete active contacts.
Preview a campaign message personalized for one address without sending email. Returns rendered headers, plain-text/HTML bodies, and raw MIME source. Unlike sending a campaign test, this delivers nothing and consumes no test-send limit.
Remove 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.
Remove a contact's active automation entry using contact and automation IDs. An email can identify the contact instead, and takes precedence over the ID. Completed entries remain as history. Returns 404 when no active entry exists. Use Remove Contact From Automation when the contactAutomation entry ID is known.
Remove a tag from a contact using the contact ID and tag ID. The tag definition remains intact. Unlike Remove Tag from Contact, this action does not require the contactTag association ID. Returns an error if the contact, tag, or association does not exist.
Remove one tag from a contact by its name, without the association ID. The tag definition is retained. Returns 404 if the contact or tag does not exist, or the tag is not applied to the contact. Names containing commas or line breaks, or blank names, fail with 400.
Remove a domain from ActiveCampaign's URL whitelist. Use this to revoke site tracking access for a specific domain that was previously whitelisted.
Remove a domain from the site tracking whitelist by name, without an ID lookup. Site tracking must be enabled; otherwise the provider returns 403. A domain not on the whitelist returns 404. Successful deletion returns no content.
Tool 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).
Queue restoration of archived contacts selected by ID. Requires an Admin API user (others receive 404). Every ID must be inside the restore window and old enough (normally archived at least 30 days ago, no more than 360 days ago), or the whole request fails with 400. For duplicate emails only the highest selected ID restores. Only one restore may run at once (409 otherwise). An empty list is accepted and restores nothing. A 201 only confirms queuing: poll GET /contactArchives/restoreRequest/{id} using restoreRequestId to follow completion.
Queue restoration of every archived contact matching a date/search selection. Requires an Admin API user (others receive 404). With no selection, restores all archived contacts in the restore window. Contacts older than 360 days never restore; contacts archived too recently (default 30 days) can cause 400. For duplicate emails only the highest contact ID restores. Only one restore runs at once (409 otherwise). A 201 confirms queuing, not completion: poll GET /contactArchives/restoreRequest/{id} using restoreRequestId.
Resume a paused (status 3) campaign, changing its status to sending (2) and restarting its sending pipeline. May send to campaign recipients. Reports the status transition, not eventual delivery. Business-rule failures raise an error even when the provider returns HTTP 200.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
Tool 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.
List ActiveCampaign e-commerce orders with pagination, including total price, customer information, product counts, and order-product references.
Tool 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.
Retrieve an ActiveCampaign e-commerce order by ID, including available customer, pricing, and status information, product count, and a link to its order products.
Tool 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.
Tool 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.
Tool 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.
Retrieves 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.
Tool 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.
Tool 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.
Update 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.
Save an automation from the JSON-string schema returned by a prior draft. Creates a persisted automation, not just a proposal. Reusing a sessionId returns its existing series; without one, each call can create a new series. The provider may refuse actions or triggers unsupported by the account plan.
Create 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.
Enable a draft or disabled campaign for sending at its existing scheduled date. This can queue email delivery. Recurring/RSS campaigns recalculate their next send date. Set a different scheduled date with Edit Campaign first. Automation, completed, unknown, or otherwise ineligible campaigns fail without being enabled.
Search for browse sessions matching specified criteria in ActiveCampaign. Use when you need to find browse sessions for a specific contact, connection, and status combination.
Search Content Manager files by title, keyword or alt text, one page per call. Filter by folder or exact MIME types. Returns file metadata, storage keys, their base URL and total matching count. Results can include non-image files. Use page and size for pagination and added,desc for newest files first.
Search ActiveCampaign's e-commerce catalog by product name or status, with pagination and sorting support.
Search for recurring payment records based on filter criteria. Use when you need to find subscription payments by email, status, connection, or other attributes.
Send a test of one campaign message to a single address. Subject to account test-send limits, sender-domain verification and recipient restrictions. Returns the provider's plain-text acknowledgement.
Set one custom field value for a contact without needing its field-value record ID. Creates a value (201) or updates the contact-and-field pair (200), retaining its original record ID. The response includes the stored value and updated contact. Requires contact-edit permission and access to the field's lists.
Set a conversion's target for an active business goal using their IDs. Optionally choose total conversion event count or total revenue and an integer target value. Returns the provider's result object unchanged.
Give a deal its first value in a custom field it has no value for yet. To change an existing value, use the update action with the field-value ID obtained by listing the deal's custom field values.
Make a brand kit the account's default (primary). Every other kit on the account stops being primary. This does not change the kit's own data and takes no request body. The success response is empty; retrieve the primary brand kit to confirm the new default.
Permanently stop a sending (2) or paused (3) campaign, setting status to 4. This finalizes sent totals and removes its outstanding sending process. A stopped campaign cannot be resumed or re-enabled. Unknown campaigns, automation campaigns, completed campaigns, and other invalid transitions are rejected, including when the provider returns HTTP 200 with succeeded 0.
Replace a custom field's list relationships with exactly the supplied list IDs. Creates missing relationships and deletes every other relationship, including the default all-lists (relid 0) relationship. Creation is transactional, but deletions occur individually: a deletion failure can leave partial changes. Empty or all-zero lists fail with 422; this operation cannot enable all lists. Returns only newly created relationships and IDs of deleted relationships. A missing field returns 404. Use only list IDs known to exist.
Relate a custom field to every list except the supplied list IDs. Deletes excluded and all-lists relationships before creating missing included relationships. Empty exclusions replace all relationships with relid 0. Deletions are not rolled back if creation fails: failure may leave partial state. List IDs are not checked for existence. Only the specified field is changed; use returned deletion metadata to inspect the replacement.
Simulate 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.
Track 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.
Tool 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.
Tool to update an existing deal in ActiveCampaign. Use when you need to modify deal properties such as title, value, stage, or status.
Tool 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.
Tool 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.
This 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.
Tool 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.
Updates 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.
Update metadata for an account custom field. Allows modification of field label, options, default value, visibility, and display order.
Tool 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.
Tool 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.
Point an existing address-group association at another address or user group. Use the association's own ID from GET /addressGroups, and supply both replacement IDs in addressGroup. This changes which user group can use the sender address. A missing association returns 404.
Point an existing address-list association at another address or list. Use the association's own ID from GET /addressLists and supply both replacement IDs in addressList. Does not subscribe contacts or send messages. A missing association returns 404.
Tool to update an existing e-commerce order in ActiveCampaign. Use when you need to modify order details such as pricing, shipping, or customer information.
Update an existing brand kit by UUID. Omit properties to keep them; null or empty values clear them. Nested objects merge by key, while lists replace the entire stored list. This does not change primary-kit status. Tone and competitor enrichment is asynchronous and read through separate endpoints.
Tool 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.
Update an active business goal's name, description or target date by ID. Only supplied non-null fields change. Fields are sent flat, without an initiative wrapper. Supply targetEndDate when setting useTargetEndDate to 1. Archived business goals cannot be updated.
Tool to update an existing calendar feed in ActiveCampaign. Use when you need to modify calendar properties like title, type, or notification settings.
Update a campaign-message association's campaignid, messageid or split percentage without sending the campaign. Requires the campaigns feature and campaign access; moving requires access to both campaigns. Sending counters cannot be changed.
Tool to update an existing configuration in ActiveCampaign. Use when you need to modify configuration settings like pagination preferences or onboarding states for users.
Tool 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.
Update an existing ActiveCampaign contact by ID, changing its email, first name, last name, or phone number. At least one of these fields is required.
End a contact's automation run by setting status to 2. Include completed=true with status=2 to cancel its pending waits and record the end as cancelled through the API. A completed run cannot be reactivated. Only status is writable; completed is a cancellation instruction, not stored.
Update a contact's list subscription using its membership record ID. Supply the matching list and contact IDs. Status 2 unsubscribes while retaining consent history; status 1 resubscribes. Resubscribing requires permission and is refused for self-unsubscribes. Email lists require a contact email, SMS lists a phone number. Set responder to 0 to suppress list autoresponders.
Update a conversion definition's name, dollar value, currency or per-contact limit. Only supplied fields change. This edits the definition, not a contact conversion event.
Update goalType, goalValue or conversionTargetStatus on a conversion-label association. Supply the association row's ID, not a label/folder ID. Conversion and label membership cannot be changed by this operation.
Tool 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.
Tool 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.
Update multiple existing custom field options atomically. Supply both each option ID and its owning field ID. Inaccessible or missing fields are silently skipped: compare returned IDs with requested IDs. A missing option ID fails the entire transaction. Labels differing from values must be changed to new text to survive the provider's label rewrite.
Updates an existing contact custom field value in ActiveCampaign by field value record ID, supplying the contact, field and new value.
Tool 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.
Updates 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.
Updates 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.
Tool 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.
Tool 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.
Tool 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.
Tool 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).
Tool 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.
Tool 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.
Update an existing email template's name, gallery visibility or content source. Requires UpdateEmailTemplates permission and access to the target and any source template/campaign. Content and design can be copied from one source; direct HTML or subject editing is not supported by this operation.
Tool to enable or disable event tracking for your ActiveCampaign account. Use this to toggle event tracking on or off based on your tracking requirements.
Update the channel or list coverage of an existing exclusion rule by ID. This changes suppression coverage, not the match phrase or match type. Nonempty list IDs are supported only with channel 'several'.
Update one existing custom field option by its option ID. Every update rewrites the label to match the stored value unless the label changes to new text (except the campaign preferred-language field). Sending the current label does not preserve it. Renaming an option does not change contacts' previously saved values; update those contacts separately if needed.
Update a custom field relationship by ID. Saving removes conflicting relationships for the field. Changing a list-specific relationship to relid 0, or an all-lists relationship to a specific list, also deletes the relationship being updated. The provider still returns 200 with echoed values; retrieve the relationship afterwards to verify persistence. Moving between specific lists keeps this relationship. Prefer POST /fieldRel/sync or /fieldRel/syncExcept to set which lists a field appears on.
Tool 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.
Update an existing ActiveCampaign form's content, layout, styling or submission configuration. Supply its ID and a form object; omitted properties are not sent. Returns the provider's updated form JSON.
Tool to update an existing permission group in ActiveCampaign. Use when you need to modify a group's title or description.
Update an existing subscriber list's name, settings or sender address. Supply name on every request. Omitted settings retain their current values. Postal address updates merge with stored fields; empty strings clear fields. The list channel cannot be changed. Does not send a campaign.
Point an existing list-group permission at another list or user group. Discover the permission record ID with GET /listGroups. Supply list and/or group inside listGroup; legacy permission flags are read-only. Unlike create and delete, updating this record does not rebuild users' list permissions. Returns the updated record. Inaccessible records return 403; missing ones 404.
Tool 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.
Tool 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.
Update 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.
Tool to update an existing saved response in ActiveCampaign. Use when you need to modify the title, subject, or body of a saved response template.
Tool 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.
Tool 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.
Tool 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.
Tool to enable or disable site tracking for your ActiveCampaign account. Use this when you need to toggle site tracking functionality on or off.
Update an SMS broadcast's content, audience, or status. Omitted fields are left unchanged. Use status=draft to keep a draft unsent; pending_review initiates sending and is not a content-only update.
Request AI-generated edits to an existing SMS broadcast using a prompt and tone. Returns a requestId for asynchronous status polling, not the finished broadcast. This endpoint edits content; it does not schedule or send an SMS broadcast.
Update required/default settings of a standard field for the whole account. Use an ID from GET /fieldDetails. Custom fields use their own update endpoints. Contact email cannot be optional, and at least one contact name/phone/email field must remain required. Any API user can change these account-wide settings.
Update a task outcome's title, sentiment or enabled status. Supply sentiment on every update; omitted title and disabled fields retain their values. Disabling an outcome removes its links to task types.
Update a relation linking a deal task type to a task outcome. The provider labels this operation WIP, with a published request and response schema. Change tasktype, outcome or display_order using tasktypeOutcomeRel; omitted fields are not sent. Requires Task Outcomes enabled on the account.
Tool 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.
Update 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.
Create 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.
Create 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.
Create 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.
The ActiveCampaign integration connects your Dench AI CRM directly to ActiveCampaign, so agents can read and act on your ActiveCampaign data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
491 actions are available for agents to invoke on your behalf. Every call runs through ActiveCampaign's own authorization, scoped to the account you connect.
Sign in to your Dench workspace and open Integrations.
Find ActiveCampaign and click Connect — you'll authorize access through ActiveCampaign's own sign-in flow. No API keys or code required.
Ask an agent to use ActiveCampaign in chat, or call it from an automation.
Manage or disconnect the connection any time from workspace settings.
The Dench ActiveCampaign integration connects your AI CRM to ActiveCampaign, so AI agents can work with your ActiveCampaign data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
The ActiveCampaign integration currently exposes 491 actions, including Add Browse Session to Cart, Add contact note, Add Contact to Automation, Add contact to list, Add Custom Field, and Add Custom Field Options. Agents invoke them on your behalf from chat or from automations.
No. You connect ActiveCampaign from your Dench workspace using ActiveCampaign's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Connections are authorized through ActiveCampaign's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the ActiveCampaign connection from your workspace settings at any time.