ActiveCampaign Deals API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

ActiveCampaign Deals API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Deals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 47 operations across 25 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

47 operations 25 paths 0 schemas 8 DELETE17 GET2 PATCH10 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.3

API Version

3.0.0

Base URL

https://youraccountname.api-us1.com/api/3

Authentication

API Key

Contact

ActiveCampaign Support

Resource Areas

Authentication & Security 1

ActiveCampaign Deals API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (ApiToken). By default, every request must be authenticated.

ApiToken — Your ActiveCampaign API token

Paths & Operations 47

Across 25 paths, the API surfaces 47 operations — 8 DELETE, 17 GET, 2 PATCH, 10 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Deals 47

POST

/deals

ActiveCampaign Create a Deal

create-a-deal-new body → 201400

GET

/deals

ActiveCampaign List All Deals

list-all-deals 26 params → 200400

GET

/deals/{id}

ActiveCampaign Retrieve a Deal

retrieve-a-deal 1 param → 200

PUT

/deals/{id}

ActiveCampaign Update a Deal

update-a-deal-new 1 param body → 200400

DELETE

/deals/{id}

ActiveCampaign Delete a Deal

delete-a-deal 1 param → 200400

POST

/deals/{id}/notes

ActiveCampaign Create a Deal Note

create-a-deal-note 1 param body → 201

PUT

/deals/{id}/notes/{noteId}

ActiveCampaign Update a Deal Note

update-a-deal-note 2 params body → 200

PATCH

/deals/bulkUpdate

ActiveCampaign Bulk Update Deal Owners

bulk-update-deal-owners body → 200422

GET

/dealActivities

ActiveCampaign List All Deal Activities

list-all-deal-activities 4 params → 200400

POST

/dealGroups

ActiveCampaign Create a Pipeline

create-a-pipeline body → 200400

GET

/dealGroups

ActiveCampaign List All Pipelines

list-all-pipelines 4 params → 200400

GET

/dealGroups/{id}

ActiveCampaign Retrieve a Pipeline

retrieve-a-pipeline 1 param → 200400

PUT

/dealGroups/{id}

ActiveCampaign Update a Pipeline

update-a-pipeline 1 param body → 200400

DELETE

/dealGroups/{id}

ActiveCampaign Delete a Pipeline

delete-a-pipeline 1 param → 200

GET

/dealGroup/get_inaccessible_deal_groups

ActiveCampaign Retrieve Inaccessible Pipelines by User

retrieve-inaccessible-pipelines-by-user 2 params → 200422

POST

/dealStages

ActiveCampaign Create a Stage

create-a-deal-stage 1 param body → 200400

GET

/dealStages

ActiveCampaign List All Stages

list-all-deal-stages 3 params → 200400

GET

/dealStages/{id}

ActiveCampaign Retrieve a Stage

retrieve-a-deal-stage 1 param → 200400

PUT

/dealStages/{id}

ActiveCampaign Update a Stage

update-a-deal-stage 2 params body → 200400

DELETE

/dealStages/{id}

ActiveCampaign Delete a Stage

delete-a-deal-stage 1 param → 200

PUT

/dealStages/{id}/deals

ActiveCampaign Move Deals to Another Stage

move-deals-to-another-deal-stage 1 param body → 200422

POST

/dealCustomFieldMeta

ActiveCampaign Create a Custom Field Meta

create-custom-deal-field-meta body → 200422

GET

/dealCustomFieldMeta

ActiveCampaign List All Custom Fields

retrieve-all-custom-deal-field-meta 1 param → 200

GET

/dealCustomFieldMeta/{id}

ActiveCampaign Retrieve a Custom Field

retrieve-a-custom-deal-field-meta 1 param → 200404

PUT

/dealCustomFieldMeta/{id}

ActiveCampaign Update a Custom Field

update-a-custom-deal-field-meta 1 param body → 200404

DELETE

/dealCustomFieldMeta/{id}

ActiveCampaign Delete a Custom Field

delete-a-custom-deal-field-meta 1 param → 200404

POST

/dealCustomFieldData

ActiveCampaign Create a Custom Field Value

create-custom-deal-field-value body → 200422

GET

/dealCustomFieldData

ActiveCampaign List All Custom Field Values

list-all-custom-fielddata-field-values 1 param → 200

POST

/dealCustomFieldData/bulkCreate

ActiveCampaign Bulk Create a Custom Deal Field Value

bulk-create-a-custom-deal-field-value body → 200

GET

/dealCustomFieldData/{id}

ActiveCampaign Retrieve a Custom Field Value

retrieve-a-custom-deal-field-value 1 param → 200404

PUT

/dealCustomFieldData/{id}

ActiveCampaign Update a Custom Field Value

update-a-custom-deal-field-value 1 param body → 200404422

DELETE

/dealCustomFieldData/{id}

ActiveCampaign Delete a Custom Field Value

delete-a-custom-deal-field-data 1 param → 200404

PATCH

/dealCustomFieldData/bulkUpdate

ActiveCampaign Bulk Update a Custom Field Value

bulk-update-a-custom-field-value body → 200

GET

/dealRoles

ActiveCampaign List All Deal Roles

list-all-deal-roles 1 param → 200400

POST

/dealRoles

ActiveCampaign Create a Deal Role

create-a-deal-role body → 200400

DELETE

/dealRoles/{id}

ActiveCampaign Delete a Deal Role

delete-a-deal-role 1 param → 200400

POST

/dealTasks

ActiveCampaign Create a Task

create-task body → 201400

GET

/dealTasks

ActiveCampaign List All Tasks

list-all-tasks 13 params → 201400

GET

/dealTasks/{id}

ActiveCampaign Retrieve a Task

get-task 1 param → 201400

PUT

/dealTasks/{id}

ActiveCampaign Update a Task

update-task 1 param body → 201400

DELETE

/dealTasks/{id}

ActiveCampaign Delete a Task

delete-task 1 param → 200400

POST

/dealTasktypes

ActiveCampaign Create a Task Type

create-a-deal-task-type body → 200400

GET

/dealTasktypes

ActiveCampaign List All Task Types

list-all-deal-task-types → 200400

GET

/dealTasktypes/{id}

ActiveCampaign Retrieve a Task Type

retrieve-a-deal-task-type 1 param → 200400

PUT

/dealTasktypes/{id}

ActiveCampaign Update a Task Type

update-a-deal-task-type 1 param body → 200400

DELETE

/dealTasktypes/{id}

ActiveCampaign Delete a Task Type

delete-a-deal-task-type 1 param → 403

PUT

/dealTasktypes/{id}/dealTasks

ActiveCampaign Move Tasks to Another Task Type

move-deal-tasks-to-another-deal-task-type 1 param body → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API

AE Profile APIs.io

ActiveCampaign Addresses API

AE Profile APIs.io

ActiveCampaign AI API

AE Profile APIs.io

ActiveCampaign Automations API

AE Profile APIs.io

ActiveCampaign Branding API

AE Profile APIs.io

ActiveCampaign Broadcasts API

AE Profile APIs.io

ActiveCampaign Bulk Import API

AE Profile APIs.io

ActiveCampaign Calendars API

AE Profile APIs.io

ActiveCampaign Campaigns API

AE Profile APIs.io

ActiveCampaign Contacts API

AE Profile APIs.io

ActiveCampaign Credits API

AE Profile APIs.io

ActiveCampaign Custom Objects API

AE Profile APIs.io

#Deals

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

ActiveCampaign Deals API

Metadata

Authentication & Security 1

Paths & Operations 47

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

ActiveCampaign Deals API

Metadata

Authentication & Security 1

Paths & Operations 47

Specification

Source

More from ActiveCampaign 12

API Details

Provider

Explore more