ActiveCampaign Deals API

The Deals API from ActiveCampaign — 25 operation(s) for deals.

Documentation GitHub OpenAPI

Operations 47

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /deals Create a deal · ActiveCampaign Create a Deal #

Ask an LLM

“How do I add a new sales deal to a pipeline?”

“Can I create a deal and link it to a contact in the same request?”

Tell an agent

Create a new deal from these details: {deal}.

Open a new deal for my latest prospect with the value and stage I give you.

GET /deals List and filter deals · ActiveCampaign List All Deals #

Ask an LLM

“Which open deals are in a given pipeline stage in ActiveCampaign?”

“Can I find deals worth more than a certain amount or with a high deal score?”

Tell an agent

List all deals in stage {stage}.

Show deals owned by user {owner} with a value above {minimum_value}.

GET /deals/{id} Get a single deal · ActiveCampaign Retrieve a Deal #

Ask an LLM

“Where can I see the full details of one specific deal by its ID?”

“What stage and value is deal number 42 currently at?”

Tell an agent

Show me deal {id}.

Pull up the current stage, owner and value of deal {id}.

PUT /deals/{id} Update a deal · ActiveCampaign Update a Deal #

Ask an LLM

“Can I change the value or stage of an existing deal?”

“How do I mark a deal I already created as won or lost?”

Tell an agent

Update deal {id} with {deal}.

Mark deal {id} as won.

DELETE /deals/{id} Delete a deal · ActiveCampaign Delete a Deal #

Ask an LLM

“Is it possible to permanently remove a deal from my CRM?”

“What happens when I delete a duplicate deal?”

Tell an agent destructive · confirm first

Delete deal {id}.

Remove the duplicate deal {id} from the pipeline.

POST /deals/{id}/notes Add a note to a deal · ActiveCampaign Create a Deal Note #

Ask an LLM

“How do I attach a note to a specific deal?”

“Can I log call notes directly on a deal record?”

Tell an agent

Add a note to deal {id} saying {note}.

Log a meeting summary as a note on deal {id}.

PUT /deals/{id}/notes/{noteId} Edit a note on a deal · ActiveCampaign Update a Deal Note #

Ask an LLM

“Can I edit a note I already added to a deal?”

“Is there a way to fix a typo in an existing deal note?”

Tell an agent

Change note {noteId} on deal {id} to {note}.

Rewrite deal {id}'s note {noteId}.

PATCH /deals/bulkUpdate Reassign owners on many deals · ActiveCampaign Bulk Update Deal Owners #

Ask an LLM

“Can I reassign a batch of deals to a different sales rep at once?”

“How do I change the owner on several deals in one call?”

Tell an agent

Bulk update deal owners using {deals}.

Hand all of a departing rep's deals over to a new owner in one bulk update.

GET /dealActivities List recent deal activity · ActiveCampaign List All Deal Activities #

Ask an LLM

“What recent activity has happened on my deals?”

“Can I see the activity history for one particular deal?”

Tell an agent

Show the recent activity for deal {deal}.

List recent deal activities of data type {data_type}.

POST /dealGroups Create a deal pipeline · ActiveCampaign Create a Pipeline #

Ask an LLM

“How do I set up a new sales pipeline for a separate team?”

“Can I create a pipeline for renewals alongside my new-business one?”

Tell an agent

Create a pipeline with {dealGroup}.

Set up a new Partnerships pipeline.

GET /dealGroups List deal pipelines · ActiveCampaign List All Pipelines #

Ask an LLM

“Which sales pipelines are set up in my account?”

“Can I list only the pipelines that already have stages?”

Tell an agent

List all my deal pipelines.

Find the pipeline titled {title}.

GET /dealGroups/{id} Get a deal pipeline · ActiveCampaign Retrieve a Pipeline #

Ask an LLM

“Where do I see the settings of one specific pipeline?”

“What are the details of pipeline 3?”

Tell an agent

Show me pipeline {id}.

Get the configuration of pipeline {id}.

PUT /dealGroups/{id} Update a deal pipeline · ActiveCampaign Update a Pipeline #

Ask an LLM

“Can I rename an existing pipeline or change its currency?”

“Is it possible to edit a pipeline's settings after creating it?”

Tell an agent

Update pipeline {id} with {dealGroup}.

Rename pipeline {id}.

DELETE /dealGroups/{id} Delete a deal pipeline · ActiveCampaign Delete a Pipeline #

Ask an LLM

“How do I remove a pipeline we no longer use?”

“Will deleting a pipeline get rid of it for good?”

Tell an agent destructive · confirm first

Delete pipeline {id}.

Remove the unused pipeline {id}.

GET /dealGroup/get_inaccessible_deal_groups Find pipelines a user cannot access · ActiveCampaign Retrieve Inaccessible Pipelines by User #

Ask an LLM

“Which pipelines is a particular user blocked from seeing?”

“Can I check whether a teammate has access to the pipelines behind certain deals?”

Tell an agent

Show which pipelines user {userId} can't access for deals {dealIds}.

Check pipeline access gaps for user {userId} across deals {dealIds}.

POST /dealStages Add a stage to a pipeline · ActiveCampaign Create a Stage #

Ask an LLM

“How do I add a new stage like Negotiation to a pipeline?”

“Can I reorder the other stages when adding a new one?”

Tell an agent

Create a pipeline stage with {dealStage}.

Add a Contract Sent stage and reorder the pipeline's stages ({reorder}).

GET /dealStages List deal stages · ActiveCampaign List All Stages #

Ask an LLM

“What stages does a given pipeline have?”

“Can I list every deal stage across all pipelines?”

Tell an agent

List the stages in pipeline {d_groupid}.

Find the deal stage titled {title}.

GET /dealStages/{id} Get a deal stage · ActiveCampaign Retrieve a Stage #

Ask an LLM

“Where can I see the details of a single pipeline stage?”

“What pipeline does stage 7 belong to?”

Tell an agent

Show me deal stage {id}.

Get the title and order of stage {id}.

PUT /dealStages/{id} Update a deal stage · ActiveCampaign Update a Stage #

Ask an LLM

“Can I rename a stage or change its position in the pipeline?”

“Is it possible to edit a stage's color or width?”

Tell an agent

Update deal stage {id} with {dealStage}.

Rename stage {id} and reorder its pipeline.

DELETE /dealStages/{id} Delete a deal stage · ActiveCampaign Delete a Stage #

Ask an LLM

“How do I remove a stage from a pipeline?”

“Can I delete a stage nobody uses anymore?”

Tell an agent destructive · confirm first

Delete deal stage {id}.

Remove the obsolete stage {id}.

PUT /dealStages/{id}/deals Move all deals from one stage to another · ActiveCampaign Move Deals to Another Stage #

Ask an LLM

“Can I move every deal sitting in one stage into a different stage?”

“How do I empty a stage by shifting its deals elsewhere before deleting it?”

Tell an agent

Move all deals in stage {id} to the stage in {deal}.

Shift every deal out of stage {id} into the next stage.

POST /dealCustomFieldMeta Define a custom deal field · ActiveCampaign Create a Custom Field Meta #

Ask an LLM

“How do I add a custom field such as contract length to deals?”

“Can I create a dropdown-type custom field for deals?”

Tell an agent

Create a custom deal field with {dealCustomFieldMetum}.

Add a Renewal Date custom field to deals.

GET /dealCustomFieldMeta List custom deal fields · ActiveCampaign List All Custom Fields #

Ask an LLM

“What custom fields have been defined for deals?”

“Which extra deal fields exist beyond the standard ones?”

Tell an agent

List all custom deal field definitions.

Show the first {limit} custom deal fields.

GET /dealCustomFieldMeta/{id} Get a custom deal field definition · ActiveCampaign Retrieve a Custom Field #

Ask an LLM

“Where do I see the definition and options of one custom deal field?”

“What type is custom deal field 5?”

Tell an agent

Show custom deal field {id}.

Get the settings for custom deal field {id}.

PUT /dealCustomFieldMeta/{id} Update a custom deal field definition · ActiveCampaign Update a Custom Field #

Ask an LLM

“Can I rename a custom deal field or change its options?”

“Is it possible to edit a custom deal field's label after creating it?”

Tell an agent

Update custom deal field {id} with {dealCustomFieldMetum}.

Relabel custom deal field {id}.

DELETE /dealCustomFieldMeta/{id} Delete a custom deal field · ActiveCampaign Delete a Custom Field #

Ask an LLM

“How do I remove a custom deal field we no longer track?”

“Does deleting a custom deal field definition remove it from all deals?”

Tell an agent destructive · confirm first

Delete custom deal field {id}.

Remove the unused custom deal field definition {id}.

POST /dealCustomFieldData Set a custom field value on a deal · ActiveCampaign Create a Custom Field Value #

Ask an LLM

“How do I fill in a custom field on one deal?”

“Can I store a value for a custom field on a deal record?”

Tell an agent

Set a custom field value on a deal using {dealCustomFieldDatum}.

Record the contract length custom field for one deal.

GET /dealCustomFieldData List custom field values on deals · ActiveCampaign List All Custom Field Values #

Ask an LLM

“What custom field values are stored on a specific deal?”

“Can I see all custom field data for deals?”

Tell an agent

List the custom field values for deal {dealId}.

Show every stored custom deal field value.

POST /dealCustomFieldData/bulkCreate Set custom field values on many deals · ActiveCampaign Bulk Create a Custom Deal Field Value #

Ask an LLM

“Can I set custom field values on several deals in one request?”

“Is there a bulk way to populate custom deal fields?”

Tell an agent

Bulk create custom deal field values from {array}.

Populate the region custom field across a batch of deals at once.

GET /dealCustomFieldData/{id} Get a custom field value on a deal · ActiveCampaign Retrieve a Custom Field Value #

Ask an LLM

“Where do I look up one stored custom deal field value by its ID?”

“What value is saved in custom deal field data record 12?”

Tell an agent

Show custom deal field value {id}.

Get the stored custom field data entry {id} for a deal.

PUT /dealCustomFieldData/{id} Change a custom field value on a deal · ActiveCampaign Update a Custom Field Value #

Ask an LLM

“Can I change a custom field value already saved on a deal?”

“How do I correct one deal's custom field entry?”

Tell an agent

Update custom deal field value {id} with {dealCustomFieldDatum}.

Correct the saved custom deal field value {id}.

DELETE /dealCustomFieldData/{id} Clear a custom field value on a deal · ActiveCampaign Delete a Custom Field Value #

Ask an LLM

“Is it possible to erase one custom field value from a deal?”

“What do I call to delete a stored custom deal field entry?”

Tell an agent destructive · confirm first

Delete custom deal field value {id}.

Clear the custom field data entry {id} from its deal.

PATCH /dealCustomFieldData/bulkUpdate Update custom field values on many deals · ActiveCampaign Bulk Update a Custom Field Value #

Ask an LLM

“Can I change custom field values on lots of deals at once?”

“Is there a bulk update for existing custom deal field data?”

Tell an agent

Bulk update custom deal field values with {array}.

Change the existing priority custom field on a batch of deals in one call.

GET /dealRoles List deal roles · ActiveCampaign List All Deal Roles #

Ask an LLM

“What roles can contacts play on a deal, like decision maker?”

“Can I search the deal roles defined in my account?”

Tell an agent

List all deal roles.

Search deal roles for {search}.

POST /dealRoles Create a deal role · ActiveCampaign Create a Deal Role #

Ask an LLM

“How do I add a new deal role such as Champion?”

“Can I define custom roles for contacts on deals?”

Tell an agent

Create a deal role called {title}.

Add a Budget Holder deal role.

DELETE /dealRoles/{id} Delete a deal role · ActiveCampaign Delete a Deal Role #

Ask an LLM

“Can I remove a deal role we don't use?”

“How do I get rid of an outdated deal role?”

Tell an agent destructive · confirm first

Delete deal role {id}.

Remove the outdated deal role {id}.

POST /dealTasks Create a task · ActiveCampaign Create a Task #

Ask an LLM

“How do I create a follow-up task on a deal or contact?”

“Can I schedule a call task with a due date and assignee?”

Tell an agent

Create a task with {dealTask}.

Add a follow-up call task due tomorrow for this deal.

GET /dealTasks List deal and contact tasks · ActiveCampaign List All Tasks #

Ask an LLM

“Which tasks are due this week for my deals?”

“Can I see the tasks assigned to a specific user?”

Tell an agent

List tasks assigned to user {assignee_userid}.

Show tasks due after {due_after}.

GET /dealTasks/{id} Get a task · ActiveCampaign Retrieve a Task #

Ask an LLM

“Where can I see the details of a single task?”

“What is the due date and status of task 88?”

Tell an agent

Show me task {id}.

Get the due date and assignee of task {id}.

PUT /dealTasks/{id} Update a task · ActiveCampaign Update a Task #

Ask an LLM

“Can I mark a task complete or change its due date?”

“Is it possible to reassign an existing task?”

Tell an agent

Update task {id} with {dealTask}.

Mark task {id} as complete.

DELETE /dealTasks/{id} Delete a task · ActiveCampaign Delete a Task #

Ask an LLM

“How do I remove a task that is no longer needed?”

“Can a task be deleted permanently?”

Tell an agent destructive · confirm first

Delete task {id}.

Remove the cancelled task {id}.

POST /dealTasktypes Create a task type · ActiveCampaign Create a Task Type #

Ask an LLM

“How do I add a new task type such as Demo?”

“Can I define my own categories for tasks?”

Tell an agent

Create a task type with {dealTasktype}.

Add an Onsite Visit task type.

GET /dealTasktypes List task types · ActiveCampaign List All Task Types #

Ask an LLM

“What task types like call or email are available?”

“Which task categories are configured in my account?”

Tell an agent

List all task types.

Show me the available task categories.

GET /dealTasktypes/{id} Get a task type · ActiveCampaign Retrieve a Task Type #

Ask an LLM

“Where do I see the details of one task type?”

“What is task type 4 called?”

Tell an agent

Show task type {id}.

Get the name of task type {id}.

PUT /dealTasktypes/{id} Update a task type · ActiveCampaign Update a Task Type #

Ask an LLM

“Can I rename an existing task type?”

“Is it possible to change a task type's settings?”

Tell an agent

Update task type {id} with {dealTasktype}.

Rename task type {id}.

DELETE /dealTasktypes/{id} Delete a task type · ActiveCampaign Delete a Task Type #

Ask an LLM

“How do I delete a task type we stopped using?”

“Can a task type be removed entirely?”

Tell an agent destructive · confirm first

Delete task type {id}.

Remove the retired task type {id}.

PUT /dealTasktypes/{id}/dealTasks Move tasks to another task type · ActiveCampaign Move Tasks to Another Task Type #

Ask an LLM

“Can I move all tasks of one type into a different task type?”

“How do I reclassify tasks before deleting their task type?”

Tell an agent

Move the tasks of type {id} to the type in {dealTask}.

Reclassify every task under task type {id} as Call.

ActiveCampaign Deals API

Operations 47

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification