# ActiveCampaign Documentation > Documentation for ActiveCampaign's APIs and native CX apps built with App Studio ## App Studio: App Studio - [Configuration Walkthrough](https://developers.activecampaign.com/docs/configuration-walkthrough-1.md) - [CX App Go Live Guide](https://developers.activecampaign.com/docs/cx-app-go-live-guide.md): When you are ready to publish with your CX App, please review this guide to learn more about the review process and what steps are necessary to complete before, during, and after the app is submitted… - [Twillio SMS Outbound Example](https://developers.activecampaign.com/docs/twillio-sms-outbound-example.md) - [Reference](https://developers.activecampaign.com/docs/configuration-specification-v2.md) - [What is a CX App?](https://developers.activecampaign.com/docs/what-is-a-cx-app.md): Explaining what a CX Application is, and why you should build one - [auth Object](https://developers.activecampaign.com/docs/auth.md) - [api Object](https://developers.activecampaign.com/docs/api.md) - [workflows Array](https://developers.activecampaign.com/docs/workflows.md) - [Commands, Variables, Properties](https://developers.activecampaign.com/docs/commands-1.md) - [Create Your First App using Pipedream and Python: Part 1](https://developers.activecampaign.com/docs/python-create-and-test-your-first-app-using-pipedream.md): PART 1: Build your first CX App that communicates with a Python API ## API: Getting Started - [Authentication](https://developers.activecampaign.com/reference/authentication.md) - [Base URL](https://developers.activecampaign.com/reference/url.md) - [Pagination, Ordering, and Filtering](https://developers.activecampaign.com/reference/pagination.md) ## API: API Guides - [Contact Custom Fields API Guide](https://developers.activecampaign.com/reference/contact-custom-fields-api-guide.md): Using the API to add and manage Custom Fields for your Contacts ## API: Accounts - [Bulk delete accounts](https://developers.activecampaign.com/reference/bulk-delete-accounts.md): Delete an existing account - [Create an account custom field](https://developers.activecampaign.com/reference/create-a-customfieldmeta.md) - [Retrieve an account custom field](https://developers.activecampaign.com/reference/retrieve-a-custom-field-meta.md) - [List account custom fields](https://developers.activecampaign.com/reference/list-all-custom-fields-meta.md) ## API: Addresses - [Retrieve an addressList](https://developers.activecampaign.com/reference/retrieve-an-addresslist.md) - [List all addressLists](https://developers.activecampaign.com/reference/list-all-addresslists.md): List the associations between addresses and lists. Each record links one address to one list. This collection is not filterable. To read the associations for a single address, use `GET… - [Retrieve an addressGroup](https://developers.activecampaign.com/reference/retrieve-an-addressgroup.md) - [List all addressGroups](https://developers.activecampaign.com/reference/list-all-addressgroups.md): List the associations between addresses and user groups. Each record links one address to one group; an address that is available to every group has `allgroup` set on the address itself instead of an… ## API: Automations - [List all contacts in an automation](https://developers.activecampaign.com/reference/list-all-contactautomations-for-automation.md): List the contacts currently in, or that have run through, a single automation. This is a paginated equivalent of filtering `/api/3/contactAutomations` by `filters[seriesid]`. ## API: Campaigns - [Edit campaign](https://developers.activecampaign.com/reference/edit-campaign.md) - [Create Campaign](https://developers.activecampaign.com/reference/create-campaign.md) - [Duplicate Campaign](https://developers.activecampaign.com/reference/duplicate-campaign.md) - [Delete a campaign](https://developers.activecampaign.com/reference/delete-a-campaign.md): Delete an existing campaign. The campaign row is archived, and its folder associations, any pending approval request and any queued automation sends are removed as well. Campaigns that reference this… - [Retrieve campaign messages associated to campaign](https://developers.activecampaign.com/reference/retrieve-campaign-messages-associated-campaign.md): Retrieve the per-message reporting totals for a campaign. Each element of `campaignMessages` corresponds to one message the campaign sent: a single element for a regular campaign, and one element per… - [Create a campaign message](https://developers.activecampaign.com/reference/create-a-campaign-message.md): Associate a message with a campaign, which is the association a split (A/B) campaign uses to send more than one message. `campaignid` is required; a request without it is a `400`. Only… - [Update a campaign message](https://developers.activecampaign.com/reference/update-a-campaign-message.md): Update the association between a campaign and a message. Submitting a `campaignid` moves the message to that campaign, which requires access to both the campaign the message belongs to and the… - [Delete a campaign message](https://developers.activecampaign.com/reference/delete-a-campaign-message.md): Delete the association between a campaign and a message. The message itself is not deleted; use [`DELETE /messages/{id}`](https://developers.activecampaign.com/reference/delete-a-message) for that.… - [Schedule a campaign](https://developers.activecampaign.com/reference/schedule-a-campaign.md): Enable a campaign for sending, setting its status to `scheduled` (1). Only a campaign whose status is `draft` (0) or `disabled` (6) can be enabled. For a one-off campaign this also queues the… - [Pause a sending campaign](https://developers.activecampaign.com/reference/pause-a-campaign.md): Pause a campaign that is currently sending, setting its status to `paused` (3). Only a campaign whose status is `sending` (2) can be paused. Pausing clears the send date on the campaign's most… - [Resume a paused campaign](https://developers.activecampaign.com/reference/resume-a-campaign.md): Resume a paused campaign, setting its status back to `sending` (2) and re-driving the sending pipeline from the stage the campaign stopped at. Only a campaign whose status is `paused` (3) can be… - [Stop a campaign](https://developers.activecampaign.com/reference/stop-a-campaign.md): Stop a campaign permanently, setting its status to `stopped` (4). Only a campaign whose status is `sending` (2) or `paused` (3) can be stopped. Stopping is not reversible through this endpoint: a… - [Delete multiple campaigns](https://developers.activecampaign.com/reference/delete-multiple-campaigns.md): Delete several campaigns in one call. This is the v3 equivalent of the v1 `campaign_delete_list` action. The body selects what to delete, in one of three shapes: - `{"ids": [1, 2]}` — the given… - [Preview a campaign message](https://developers.activecampaign.com/reference/preview-a-campaign-message.md): Render a campaign message for one address and return it parsed into headers and bodies, without sending anything. This is the v3 equivalent of the `preview` action of the v1 `campaign_send` action.… - [Send a test of a campaign](https://developers.activecampaign.com/reference/send-a-campaign-test.md): Send a test email of a campaign message to a single address. This is the v3 equivalent of the `test` action of the v1 `campaign_send` action. The test is subject to the account's test-send limits… - [Update a message](https://developers.activecampaign.com/reference/update-a-message.md) - [Retrieve the source of a campaign message](https://developers.activecampaign.com/reference/retrieve-a-campaign-message-source.md): Render a campaign message and return the generated email. This is the v3 equivalent of the `source` and `structured` actions of the v1 `campaign_send` action. With `structured=0` (the default) the… - [Variables](https://developers.activecampaign.com/reference/variables.md): Use variables when messaging specific mailing lists. - [List Variables](https://developers.activecampaign.com/reference/list-variables.md): Retrieve a list of personalization variables - [Retrieve a Variable](https://developers.activecampaign.com/reference/retrieve-variable.md): Retrieve an individual personalization variable - [Create a Variable](https://developers.activecampaign.com/reference/create-variable.md): Create a personalization variable - [Edit a Variable](https://developers.activecampaign.com/reference/edit-variable.md): Edit a personalization variable - [Delete a Variable](https://developers.activecampaign.com/reference/delete-variable.md): Delete a personalization variable - [Bulk Delete Variables](https://developers.activecampaign.com/reference/bulk-delete-variables.md): Bulk delete personalization variables - [/personalizations/{variableId}/lock](https://developers.activecampaign.com/reference/lock-a-variable.md) - [/personalizations/{variableId}/unlock](https://developers.activecampaign.com/reference/unlock-a-variable.md) ## API: Contacts - [Create or update a contact by email (upsert)](https://developers.activecampaign.com/reference/sync-a-contacts-data.md): Create or update a single contact by email address (upsert). When a contact with the given email already exists it is updated and the response is 200; otherwise a new contact is created and the… - [List, search, and filter contacts](https://developers.activecampaign.com/reference/list-all-contacts.md): The read behind the Contacts page. It finds contacts by list (listid), tag (tagid, or filters[tagName] for a tag name), list status (status), text (search matches name, email, phone and account… - [Bulk import contacts](https://developers.activecampaign.com/reference/bulk-import-contacts.md): Import up to 250 contacts in one request. Asynchronous: the response returns a batchId and a successful response only means the import was accepted, not finished — poll GET /import/info with the… - [Summarize recent API bulk imports by day](https://developers.activecampaign.com/reference/bulk-import-status-list.md): Summarize this account's API bulk imports from the last 7 days: for each day, how many batches and contacts are still outstanding and how many completed. Only imports submitted through POST… - [Bulk import status info](https://developers.activecampaign.com/reference/bulk-import-status-info.md): Check the status of one API bulk import using the batchId returned by POST /import/bulk_import. Imports run in the background, so call this after submitting one to confirm it completed: an import is… - [List a contact's activity feed](https://developers.activecampaign.com/reference/list-contact-activities.md): The activity feed of one contact: the events recorded against the contact over time. Send contact with the contact id. The request first refreshes that contact's feed from the underlying tables, so… - [Retrieve a contacts list of geo-ips](https://developers.activecampaign.com/reference/retrieve-contact-geo-ips.md) - [Retrieve a contacts geo IP address](https://developers.activecampaign.com/reference/retrieve-a-contacts-geo-ip-address.md) - [Bulk sync contacts](https://developers.activecampaign.com/reference/bulk-sync-contacts.md): Upserts up to 250 contacts in one request, matching each one on its email address: an existing contact with that email is updated, otherwise a contact is created. This is the v3 equivalent of looping… - [Merge two contacts](https://developers.activecampaign.com/reference/merge-contacts.md): Merges one contact into another and deletes the contact that was merged. The destination contact survives and keeps its id; the source contact's lists, tags, automations, deals, notes and activity… - [Create a contact custom field](https://developers.activecampaign.com/reference/create-a-contact-custom-field.md): Creates a custom field definition for contacts. For dropdown, listbox, radio, and checkbox fields, create the options in the same request by adding an options array inside the field payload; list… - [Add Custom Field to Field Group](https://developers.activecampaign.com/reference/add-custom-field-to-field-group.md) - [Get a custom field by ID](https://developers.activecampaign.com/reference/retrieve-a-custom-field-contact.md): Returns one custom field definition by its field id, with its options side-loaded in a fieldOptions array and its list relationships in a fieldRels array. Ids inside fieldOptions are field option… - [Get All Custom Field Groups](https://developers.activecampaign.com/reference/get-all-custom-field-groups.md) - [Get Custom Field Group by ID](https://developers.activecampaign.com/reference/get-custom-field-to-field-group.md) - [List contact custom fields](https://developers.activecampaign.com/reference/retrieve-fields.md): Lists custom field definitions for contacts, 20 per page by default, ordered by ordernum then id unless an orders parameter is given. The response side-loads a fieldOptions array with the options of… - [Set a contact custom field value](https://developers.activecampaign.com/reference/create-fieldvalue.md): Sets a contact's value for one custom field. This operation is an upsert: when the contact has no value for the field yet, a new fieldValue is created and returned with 201; when a value already… - [Update a custom field value for contact](https://developers.activecampaign.com/reference/update-a-custom-field-value-for-contact.md): Updates one stored custom field value by its fieldValue id. The request must include the fieldValue's contact and field ids along with the new value: omitting them fails with a misleading 404 that… - [Remove a tag from a contact by tag name](https://developers.activecampaign.com/reference/remove-a-tag-from-a-contact-by-name.md): Removes one tag from a contact, addressed by contact id and tag name, without needing the contactTag association id that DELETE /contactTags/{id} requires. Pass the tag name in the tag query… - [Remove a tag from a contact by tag id](https://developers.activecampaign.com/reference/remove-a-tag-from-a-contact-by-id.md): Removes one tag from a contact, addressed by contact id and tag id, without needing the contactTag association id that DELETE /contactTags/{id} requires. To remove by tag name instead, use DELETE… ## API: Custom Objects - [Paging, Ordering, Sorting, and Filtering](https://developers.activecampaign.com/reference/paging-ordering-sorting-and-filtering.md) ## API: Deals - [Create a deal](https://developers.activecampaign.com/reference/create-a-deal-new.md): Create a new deal - [Create a deal custom field](https://developers.activecampaign.com/reference/create-custom-deal-field-meta.md) - [Retrieve a deal custom field](https://developers.activecampaign.com/reference/retrieve-a-custom-deal-field-meta.md) - [List deal custom fields](https://developers.activecampaign.com/reference/retrieve-all-custom-deal-field-meta.md) ## API: DeepData Integrations - [Create a connection](https://developers.activecampaign.com/reference/create-connection.md): Create a new connection resource. - [Retrieve a connection](https://developers.activecampaign.com/reference/get-connection.md): Retrieve an existing connection resource. - [Update a connection](https://developers.activecampaign.com/reference/update-connection.md): Update an existing connection resource. - [List all connections](https://developers.activecampaign.com/reference/list-all-connections.md): List all existing connection resources. ## API: EcomMerce graphQl api - [Overview](https://developers.activecampaign.com/reference/graphql-overview.md) - [About the GraphQL API](https://developers.activecampaign.com/reference/about-the-graphql-api.md) - [Searches](https://developers.activecampaign.com/reference/searches.md) - [Orders](https://developers.activecampaign.com/reference/orders-1.md) - [Recurring Payments](https://developers.activecampaign.com/reference/recurring-payments.md) - [Shared Objects](https://developers.activecampaign.com/reference/shared-objects.md) - [Products](https://developers.activecampaign.com/reference/products.md) - [Browse Abandonment Developer Overview](https://developers.activecampaign.com/reference/browse-abandonment.md) - [Browse Session APIs](https://developers.activecampaign.com/reference/browse-session-apis.md) ## API: Forms - [/forms/{id}](https://developers.activecampaign.com/reference/delete-a-form.md) - [/form/optin](https://developers.activecampaign.com/reference/set-opt-in.md) - [/forms](https://developers.activecampaign.com/reference/create-a-new-form.md) - [/forms/{id}](https://developers.activecampaign.com/reference/update-a-form.md) ## API: Lists - [Update a list](https://developers.activecampaign.com/reference/update-a-list.md): Update an existing list. Only the fields listed below can be changed; any other field sent in the `list` object is ignored. `name` is required on every request, even when it is not changing —… - [Create a list](https://developers.activecampaign.com/reference/create-new-list.md) ## API: Segments - [Create a Match One Request](https://developers.activecampaign.com/reference/create_match_one_request.md) - [Check to see if a Contact matches a Segment using the given externalId](https://developers.activecampaign.com/reference/segment_match_check_by_external_id.md) - [Create a Match All Request for a new Segment](https://developers.activecampaign.com/reference/create_match_all_request.md): Find all Contact Id's that match the given Segment. The provided segment will be saved with a 24 hour TTL. A new match-all request will be initiated. If results are not ready within 4 seconds, a… - [Create a Match All Request](https://developers.activecampaign.com/reference/create_match_all_request_with_segment_id.md): A new match-all request will be initiated. If results are not ready within 4 seconds, a response that lacks a result-set will be returned and the response's `is_ready` attribute will be equal to… - [Return Match All result-set](https://developers.activecampaign.com/reference/get_result_set_by_id.md): If the result-set is not ready yet, the response's `is_ready` attribute will be equal to `false`. The match-all request has errored out if the `is_ready` attribute is false and the `run_id_end`… - [Create a Match Some Request](https://developers.activecampaign.com/reference/find_contact_id_by_ac_playload.md) - [Return a Match Some result-set](https://developers.activecampaign.com/reference/get_result_set_by_run_id.md): If the result-set is not ready yet, the response's `is_ready` attribute will be equal to `false`. The match-all request has errored out if the `is_ready` attribute is false and the `run_id_end`… - [Retrieve the most recent result count for the given segments that were ran without an AdditionalCriteria](https://developers.activecampaign.com/reference/get_recent_count_history.md): One result per segment will be returned. Pagination not supported. Maximum 100 segmentIds per request. SegmentIds in the request that doesn't exist, will simply be ignored - [Retrieve all result counts for the given segment that were ran without an AdditionalCriteria](https://developers.activecampaign.com/reference/get_count_history_by_segment_id.md): Up to 50 results will be returned at once. To get the next page, request again with the last result's timestamp formatted as an EPOCH seconds value - [Retrieve all result counts for the given segment that were ran without an AdditionalCriteria](https://developers.activecampaign.com/reference/get_count_history_with_timestamp.md): Up to 50 results will be returned at once. To get the next page, request again with the last result's timestamp formatted as an EPOCH seconds value - [Retrieve a segment](https://developers.activecampaign.com/reference/retrieve-a-segment.md): Retrieve a single segment by its ID. The segment conditions are not included; only the segment record is returned. - [List all segments](https://developers.activecampaign.com/reference/list-all-segments.md): Segments are the saved condition sets used to target contacts, either from an automation (`seriesid`) or from a list. This endpoint returns the segment records themselves, not the contacts that match… - [Create a Segment](https://developers.activecampaign.com/reference/create_segment.md): The Segment JSON structure is extremely flexible; Only segments that are supported by the segment-builder are guaranteed to work as expected. Specific Condition types only support a subset of FieldDO… - [Retrieve a Segment](https://developers.activecampaign.com/reference/retrieve_segment.md): Retrieves a V2 segment definition (conditions and condition groups) by its ID. Works for any segment, Saved Segment or otherwise. If the response has a `name` and `category` is `audience`, the… - [Update a Segment](https://developers.activecampaign.com/reference/update_segment.md) - [Delete a Segment by SegmentId including its historic versions](https://developers.activecampaign.com/reference/delete_segment.md) - [Retrieve a Segment's Historic Definition](https://developers.activecampaign.com/reference/get_segment_historic.md): Retrieve a Segment as it existed at the given point in time. Only segments with non-numeric SegmentIds are supported - [Revert a Segment to a Historic Definition](https://developers.activecampaign.com/reference/segment_revert_to_history.md): Revert a segment to how it looked at a specific point in time. Only segments with non-numeric SegmentIds are supported - [List Summaries for Saved Segments](https://developers.activecampaign.com/reference/get_saved_segment_summaries.md): Lists the account's Saved Segments with their summary: name, category, contact counts and dates. A Saved Segment is a segment that has a `name` (a name cannot be added after a segment is created, it… - [Retrieve a Saved Segment's Summary](https://developers.activecampaign.com/reference/get_saved_segment_summaries_by_id.md): Retrieves the summary (name, category, contact counts, dates) of one Saved Segment by its UUID. Get the UUID from `GET /api/3/audiences` (list them or search by name with `search`). Contact counts… ## API: Settings - [Retrieve account information](https://developers.activecampaign.com/reference/retrieve-account-information.md): Retrieve the hosted account and plan information for the account that owns the API key. This is the v3 replacement for the v1 `account_view` action. Authenticate with your account's API key in the… - [Update account settings](https://developers.activecampaign.com/reference/update-account-settings.md): Update the settings of the user the API key belongs to, and the account wide date and time formats. This is the v3 replacement for the v1 `settings_edit` action, which wrote nothing but those… - [Retrieve API credentials](https://developers.activecampaign.com/reference/retrieve-api-credentials.md): Retrieve the API URL and API key of the authenticated user. These are the `apiurl` and `apikey` members the v1 `user_me` action returns. - [Reset an API key](https://developers.activecampaign.com/reference/reset-an-api-key.md): Regenerate the API key of the authenticated user. The previous key stops working immediately, so this both revokes and reissues in one call. `user` must be the authenticated user's own id; any other… ## API: Site & Event Tracking - [List all site tracking domains](https://developers.activecampaign.com/reference/list-all-site-tracking-domains.md): List every domain on the site tracking whitelist. Each entry is identified by its name; whitelisted domains have no id in this representation. The collection is **empty when site tracking is… - [Add a site tracking domain](https://developers.activecampaign.com/reference/add-a-site-tracking-domain.md): Add a domain to the site tracking whitelist by name. Site tracking must be enabled first (`PUT /api/3/siteTracking`) - adding a domain while it is disabled returns `403`. A name may begin with `*`… - [Remove a site tracking domain](https://developers.activecampaign.com/reference/remove-a-site-tracking-domain.md): Remove a domain from the site tracking whitelist by name. The path segment is the domain itself, URL-encoded - no lookup step is needed, unlike `DELETE /api/3/prism/urlWhitelistings/{domainId}`,… ## API: Tasks - [List all tasks](https://developers.activecampaign.com/reference/list-all-tasks.md): Retrieve a list of existing tasks ## API: Task Reminders:Notifications - [Create a task reminder](https://developers.activecampaign.com/reference/create-a-task-reminder.md): Create a reminder for a deal task, sent to the task's assignee ahead of its due date. The request body must be wrapped in a `taskNotification` object; both `dealTask` and `interval` are required. ## API: Templates - [List all templates](https://developers.activecampaign.com/reference/list-all-templates.md): Retrieve the email templates in the account. Results are paginated and can be filtered; `meta.total` holds the total number of templates matching the request. - [Delete a template](https://developers.activecampaign.com/reference/delete-a-template.md): Delete an existing message template. Associated designer instances and list associations are removed as well. - [Create a template](https://developers.activecampaign.com/reference/create-a-template.md): Create an email template. This is the v3 equivalent of the v1 `message_template_add` action. Requires the `CreateEmailTemplates` permission. The new template is made available to the lists the… - [Update a template](https://developers.activecampaign.com/reference/update-a-template.md): Update an existing email template. This is the v3 equivalent of the v1 `message_template_edit` action. Requires the `UpdateEmailTemplates` permission and access to the template being updated,… ## API: Users - [Create a single sign-on token for a user](https://developers.activecampaign.com/reference/create-a-single-sign-on-token.md): Mint a short lived single sign-on token for a user, so an application can drop that user straight into the ActiveCampaign UI without asking them for their password. This is the v3 equivalent of the… - [Delete multiple groups](https://developers.activecampaign.com/reference/bulk-delete-groups.md): Delete several user groups in a single request and move everything that referenced them to another group. Users and deal groups belonging to the deleted groups are reassigned to the group given in… ## API: Webhooks - [Webhooks](https://developers.activecampaign.com/reference/webhooks.md) ## API: WhatsApp API - [List WhatsApp Templates](https://developers.activecampaign.com/reference/list-whatsapp-templates.md): Lists WhatsApp Templates. You can search with the `name` and `status` fields using the `?seach=my-template-name` query parameter. - [Get WhatsApp Template](https://developers.activecampaign.com/reference/get-whatsapp-template.md): Gets a WhatsApp Template by Id. - [Update WhatsApp Template](https://developers.activecampaign.com/reference/channels_whatsapp_template_update.md): Update a WhatsApp Template by Id. - [Delete WhatsApp Template](https://developers.activecampaign.com/reference/delete-whatsapp-template.md): Deletes a WhatsApp Template by Id. - [Send a WhatsApp Template](https://developers.activecampaign.com/reference/send-a-whatsapp-template-message.md): Send a single WhatsApp message: select a template to use and call our endpoint with the recipient phone number and the variables the template needs. That's it! - [List Flow Executions](https://developers.activecampaign.com/reference/list-flow-execution.md): Lists Flow Executions. - [List Flow Execution Contacts](https://developers.activecampaign.com/reference/list-flow-execution-contact.md): Lists Flow Execution Contacts. - [Get Flow Execution Contact by Id](https://developers.activecampaign.com/reference/get-flow-execution-contact.md): Get Flow Execution Contact by Id. - [Get Flow Execution](https://developers.activecampaign.com/reference/get-flow-execution.md): Get Flow Execution by Id. - [Create a Flow Execution](https://developers.activecampaign.com/reference/create-a-flow-execution.md): Create a Flow Execution of a Flow. - [List Conversations](https://developers.activecampaign.com/reference/list-conversations.md): Lists Conversations. - [Update a conversation](https://developers.activecampaign.com/reference/update-a-conversation.md): Update a Conversation - [Partially Update a Conversation](https://developers.activecampaign.com/reference/partially-update-a-conversation.md): Partially update a Conversation ## API: SMS Broadcast API - [Get all broadcast messages](https://developers.activecampaign.com/reference/listbroadcasts.md): Gets a paged list of all of a customer's broadcast messages with optional filtering - [Create a new broadcast message](https://developers.activecampaign.com/reference/createbroadcast.md): Creates a new SMS broadcast message - [Get broadcast message](https://developers.activecampaign.com/reference/getbroadcast.md): Retrieves the full details for one broadcast message - [Update broadcast message](https://developers.activecampaign.com/reference/updatebroadcast.md): Updates an existing broadcast message - [Delete broadcast message](https://developers.activecampaign.com/reference/deletebroadcast.md): Performs a soft-delete on the requested message - [Get all broadcast lists](https://developers.activecampaign.com/reference/listbroadcastlists.md): Gets a paged list of all broadcast lists (SMS channel) - [Create AI-generated broadcast](https://developers.activecampaign.com/reference/createaibroadcast.md): Creates a broadcast using AI based on prompt and tone - [Update broadcast with AI](https://developers.activecampaign.com/reference/updateaibroadcast.md): Updates an existing broadcast using AI - [Get AI broadcast request status](https://developers.activecampaign.com/reference/getaibroadcaststatus.md): Returns the current status of the AI process execution - [Get all broadcast metrics](https://developers.activecampaign.com/reference/getbroadcastmetrics.md): Returns metrics for specified broadcast IDs - [Get broadcast snapshot](https://developers.activecampaign.com/reference/getbroadcastsnapshot.md): Returns snapshot data for all broadcasts - [Get broadcast snapshot](https://developers.activecampaign.com/reference/getbroadcastsnapshotbyids.md): Returns snapshot for specified broadcast IDs - [Export broadcast metrics](https://developers.activecampaign.com/reference/exportbroadcastmetrics.md): Export broadcast performance metrics as CSV - [Get current sms credit use data](https://developers.activecampaign.com/reference/getsmscreditdata.md): Retrieve the current period's sms credit usage and remaining balance - [Get broadcast failure details](https://developers.activecampaign.com/reference/getbroadcastfailures.md): Returns grouping and counts of failures for the broadcast - [Get broadcast recipients](https://developers.activecampaign.com/reference/getbroadcastrecipients.md): Fetch all contacts who were sent a specific broadcast - [Export broadcast recipients](https://developers.activecampaign.com/reference/exportbroadcastrecipients.md): Export recipient data as CSV including full contact records ## API: Partners API - [Get a list of AI customization profiles](https://developers.activecampaign.com/reference/get_ai_customizations_profiles_list.md) - [Create a new AI customization profile](https://developers.activecampaign.com/reference/post_ai_customizations_profiles_create.md) - [Get profile by id](https://developers.activecampaign.com/reference/get_ai_customizations_profiles_get.md) - [Delete profile by id](https://developers.activecampaign.com/reference/delete_ai_customizations_profiles_delete.md) - [Update profile by id](https://developers.activecampaign.com/reference/patch_ai_customizations_profiles_update.md) - [Get the AI customization profile assigned to a child account](https://developers.activecampaign.com/reference/get_ai_customizations_profiles_get_by_child_account.md) - [Assign child accounts to a profile](https://developers.activecampaign.com/reference/patch_ai_customizations_profiles_assign_accounts.md) - [Get a list of documents for a profile](https://developers.activecampaign.com/reference/get_ai_customizations_documents_list.md) - [Upload a document to a profile](https://developers.activecampaign.com/reference/post_ai_customizations_documents_upload.md) - [Get document by id](https://developers.activecampaign.com/reference/get_ai_customizations_documents_get.md) - [Delete document by id](https://developers.activecampaign.com/reference/delete_ai_customizations_documents_delete.md) - [Update document by id](https://developers.activecampaign.com/reference/patch_ai_customizations_documents_update.md) - [Get a presigned download URL for a document](https://developers.activecampaign.com/reference/get_ai_customizations_documents_download.md) - [Get a list of custom instructions for a profile](https://developers.activecampaign.com/reference/get_ai_customizations_instructions_list.md) - [Create a new custom instruction](https://developers.activecampaign.com/reference/post_ai_customizations_instructions_create.md) - [Get custom instruction by id](https://developers.activecampaign.com/reference/get_ai_customizations_instructions_get.md) - [Delete custom instruction by id](https://developers.activecampaign.com/reference/delete_ai_customizations_instructions_delete.md) - [Update custom instruction by id](https://developers.activecampaign.com/reference/patch_ai_customizations_instructions_update.md) - [Get a list of account cloning statuses](https://developers.activecampaign.com/reference/get_child_account_snapshots_get_list.md) - [Get a list of snapshots](https://developers.activecampaign.com/reference/get_child_account_snapshots_list_snapshot_by_reseller.md) - [Create a new snapshot](https://developers.activecampaign.com/reference/post_child_account_snapshots_create_snapshot.md) - [Delete snapshot by id](https://developers.activecampaign.com/reference/delete_child_account_snapshots_delete_snapshot.md) - [Get a list of child accounts](https://developers.activecampaign.com/reference/get_child_accounts_get_list.md) - [Create a new account](https://developers.activecampaign.com/reference/post_child_accounts_create.md): For getting list of products use documentation here: https://www.activecampaign.com/partner/api/v2/example.php?call=/api/v1/products. More detailed instructions can be found in Step 1 of this… - [Get a list of accounts that can be used to create snapshots.](https://developers.activecampaign.com/reference/get_child_accounts_get_for_snapshots.md) - [List sync-enabled pipelines with deal counts, conversion %, revenue, and top account.](https://developers.activecampaign.com/reference/get_crm_reporting_list_pipelines.md) - [Aggregate summary metric cards: deal counts, revenue, conversion %, average deal revenue.](https://developers.activecampaign.com/reference/get_crm_reporting_pipelines_summary.md) - [Get a list of HQ pipelines with CRM sync status](https://developers.activecampaign.com/reference/get_crm_sync_list_pipelines.md) - [Get pipeline CRM sync configuration](https://developers.activecampaign.com/reference/get_crm_sync_get_pipeline_sync_config.md) - [Upsert pipeline CRM sync configuration (enable/disable and targets)](https://developers.activecampaign.com/reference/put_crm_sync_put_pipeline_sync_config.md) - [Get CRM sync settings](https://developers.activecampaign.com/reference/get_crm_sync_settings_get.md) - [Update CRM sync settings](https://developers.activecampaign.com/reference/put_crm_sync_settings_update.md) - [Get storage quota status](https://developers.activecampaign.com/reference/get_files_quota_status.md) - [Get a list of the latest insight cards](https://developers.activecampaign.com/reference/get_insight_cards_get_list_latest.md) - [Update insight card state](https://developers.activecampaign.com/reference/patch_insight_cards_update_state.md) - [Get supported language and timezone catalogs.](https://developers.activecampaign.com/reference/get_locales_get_catalogs.md): Returns the same catalogs ARC uses to validate the language and timezone fields on the child-account PUT endpoint, so dropdowns and write-side validation stay in sync. ## Pages - [ActiveCampaign MCP + ChatGPT](https://developers.activecampaign.com/page/connect-chatgpt.md) - [ActiveCampaign MCP + Claude](https://developers.activecampaign.com/page/connect-claude.md) - [Developer Sandbox Accounts](https://developers.activecampaign.com/page/developer-sandbox-accounts.md) - [Get Started](https://developers.activecampaign.com/page/getting-started.md) - [ActiveCampaign MCP - Available Tools](https://developers.activecampaign.com/page/mcp-available-tools.md) - [ActiveCampaign MCP - Prompt Examples](https://developers.activecampaign.com/page/mcp-prompt-examples.md) - [ActiveCampaign Remote MCP Server](https://developers.activecampaign.com/page/mcp.md) - [Webhooks](https://developers.activecampaign.com/page/webhooks.md)