Logo
ActiveCampaign Developer Relations API Documentation

ActiveCampaign API v3

Number of APIs: 160


1. Accounts - Account

GET {{yourAccountUrl}}/api/3/accounts/:id



2. Accounts - Create Account

POST {{yourAccountUrl}}/api/3/accounts



3. Accounts - Accounts list

GET {{yourAccountUrl}}/api/3/accounts



4. Accounts - Account

DELETE {{yourAccountUrl}}/api/3/accounts/:id



5. Accounts - Accounts (bulk)

DELETE {{yourAccountUrl}}/api/3/accounts/bulk_delete?ids[]=123&ids[]=456&ids[]=789



6. Accounts - Update Account

PUT {{yourAccountUrl}}/api/3/accounts/:id



7. Accounts - Create Account Note

POST {{yourAccountUrl}}/api/3/:id/notes



8. Accounts - Update Account Note

PUT {{yourAccountUrl}}/api/3/accounts/:id/notes/:noteId



9. Contacts-Custom Fields and Values-Field Values - Update Custom Field Value For Contact

POST {{yourAccountUrl}}/api/3/fieldValues



10. Contacts-Custom Fields and Values-Field Values - List All Custom Field Values

GET {{yourAccountUrl}}/api/3/fieldValues?limit=100



11. Contacts-Custom Fields and Values-Field Relationships - Add Field Relationship

POST {{yourAccountUrl}}/api/3/fieldRels



12. Contacts-Custom Fields and Values-Field Relationships - Get All Field Relationships

GET {{yourAccountUrl}}/api/3/fieldRels?limit=100



13. Contacts-Custom Fields and Values-Field Relationships - Delete Field Relationship

DELETE {{yourAccountUrl}}/api/3/:fieldRelId



14. Contacts-Custom Fields and Values - Add Custom Field

POST {{yourAccountUrl}}/api/3/fields



15. Contacts-Custom Fields and Values - Add Custom Field to Field Group

POST {{yourAccountUrl}}/api/3/groupMembers



16. Contacts-Custom Fields and Values - Get Custom Field Field Group

GET {{yourAccountUrl}}/api/3/groupMembers/:groupID



17. Contacts-Custom Fields and Values - Update Custom Field Field Group

PUT {{yourAccountUrl}}/api/3/groupMembers/:groupID



18. Contacts-Custom Fields and Values - Delete Custom Field Field Group

POST {{yourAccountUrl}}/api/3/groupMembers/:groupID



19. Contacts-Custom Fields and Values - Delete Custom Field

DELETE {{yourAccountUrl}}/api/3/fields/:fieldID



20. Contacts-Custom Fields and Values - Update Custom Field

PUT {{yourAccountUrl}}/api/3/fields/:fieldID



21. Contacts-Custom Fields and Values - List All Custom Fields

GET {{yourAccountUrl}}/api/3/fields



22. Contacts-Custom Fields and Values - Add Custom Field Options

POST {{yourAccountUrl}}/api/3/fieldOption/bulk



23. Contacts-Automations - Get Contact Automation Entry Counts

GET {{yourAccountUrl}}/api/3/contacts/:contactId/automationEntryCounts



24. Contacts-Automations - Get an Automation a Contact is in

GET {{yourAccountUrl}}/api/3/contactAutomations/:contactAutomationID



25. Contacts-Automations - Add a Contact to an Automation

POST {{yourAccountUrl}}/api/3/contactAutomations



26. Contacts-Automations - Remove a Contact from an Automation

DELETE {{yourAccountUrl}}/api/3/contactAutomations/:contactAutomationID



27. Contacts-Automations - Get Contact Automations

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactAutomations



28. Contacts - Get Contact by Email with Tags

GET {{yourAccountUrl}}/api/3/contacts?filters[email]=user@test.com&include=contactTags.tag



29. Contacts - Get Contact by ID

GET {{yourAccountUrl}}/api/3/contacts/:contactId



30. Contacts - Get Contact Data

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactData



31. Contacts - Get Contact Tags

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactTags



32. Contacts - Get Contact Bounce Logs

GET {{yourAccountUrl}}/api/3/contacts/:contactId/bounceLogs



33. Contacts - Get Contact Data Goals

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactGoals



34. Contacts - Get Contact Lists

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactLists



35. Contacts - Get Contact Logs

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactLogs



36. Contacts - Get Contact Deal List

GET {{yourAccountUrl}}/api/3/contacts/:contactId/contactDeals



37. Contacts - Get Contact Deals

GET {{yourAccountUrl}}/api/3/contacts/:contactId/deals



38. Contacts - Get Contact Field Values

GET {{yourAccountUrl}}/api/3/contacts/:contactId/fieldValues



39. Contacts - Get Contact Geo Ips List

GET {{yourAccountUrl}}/api/3/contacts/:contactId/geoIps



40. Contacts - Get Contact Geo Ip Address

GET {{yourAccountUrl}}/api/3/geoIps/:geoAddressID/geoAddress



41. Contacts - Get Contact Notes

GET {{yourAccountUrl}}/api/3/contacts/:contactId/notes



42. Contacts - Get Contact Organization

GET {{yourAccountUrl}}/api/3/contacts/:contactId/organization



43. Contacts - Get Contact Account Contacts

GET {{yourAccountUrl}}/api/3/contacts/:contactId/accountContacts



44. Contacts - Get Contact Plus Append

GET {{yourAccountUrl}}/api/3/contacts/:contactId/plusAppend



45. Contacts - Get Contact Tracking Logs

GET {{yourAccountUrl}}/api/3/contacts/:contactId/trackingLogs



46. Contacts - Create Contact

POST {{yourAccountUrl}}/api/3/contacts



47. Contacts - Sync Contact Data

POST {{yourAccountUrl}}/api/3/contact/sync



48. Contacts - Add contact to list

POST {{yourAccountUrl}}/api/3/contactLists



49. Contacts - Delete Contact

DELETE {{yourAccountUrl}}/api/3/contacts/:contactId



50. Contacts - Bulk Import

POST {{yourAccountUrl}}/api/3/import/bulk_import



51. Contacts - Bulk Import Status Info

GET {{yourAccountUrl}}/api/3/import/info?batchId=026bcb88-fc4d-4b5e-9b8a-9c080b406ad7



52. Contacts - Bulk Import Status List

GET {{yourAccountUrl}}/api/3/import/bulk_import



53. Campaigns-Variables - Get Variable(s)

GET {{yourAccountUrl}}/api/3/personalizations



54. Campaigns-Variables - Get Variable

GET {{yourAccountUrl}}/api/3/personalizations/:variableID



55. Campaigns-Variables - Create Variable

POST {{yourAccountUrl}}/api/3/personalizations



56. Campaigns-Variables - Edit Variable

PUT {{yourAccountUrl}}/api/3/personalizations/:variableID



57. Campaigns-Variables - Delete Variable

DELETE {{yourAccountUrl}}/api/3/personalizations/:variableID



58. Campaigns-Variables - Bulk Delete Variables

DELETE {{yourAccountUrl}}/api/3/personalizations/bulkdelete?ids=1,2



59. Campaigns - Get Links Associated to Campaign

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/links



60. Campaigns - Get Campaigns

GET {{yourAccountUrl}}/api/3/campaigns



61. Campaigns - Get Campaign by ID

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID



62. Campaigns - Get Campaign User

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/user



63. Campaigns - Get Campaign Automations

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/automation



64. Campaigns - Get Campaign Message

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/campaignMessage



65. Campaigns - Get Campaign Messages

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/campaignMessages



66. Campaigns - Get Campaign Aggregate Revenues

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/aggregateRevenues



67. Campaigns - Get Campaign Automation Segments

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/segment



68. Campaigns - Get Campaign Automation Campaign Lists

GET {{yourAccountUrl}}/api/3/campaigns/:campaignID/campaignLists



69. Campaigns - Edit Campaign

PUT {{yourAccountUrl}}/api/3/campaigns/:campaignID/edit



70. Campaigns - Duplicate Campaign

POST {{yourAccountUrl}}/api/3/campaigns/:campaignID/copy



71. Campaigns - Create Campaign

POST {{yourAccountUrl}}/api/3/campaign



72. Campaigns - Create Shareable Campaign Template Link

GET {{yourAccountUrl}}/api/2/template/share?api_key={{yourApiKey}}&id=1

Documentation Link



73. Messages - Get List of Messages

GET {{yourAccountUrl}}/api/3/messages



74. Messages - Retrieve a Message

GET {{yourAccountUrl}}/api/3/messages/:id



75. Messages - Create a Message

POST {{yourAccountUrl}}/api/3/messages



76. Messages - Delete a Message

DELETE {{yourAccountUrl}}/api/3/messages/:id



77. Messages - Update a Message

PUT {{yourAccountUrl}}/api/3/messages/:id



78. Tags - List all tags

GET {{yourAccountUrl}}/api/3/tags



79. Tags - Create a tag

POST {{yourAccountUrl}}/api/3/tags



80. Tags - Update a tag

PUT {{yourAccountUrl}}/api/3/tags/:tagId



81. Tags - Delete a tag

DELETE {{yourAccountUrl}}/api/3/tags/:tagId



82. Tags - Add a tag to a contact

POST {{yourAccountUrl}}/api/3/contactTags



83. Lists - Get Lists

GET {{yourAccountUrl}}/api/3/lists?limit=5



84. Lists - Create List

POST {{yourAccountUrl}}/api/3/lists



85. Custom Objects-Schemas-Parent and Child Schemas - Create a public schema

POST {{yourAccountUrl}}/api/3/customObjects/schemas/public



86. Custom Objects-Schemas-Parent and Child Schemas - Create a child schema

POST {{yourAccountUrl}}/api/3/customObjects/schemas/:parentSchemaId/child



87. Custom Objects-Schemas - List all schemas

GET {{yourAccountUrl}}/api/3/customObjects/schemas



88. Custom Objects-Schemas - Listing records for a Schema

GET {{yourAccountUrl}}/api/3/customObjects/records/:schemaID



89. Custom Objects-Schemas - Update Schema

PUT {{yourAccountUrl}}/api/3/customObjects/schemas/:schemaId



90. Custom Objects-Schemas - Create Schema

POST {{yourAccountUrl}}/api/3/customObjects/schemas



91. Custom Objects-Schemas - Get Schema by ID

GET {{yourAccountUrl}}/api/3/customObjects/schemas/:schemaId



92. Custom Objects-Schemas - Delete Schema

DELETE {{yourAccountUrl}}/api/3/customObjects/schemas/:schemaId



93. Custom Objects-Managing Records - Get a list of records

GET {{yourAccountUrl}}/api/3/customObjects/records/:schemaId?filters[relationships.primary-contact][eq]=14



94. Custom Objects-Managing Records - Create or Update a record

POST {{yourAccountUrl}}/api/3/customObjects/records/:schemaId



95. Custom Objects-Managing Records - Get record by id

GET {{yourAccountUrl}}/api/3/customObjects/records/:schemaId/:recordId



96. Custom Objects-Managing Records - Delete record by id

DELETE {{yourAccountUrl}}/api/3/customObjects/records/:schemaId/:recordId



97. Custom Objects-Managing Records - Get record by external id

GET {{yourAccountUrl}}/api/3/customObjects/records/:schemaId/external/:externalId



98. Custom Objects-Managing Records - Delete record by external id

DELETE {{yourAccountUrl}}/api/3/customObjects/records/:schemaId/external/:externalId



99. Groups - Get Groups

GET {{yourAccountUrl}}/api/3/groups



100. Groups - Get Group Limits

GET {{yourAccountUrl}}/api/3/groupLimits



101. Groups - Create Group

POST {{yourAccountUrl}}/api/3/groups



102. Groups - Get Group By ID

GET {{yourAccountUrl}}/api/3/groups/:groupId



103. Groups - Get Users By Group

GET {{yourAccountUrl}}/api/3/groups/:groupId/userGroups



104. Users - Create User

POST {{yourAccountUrl}}/api/3/users



105. Users - Get Users

GET {{yourAccountUrl}}/api/3/users



106. Users - Get User

GET {{yourAccountUrl}}/api/3/users/:userId



107. Users - Get User By Email

GET {{yourAccountUrl}}/api/3/users/email/:email



108. Users - Get User By Username

GET {{yourAccountUrl}}/api/3/users/username/:username



109. Users - Get Logged-In User

GET {{yourAccountUrl}}/api/3/users/me



110. Users - Update a User

PUT {{yourAccountUrl}}/api/3/users/:userId



111. Users - Delete a User

DELETE {{yourAccountUrl}}/api/3/users/:userId



112. Deals-Deal Roles - Create a deal role

POST {{yourAccountUrl}}/api/3/dealRoles



113. Deals - Create a deal

POST {{yourAccountUrl}}/api/3/deals



114. Deals - Create a deal note

POST {{yourAccountUrl}}/api/3/deals/:id/notes



115. Deals - Retrieve a deal

GET {{yourAccountUrl}}/api/3/deals/:id



116. Deals - Retrieve A Deal Activities

GET {{yourAccountUrl}}/api/3/deals/:id/dealActivities



117. Deals - Retrieve all deals

GET {{yourAccountUrl}}/api/3/deals



118. Deals - Delete a deal

DELETE {{yourAccountUrl}}/api/3/deals/:id



119. Deals - Update a deal

PUT {{yourAccountUrl}}/api/3/deals/:id



120. Deals - Update a deal note

PUT {{yourAccountUrl}}/api/3/deals/:dealId/notes/:noteId



121. Deals - Bulk update deal owners

PATCH {{yourAccountUrl}}/api/3/deals/bulkUpdate



122. Site & Event Tracking-Event Tracking - Create a new Event (Name Only)

POST {{yourAccountUrl}}/api/3/eventTrackingEvents



123. Site & Event Tracking-Event Tracking - Enable/Disable Event Tracking

PUT {{yourAccountUrl}}/api/3/eventTracking



124. Site & Event Tracking-Event Tracking - Track Event

POST https://trackcmp.net/event



125. Site & Event Tracking-Event Tracking - List All Events (Name Only)

GET {{yourAccountUrl}}/api/3/eventTrackingEvents



126. Site & Event Tracking-Event Tracking - Get Event Tracking Status

GET {{yourAccountUrl}}/api/3/eventTracking



127. Site & Event Tracking-Event Tracking - Delete Event

DELETE {{yourAccountUrl}}/api/3/eventTrackingEvent/:eventName



128. Site & Event Tracking-Event Tracking - Get Contact By Event ID

GET {{yourAccountUrl}}/api/3/trackingLogs/:eventId/contact



129. Site & Event Tracking-Event Tracking - Get Contact Events and Activities

GET {{yourAccountUrl}}/api/3/activities?contact=123



130. Site & Event Tracking-Event Tracking - Get Contact's Tracking Logs/Events

GET {{yourAccountUrl}}/api/3/contacts/:contactId/trackingLogs



131. Site & Event Tracking-Site Tracking - Add Domain To WhiteList

POST {{yourAccountUrl}}/api/3/siteTrackingDomains



132. Site & Event Tracking-Site Tracking - Remove Domain From WhiteList

DELETE {{yourAccountUrl}}/api/3/siteTrackingDomains/:name



133. Site & Event Tracking-Site Tracking - Get Site Tracking Code

GET {{yourAccountUrl}}/api/3/siteTracking/code



134. Site & Event Tracking-Site Tracking - Get Site Tracking Status

GET {{yourAccountUrl}}/api/3/siteTracking



135. Site & Event Tracking-Site Tracking - List All WhiteListed Domains

GET {{yourAccountUrl}}/api/3/siteTrackingDomains



136. Site & Event Tracking-Site Tracking - Enable/Disable Site Tracking

PUT {{yourAccountUrl}}/api/3/siteTracking



137. E-Commerce (REST)-Connections - Create a Connection

POST {{yourAccountUrl}}/api/3/connections



138. E-Commerce (REST)-Connections - Update a Connection

PUT {{yourAccountUrl}}/api/3/connections/:connectionId



139. E-Commerce (REST)-Connections - Delete a Connection

DELETE {{yourAccountUrl}}/api/3/connections/:connectionId



140. E-Commerce (REST)-Connections - Retrieve a Connection

GET {{yourAccountUrl}}/api/3/connections/:connectionId



141. E-Commerce (REST)-Connections - Retrieve all Connections

GET {{yourAccountUrl}}/api/3/connections



142. E-Commerce (REST)-Customers - Create a Customer

POST {{yourAccountUrl}}/api/3/ecomCustomers



143. E-Commerce (REST)-Customers - Update a Customer

PUT {{yourAccountUrl}}/api/3/ecomCustomers/:customerId



144. E-Commerce (REST)-Customers - Retrieve a Customer

GET {{yourAccountUrl}}/api/3/ecomCustomers/:customerId



145. E-Commerce (REST)-Customers - Retrieve all Customers

GET {{yourAccountUrl}}/api/3/ecomCustomers



146. E-Commerce (REST)-Customers - Delete a Customer

DELETE {{yourAccountUrl}}/api/3/ecomCustomers/:customerId



147. E-Commerce (REST)-Orders - Create Abandoned Cart

POST {{yourAccountUrl}}/api/3/ecomOrders



148. E-Commerce (REST)-Orders - Update an Order

PUT {{yourAccountUrl}}/api/3/ecomOrders/:ecomOrderId



149. E-Commerce (REST)-Orders - Retrieve an Order

GET {{yourAccountUrl}}/api/3/ecomOrders/:ecomOrderId



150. E-Commerce (REST)-Orders - Retrieve all Orders

GET {{yourAccountUrl}}/api/3/ecomOrders?filters[connectionid]&filters[externalid]&filters[externalcheckoutid]&filters[email]&filters[state]&filters[customerid]&filters[external_created_date]&orders[connectionid]&orders[externalid]&orders[externalcheckoutid]&orders[email]&orders[state]&orders[customerid]&orders[external_created_date]



151. E-Commerce (REST)-Orders - Delete an Order

DELETE {{yourAccountUrl}}/api/3/ecomOrders/:ecomOrderId



152. E-Commerce (REST)-Products - Retrieve Order Products

GET {{yourAccountUrl}}/api/3/ecomOrderProducts



153. E-Commerce (REST)-Products - Retrieve all Products for a Specific Order

GET {{yourAccountUrl}}/api/3/ecomOrders/:orderId/orderProducts



154. E-Commerce (REST)-Products - Retrieve an Order Product

GET {{yourAccountUrl}}/api/3/ecomOrderProducts/:productId



155. Webhooks - Create a Webhook

POST {{yourAccountUrl}}/api/3/webhooks



156. Webhooks - Update a Webhook

PUT {{yourAccountUrl}}/api/3/webhooks/:id



157. Webhooks - Retrieve a Webhook

GET {{yourAccountUrl}}/api/3/webhooks/:id



158. Webhooks - Retrieve All Webhooks

GET {{yourAccountUrl}}/api/3/webhooks



159. Webhooks - Retrieve All Webhook Events

GET {{yourAccountUrl}}/api/3/webhook/events



160. Webhooks - Delete a Webhook

DELETE {{yourAccountUrl}}/api/3/webhooks/:id



ENDPOINTS