Deal 3 endpoints

PUT /deals/{id} Update a deal

Update an existing deal

operationId: Deal_updateExistingDeal

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The Deal’s id

Request Body

application/json

schema DealUpdateExistingDealRequest

Responses

200

400

PUT /deals/{id}

POST /deals/{id}/notes Create a deal note

Create a new note for a deal

operationId: Deal_createNote

Parameters

Name	In	Required	Type	Description
id	path	required	string	The Deal’s id to assign new note to

Request Body

application/json

schema DealCreateNoteRequest

Responses

201

POST /deals/{id}/notes

PUT /deals/{id}/notes/{noteId} Update a deal note

Update an existing note for a deal

operationId: Deal_updateNote

Parameters

Name	In	Required	Type	Description
id	path	required	string	Deal’s id to assign new note to
noteId	path	required	string	Deal note’s id to update

Request Body

application/json

schema DealUpdateNoteRequest

Responses

200

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

Event 7 endpoints

GET /contacts/{contactId}/trackingLogs Get Contact's Tracking Logs/Events

Get a log of events for a Contact

operationId: Event_getTrackingLogs

Parameters

Name	In	Required	Type	Description
contactId	path	required	string	The Contact’s ID

Responses

200

GET /contacts/{contactId}/trackingLogs

POST /event Track event

Track an event using event tracking. Event Tracking must be toggled on in your ActiveCampaign account on “Website” -> “Site Tracking” (scroll down to Event tracking) in order for this call to work.

operationId: Event_trackEvent

Request Body

application/json

schema EventTrackEventRequest

Responses

200

400

POST /event

GET /eventTracking Retrieve Event Tracking Status

Get event tracking status (enabled or disabled)

operationId: Event_getStatus

Responses

200

GET /eventTracking

PUT /eventTracking Enable/disable

Enable or disable event tracking

operationId: Event_toggleStatus

Request Body

application/json

schema EventToggleStatusRequest

Responses

200

400

PUT /eventTracking

POST /eventTrackingEvents Create a new event (name only)

Create a new event tracking event (name only)

operationId: Event_createNewEvent

Request Body

application/json

schema EventCreateNewEventRequest

Responses

201

POST /eventTrackingEvents

DELETE /eventTrackingEvents/{eventName} Delete event (name only)

Remove an existing event tracking event (name only)

operationId: Event_deleteEventName

Parameters

Name	In	Required	Type	Description
eventName	path	required	string	Name of event to delete. Spaces in names are allowed, but must be encoded (for example, “my%20event”).

Responses

200

400

DELETE /eventTrackingEvents/{eventName}

GET /trackingLogs/{eventId}/contact Get Contact By Event ID

Get the contact that was involved in an event.

operationId: Event_getContactByEventId

Parameters

Name	In	Required	Type	Description
eventId	path	required	string	The Event’s ID

Responses

200

GET /trackingLogs/{eventId}/contact

Field 26 endpoints

POST /accountCustomFieldData Create a custom field value

operationId: Field_createCustomFieldValue

Request Body

application/json

schema FieldCreateCustomFieldValueRequest

Property	Type	Required
accountCustomFieldDatum	object	optional
└ fieldValue	string	required
└ customFieldId	integer	required
└ fieldCurrency	string	optional
└ customerAccountId	integer	required

Responses

200

POST /accountCustomFieldData

POST /accountCustomFieldData/bulkCreate Bulk create a custom account field value

operationId: Field_bulkCreateCustomAccountFieldValue

Request Body

application/json

schema FieldBulkCreateCustomAccountFieldValueRequest

Property	Type	Required
array	object	optional
└ fieldValue	string	required
└ customFieldId	integer	required
└ fieldCurrency	string	optional
└ customerAccountId	integer	required

Responses

200

POST /accountCustomFieldData/bulkCreate

PATCH /accountCustomFieldData/bulkUpdate Bulk update a custom field value

operationId: Field_bulkUpdateCustomFieldValue

Request Body

application/json

schema FieldBulkUpdateCustomFieldValueRequest

Property	Type	Required
array	object	optional
└ id	integer	required
└ fieldValue	string	required
└ fieldCurrency	string	optional

Responses

200

PATCH /accountCustomFieldData/bulkUpdate

DELETE /accountCustomFieldData/{id} Delete a custom field value

operationId: Field_deleteCustomFieldValue

Parameters

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

Responses

200

404

DELETE /accountCustomFieldData/{id}

GET /accountCustomFieldData/{id} Retrieve a custom field value

operationId: Field_getCustomValue

Parameters

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

Responses

200

404

GET /accountCustomFieldData/{id}

PUT /accountCustomFieldData/{id} Update a custom field value

operationId: Field_updateCustomFieldValue

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the custom fields value to update

Request Body

application/json

schema FieldUpdateCustomFieldValueRequest

Property	Type	Required
accountCustomFieldDatum	object	optional
└ fieldValue	string	optional
└ fieldCurrency	string	optional

Responses

200

404

PUT /accountCustomFieldData/{id}

POST /accountCustomFieldMeta Create a custom field

operationId: Field_createCustomFieldMeta

Request Body

application/json

schema FieldCreateCustomFieldMetaRequest

Property	Type	Required
accountCustomFieldMetum	object	optional
└ fieldType	string	required
└ fieldLabel	string	required
└ displayOrder	integer	optional
└ fieldDefault	string	optional
└ fieldOptions	array	optional
└ isFormVisible	boolean	optional
└ fieldDefaultCurrency	string	optional

Responses

200

422

POST /accountCustomFieldMeta

DELETE /accountCustomFieldMeta/{id} Delete a custom field

operationId: Field_deleteCustomFieldMeta

Parameters

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

Responses

200

404

DELETE /accountCustomFieldMeta/{id}

GET /accountCustomFieldMeta/{id} Retrieve a custom field

operationId: Field_getCustomField

Parameters

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

Responses

200

404

GET /accountCustomFieldMeta/{id}

PUT /accountCustomFieldMeta/{id} Update a custom field

operationId: Field_updateCustomFieldMeta

Parameters

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

Request Body

application/json

schema FieldUpdateCustomFieldMetaRequest

Property	Type	Required
accountCustomFieldMetum	object	optional
└ fieldLabel	string	optional
└ displayOrder	integer	optional
└ fieldDefault	string	optional
└ fieldOptions	array	optional
└ isFormVisible	boolean	optional

Responses

200

404

PUT /accountCustomFieldMeta/{id}

GET /contacts/{id}/fieldValues Retrieve a contact's field values

operationId: Field_getValues

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the contact

Responses

200

404

GET /contacts/{id}/fieldValues

DELETE /customObjects/schemas/{schemaId}/fields/{fieldId} Delete a field

Deleting a schema field is an irreversible process.

Assuming a valid 202 Accepted response is received, any associated field data on associated records will immediately be unavailable to the user. There may be a small delay if record requests are in the midst of processing when the field delete request is issued.

The deleted field id will not be immediately recycled for reuse. 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.

The field delete operation is only permitted for admin users.
Field deletion is not permitted on public or child schemas (private schemas only).

operationId: Field_deleteField

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	Schema ID of the field to be deleted
fieldId	path	required	string	Field ID of the field to be deleted
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

202

DELETE /customObjects/schemas/{schemaId}/fields/{fieldId}

POST /fieldOption/bulk Create custom field options

operationId: Field_createCustomFieldOptions

Request Body

application/json

schema FieldCreateCustomFieldOptionsRequest

Responses

201

422

POST /fieldOption/bulk

POST /fieldValues Create a custom field value

operationId: Field_createCustomValue

Request Body

application/json

schema FieldCreateCustomValueRequest

Responses

200

403

POST /fieldValues

DELETE /fieldValues/{id} Delete a custom field value

operationId: Field_deleteCustomValue

Parameters

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

Responses

200

403

DELETE /fieldValues/{id}

GET /fieldValues/{id} Retrieve a custom field value

operationId: Field_getCustomValue

Parameters

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

Responses

200

403

GET /fieldValues/{id}

PUT /fieldValues/{id} Update a custom field value for contact

operationId: Field_updateCustomValue

Parameters

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

Request Body

application/json

schema FieldUpdateCustomValueRequest

Responses

200

400

PUT /fieldValues/{id}

GET /fields List all custom fields

operationId: Field_listAllCustom

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The number of fields returned per request.

Responses

200

GET /fields

POST /fields Create a custom field

operationId: Field_createCustomField

Request Body

application/json

schema FieldCreateCustomFieldRequest

Responses

201

403

422

POST /fields

DELETE /fields/{id} Delete a custom field

operationId: Field_deleteCustomField

Parameters

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

Responses

200

404

DELETE /fields/{id}

GET /fields/{id} Retrieve a custom field

operationId: Field_getCustomField

Parameters

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

Responses

200

400

GET /fields/{id}

PUT /fields/{id} Update a custom field

operationId: Field_updateCustomField

Parameters

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

Request Body

application/json

schema FieldUpdateCustomFieldRequest

Responses

200

403

PUT /fields/{id}

POST /groupMembers Add Custom Field to Field Group

operationId: Field_addGroupMember

Request Body

application/json

schema FieldAddGroupMemberRequest

Responses

200

403

404

422

POST /groupMembers

DELETE /groupMembers/{groupID} Delete Custom Field Field Group

operationId: Field_deleteFieldGroup

Parameters

Name	In	Required	Type	Description
groupID	path	required	string	Group ID

Request Body

application/json

schema FieldDeleteFieldGroupRequest

Responses

200

404

DELETE /groupMembers/{groupID}

GET /groupMembers/{groupID} (COPY) Get Custom Field to Field Group

operationId: Field_getFieldGroup

Parameters

Name	In	Required	Type	Description
groupID	path	required	string	Group ID

Request Body

application/json

schema FieldGetFieldGroupRequest

Responses

200

404

GET /groupMembers/{groupID} (COPY)

PUT /groupMembers/{groupId} Update Custom Field Field Group

operationId: Field_updateCustomFieldGroup

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	Field group ID (see notes)

Request Body

application/json

schema FieldUpdateCustomFieldGroupRequest

Responses

200

403

404

422

PUT /groupMembers/{groupId}

Form 2 endpoints

GET /forms List all forms

operationId: Form_listAll

Responses

200

400

GET /forms

GET /forms/{id} Retrieve a form

operationId: Form_getForm

Parameters

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

Responses

200

403

GET /forms/{id}

Group 4 endpoints

POST /groups Create a group

operationId: Group_createNewGroup

Request Body

application/json

schema GroupCreateNewGroupRequest

Responses

200

POST /groups

DELETE /groups/{id} Delete a group

operationId: Group_deleteGroup

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the group to be deleted

Responses

200

400

DELETE /groups/{id}

GET /groups/{id} Retrieve a group

operationId: Group_getGroup

Parameters

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

Responses

200

403

GET /groups/{id}

PUT /groups/{id} Update a group

operationId: Group_updateGroupById

Parameters

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

Request Body

application/json

schema GroupUpdateGroupByIdRequest

Responses

200

403

PUT /groups/{id}

Import 1 endpoints

GET /import/info Bulk import status info

operationId: Import_statusInfo

Parameters

Name	In	Required	Type	Description
batchId	query	optional	string	—

Responses

200

400

GET /import/info

List 7 endpoints

GET /accountContacts List all associations

Retrieve all existing account association

operationId: List_accountAssociations

Parameters

Name	In	Required	Type	Description
filters[contact]	query	optional	integer	Filter by Contact ID
filters[account]	query	optional	integer	Filter by Account ID

Responses

200

GET /accountContacts

GET /accountCustomFieldData List all custom field values

operationId: List_customFieldValues

Parameters

Name	In	Required	Type	Description
filters[customerAccountId]	query	optional	string	Filter results by a specific account (note that Id uses a capital I)

Responses

200

GET /accountCustomFieldData

GET /accountCustomFieldMeta List all custom fields

operationId: List_allCustomFieldMeta

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The number of fields returned per request.

Responses

200

GET /accountCustomFieldMeta

GET /accounts List all accounts

Retrieve all existing account

operationId: List_allAccounts

Parameters

Name	In	Required	Type	Description
search	query	optional	string	Search by name
count_deals	query	optional	boolean	Whether to compute the contactCount and dealCount counts for the number of contacts/deals associated with each account. Set it to true to include the right counts. If set to false or omitted from the call, then contactCount and dealCount will not be counted and be simply displayed as 0.

Responses

200

400

GET /accounts

GET /activities List all contact activities

View a contact’s recent activity. The activity is generated when a contact is retrieved via /api/3/contacts/[contactID]. This endpoint should be used after retrieving a contact to obtain the latest data. This is useful for searching for contacts that match certain criteria - such as being part of a certain list, or having a specific custom field value.

operationId: List_contactActivities

Parameters

Name	In	Required	Type	Description
contact	query	optional	integer	Required Contact ID
after	query	optional	string	Filter for activities after a specific DateTime
include	query	optional	string	Activities to include: notes, notes.user, recipients, recipients.recipient, reference, reference.automation, reference.campaign, reference.campaign.campaignList, reference.campaign.campaignMessage, reference.campaignMessage, reference.contact, reference.contactList, reference.contactList.list, reference.deal, reference.deal.contact, reference.dealTasktype, reference.link, reference.list, reference.log, reference.log.campaign, reference.log.contact, reference.log.message, reference.message, reference.note, reference.sms, reference.sms.automation, user
emails	query	optional	boolean	—
orders[tstamp]	query	optional	string	Order activities by tstamp

Responses

200

400

GET /activities

DELETE /addressLists/{id} Delete address associated with a specific list

operationId: List_deleteAssociatedAddress

Parameters

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

Responses

200

404

DELETE /addressLists/{id}

GET /addresses List all addresses

operationId: List_addresses

Responses

200

400

GET /addresses