Note 3 endpoints

DELETE /notes/{id} Delete a note

operationId: Note_deleteNoteById

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID of the note to delete

Responses

200

403

DELETE /notes/{id}

GET /notes/{id} Retrieve a note

operationId: Note_getById

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID of the note to retrieve

Responses

200

400

GET /notes/{id}

PUT /notes/{id} Update a note

operationId: Note_updateNoteById

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID of the note to update

Request Body

application/json

schema NoteUpdateNoteByIdRequest

Responses

200

403

PUT /notes/{id}

Order 5 endpoints

GET /ecomOrderProducts/{id} Retrieve an EcomOrderProduct

operationId: Order_getProductById

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the product you’d like returned.

Responses

200

400

404

GET /ecomOrderProducts/{id}

POST /ecomOrders Create an order

Create a new e-commerce order resource.

operationId: Order_createNewOrder

Request Body

application/json

schema OrderCreateNewOrderRequest

Responses

201

POST /ecomOrders

DELETE /ecomOrders/{ecomOrderId} Delete an order

Delete an existing e-commerce order resource.

operationId: Order_deleteOrder

Parameters

Name	In	Required	Type	Description
ecomOrderId	path	required	integer	The id of the order to delete.

Responses

200

DELETE /ecomOrders/{ecomOrderId}

GET /ecomOrders/{ecomOrderId} Retrieve an order

Retrieve an existing e-commerce order resource.

operationId: Order_getOrder

Parameters

Name	In	Required	Type	Description
ecomOrderId	path	required	integer	The id of the order to retrieve.

Responses

200

GET /ecomOrders/{ecomOrderId}

PUT /ecomOrders/{id} Update an order

Update an existing ecommerce order/cart resource.

operationId: Order_updateOrderResource

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the order to update

Request Body

application/json

schema OrderUpdateOrderResourceRequest

Responses

200

PUT /ecomOrders/{id}

Outcome 6 endpoints

DELETE /taskOutccomes/{id} Delete a task outcome

Delete an existing task outcome

operationId: Outcome_deleteTaskOutcome

Parameters

Name	In	Required	Type	Description
id	path	required	string	Task outcome’s id

Responses

200

404

DELETE /taskOutccomes/{id}

PUT /taskOutccomes/{id} Update a task outcome

Update an existing task outcome

operationId: Outcome_updateTaskOutcome

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Task outcome’s id

Request Body

application/json

schema OutcomeUpdateTaskOutcomeRequest

Responses

200

422

PUT /taskOutccomes/{id}

POST /taskOutcomes Create a task outcome

Create a new task outcome

operationId: Outcome_createTaskOutcome

Request Body

application/json

schema OutcomeCreateTaskOutcomeRequest

Responses

200

422

POST /taskOutcomes

GET /taskOutcomes/{id} Retrieve a task outcome

Retrieve an existing task outcome

operationId: Outcome_getTaskOutcome

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Task outcome’s id

Responses

200

404

GET /taskOutcomes/{id}

DELETE /tasktypeOutcomeRels/{id} Delete a task type - outcome relation

Delete an existing task type - outcome relation

operationId: Outcome_deleteTaskTypeOutcomeRelation

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Task type - outcome relation’s id

Responses

200

404

DELETE /tasktypeOutcomeRels/{id}

GET /tasktypeOutcomeRels/{id} Retrieve a task type - outcome relation

Retrieve an existing task type - outcome relation

operationId: Outcome_getTaskTypeOutcome

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Task type - outcome relation’s id

Responses

200

404

GET /tasktypeOutcomeRels/{id}

Record 1 endpoints

GET /records/{schemdId}/external/{externalId} Get a record by external id

operationId: Record_getByExternalId

Parameters

Name	In	Required	Type	Description
schemdId	path	required	string	ID of schema
externalId	path	required	string	External ID for record

Responses

200

400

GET /records/{schemdId}/external/{externalId}

Reminder 1 endpoints

POST /taskNotifications Create a task reminder

Create a new task outcome

operationId: Reminder_createTaskOutcome

Request Body

application/json

schema ReminderCreateTaskOutcomeRequest

Responses

200

422

POST /taskNotifications

Response 4 endpoints

POST /savedResponses Create a saved response

operationId: Response_createSavedResponse

Request Body

application/json

schema ResponseCreateSavedResponseRequest

Responses

201

422

POST /savedResponses

DELETE /savedResponses/{id} Delete a saved response

operationId: Response_removeById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the saved response to remove

Responses

200

404

DELETE /savedResponses/{id}

GET /savedResponses/{id} Retrieve a saved response

operationId: Response_getById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the saved Response to recieve

Responses

200

400

GET /savedResponses/{id}

PUT /savedResponses/{id} Update a saved response

operationId: Response_updateSavedResponse

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the saved response to update

Request Body

application/json

schema ResponseUpdateSavedResponseRequest

Responses

200

422

PUT /savedResponses/{id}

Schema 10 endpoints

POST /customObjects/records/{schemaId} Create or update record

operationId: Schema_createOrUpdateRecord

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema

Request Body

application/json

schema SchemaCreateOrUpdateRecordRequest

Responses

201

400

422

POST /customObjects/records/{schemaId}

DELETE /customObjects/records/{schemaId}/external/{externalId} Delete a record by external ID

operationId: Schema_deleteRecordByExternalId

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema
externalId	path	required	string	External ID of record

Responses

202

400

DELETE /customObjects/records/{schemaId}/external/{externalId}

DELETE /customObjects/records/{schemaId}/{recordId} Delete a record by id

operationId: Schema_deleteRecordById

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema
recordId	path	required	string	ID of record

Responses

202

400

DELETE /customObjects/records/{schemaId}/{recordId}

GET /customObjects/records/{schemaId}/{recordId} Get a record by id

operationId: Schema_getById

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema
recordId	path	required	string	ID of record

Responses

200

400

GET /customObjects/records/{schemaId}/{recordId}

POST /customObjects/schemas Create a schema

operationId: Schema_createNew

Request Body

application/json

schema SchemaCreateNewRequest

Responses

201

422

POST /customObjects/schemas

POST /customObjects/schemas/public Create a public schema

operationId: Schema_createPublicSchema

Request Body

application/json

schema SchemaCreatePublicSchemaRequest

Responses

200

400

POST /customObjects/schemas/public

DELETE /customObjects/schemas/{id} Delete a schema

operationId: Schema_deleteSchemaById

Parameters

Name	In	Required	Type	Description
id	path	required	string	Id of schema to delete

Responses

200

404

DELETE /customObjects/schemas/{id}

GET /customObjects/schemas/{id} Retrieve a schema

Retrieve a specific schema by id.

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

operationId: Schema_getById

Parameters

Name	In	Required	Type	Description
id	path	required	string	Id of the Schema
showFields	query	optional	string	Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.

Responses

200

404

GET /customObjects/schemas/{id}

POST /customObjects/schemas/{id}/child Create a child schema

operationId: Schema_createChildSchema

Parameters

Name	In	Required	Type	Description
id	path	required	string	Id of the parent schema the new child schema will extend

Responses

200

400

POST /customObjects/schemas/{id}/child

PUT /customObjects/schemas/{schemaId} Update a schema

Make an update to a given schema.

To delete a schema field, reference the field delete endpoint: https://developers.activecampaign.com/reference/delete-a-field-1

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

operationId: Schema_updateSchema

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	Id of Schema being updated
validateOnly	header	optional	boolean	When set to `true` the API will validate the schema update without saving changes
showFields	query	optional	string	Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.

Request Body

application/json

schema SchemaUpdateSchemaRequest

Responses

200

404

422

PUT /customObjects/schemas/{schemaId}

Score 1 endpoints

GET /scores/{id} Retrieve a score

operationId: Score_getScoreById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the score to retrieve

Responses

200

404

GET /scores/{id}

Segment 1 endpoints

GET /segments/{id} Retrieve a segment

operationId: Segment_getById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the segment to be retrieved

Responses

200

GET /segments/{id}

Status 1 endpoints

GET /siteTracking Retrieve status

Get site tracking status (enabled or disabled)

operationId: Status_getSiteTrackingStatus

Responses

200

400

GET /siteTracking

Tag 7 endpoints

POST /contactTags Add a tag to contact

Create a contact tag object

operationId: Tag_addContactTag

Request Body

application/json

schema TagAddContactTagRequest

Responses

201

404

422

POST /contactTags

DELETE /contactTags/{id} Remove a tag from a contact

Delete a contact tag object

operationId: Tag_removeTagFromContact

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The contactTag id

Responses

200

404

DELETE /contactTags/{id}

GET /tags List all tags

operationId: Tag_listAllTags

Parameters

Name	In	Required	Type	Description
search	query	optional	string	Filter by name of tag(s); “contains” operator is assumed.
filters[search][<operator>]	query	optional	string	Filters tags by tag name according to the operator specified. Operators currently supported: `eq`, `neq`, `lt`, `lte`, `gt`, `gte`, `contains`, `starts_with`
orders[search]	query	optional	string	Orders filtered results by weight, ascending order, or descending order. If `weight` is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results.

Responses

200

400

GET /tags

POST /tags Create a tag

operationId: Tag_createTag

Request Body

application/json

schema TagCreateTagRequest

Responses

201

POST /tags

DELETE /tags/{id} Delete a Tag

operationId: Tag_removeTag

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the tag to remove

Responses

200

404

DELETE /tags/{id}

GET /tags/{id} Retrieve a tag

operationId: Tag_getTag

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the tag to retrieve

Responses

200

404

GET /tags/{id}

PUT /tags/{id} Update a tag

operationId: Tag_updateTag

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the tag to update

Request Body

application/json

schema TagUpdateTagRequest

Responses

200

PUT /tags/{id}

Template 2 endpoints

GET /template/share Create Shareable Campaign Template Link

Create a shareable link to a campaign template

operationId: Template_createShareableLink

Parameters

Name	In	Required	Type	Description
api_key	query	optional	string	ActiveCampaign Account API Key
id	query	optional	integer	The id of the campaign template to be shared

Responses

200

GET /template/share

GET /templates/{id} Retrieve a template

operationId: Template_getById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the template to retrieve

Responses

200

404

GET /templates/{id}

Tracking 2 endpoints

PUT /siteTracking Enable/disable

Enable or disable site tracking

operationId: Tracking_enableDisableSite

Request Body

application/json

schema TrackingEnableDisableSiteRequest

Responses

200

400

PUT /siteTracking

GET /siteTracking/code Retrieve site tracking code

Get site tracking code

operationId: Tracking_getSiteCode

Responses

200

400

GET /siteTracking/code

User 6 endpoints

DELETE /addressGroups/{id} Delete address associated with a specific user group

operationId: User_deleteAddressGroup

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the AddressGroup to delete

Responses

200

404

DELETE /addressGroups/{id}

GET /users List all users

List all existing users

operationId: User_listAllUsers

Responses

200

400

GET /users

POST /users Create a user

Create a new user

operationId: User_createNewUser

Request Body

application/json

schema UserCreateNewUserRequest

Responses

201

400

POST /users

GET /users/email/{email} Retrieve a user by email

Retrieve an existing user by looking up their email address

operationId: User_getByEmail

Parameters

Name	In	Required	Type	Description
email	path	required	string	Email address of the user you want to view

Responses

200

400

GET /users/email/{email}

GET /users/me Retrieve logged-in user

Retrieve the logged-in user

operationId: User_getLoggedInUser

Responses

200

400

GET /users/me

GET /users/username/{username} Retrieve a user by username

Retrieve an existing user by looking up their username

operationId: User_getByUsername

Parameters

Name	In	Required	Type	Description
username	path	required	string	Username of the user you want to view

Responses

200

400

GET /users/username/{username}