ActiveCampaign

ActiveCampaign is a customer experience automation platform that combines email marketing, marketing automation, CRM, sales engagement, and transactional messaging for small and mid-sized businesses. The ActiveCampaign API v3 is a REST/JSON API organized around resources such as contacts, deals, automations, campaigns, lists, and tags, with per-account base URLs of the form youraccountname.api-us1.com/api/3. Authentication is performed via an Api-Token HTTP header containing the account API key.

1 APIs 0 Features

Marketing AutomationEmail MarketingCRMCustomer Experience AutomationSales Engagement

Sources

opencollection: 1.0.0
info:
  name: ActiveCampaign API
  version: '3'
request:
  auth:
    type: apikey
    key: Api-Token
    value: '{{Api-Token}}'
    placement: header
items:
- info:
    name: Contacts
    type: folder
  items:
  - info:
      name: List, search, and filter contacts
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/contacts
    docs: List, search, and filter contacts
  - info:
      name: Create a contact
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/contacts
    docs: Create a contact
  - info:
      name: Sync (update) a contact
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/contacts/:contactID
    docs: Sync (update) a contact
  - info:
      name: View recent activity for a contact
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/contacts/:contactID/activities
    docs: View recent activity for a contact
  - info:
      name: Retrieve a contact's geo-IP list
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/contacts/:contactID/geoips
    docs: Retrieve a contact's geo-IP list
- info:
    name: Custom Fields
    type: folder
  items:
  - info:
      name: List all custom fields
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/fields
    docs: List all custom fields
  - info:
      name: Create a custom field
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/fields
    docs: Create a custom field
  - info:
      name: Retrieve a specific custom field
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/fields/:fieldID
    docs: Retrieve a specific custom field
  - info:
      name: Update a custom field value for a contact
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/fieldValues
    docs: Update a custom field value for a contact
- info:
    name: Deals
    type: folder
  items:
  - info:
      name: Create a new deal
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/deals
    docs: Create a new deal
  - info:
      name: List deal custom fields
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/dealCustomFieldMeta
    docs: List deal custom fields
  - info:
      name: Create a deal custom field
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/dealCustomFieldMeta
    docs: Create a deal custom field
- info:
    name: Lists
    type: folder
  items:
  - info:
      name: Create a new list
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/lists
    docs: Create a new list
- info:
    name: Campaigns
    type: folder
  items:
  - info:
      name: Create a campaign
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/campaigns
    docs: Create a campaign
  - info:
      name: Edit a campaign
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/campaigns/:campaignID
    docs: Edit a campaign
  - info:
      name: Duplicate a campaign
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/campaigns/:campaignID/duplicate
    docs: Duplicate a campaign
  - info:
      name: Update a campaign message
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/messages/:messageID
    docs: Update a campaign message
- info:
    name: Variables
    type: folder
  items:
  - info:
      name: List personalization variables
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/variables
    docs: List personalization variables
  - info:
      name: Create a personalization variable
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/variables
    docs: Create a personalization variable
  - info:
      name: Retrieve a variable
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/variables/:variableID
    docs: Retrieve a variable
  - info:
      name: Edit a variable
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/variables/:variableID
    docs: Edit a variable
  - info:
      name: Delete a variable
      type: http
    http:
      method: DELETE
      url: https://{account}.api-us1.com/api/3/variables/:variableID
    docs: Delete a variable
- info:
    name: Bulk
    type: folder
  items:
  - info:
      name: Bulk import contacts
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/contacts/import
    docs: Bulk import contacts
  - info:
      name: Check the status of a bulk contact import
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/contacts/import/:importID/status
    docs: Check the status of a bulk contact import
  - info:
      name: Bulk delete accounts
      type: http
    http:
      method: DELETE
      url: https://{account}.api-us1.com/api/3/accounts/bulk
    docs: Bulk delete accounts
- info:
    name: Segments
    type: folder
  items:
  - info:
      name: Create a segment
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/segments
    docs: Create a segment
  - info:
      name: Retrieve a segment
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/segments/:segmentID
    docs: Retrieve a segment
  - info:
      name: Update a segment
      type: http
    http:
      method: PUT
      url: https://{account}.api-us1.com/api/3/segments/:segmentID
    docs: Update a segment
  - info:
      name: Delete a segment
      type: http
    http:
      method: DELETE
      url: https://{account}.api-us1.com/api/3/segments/:segmentID
    docs: Delete a segment
- info:
    name: Broadcasts
    type: folder
  items:
  - info:
      name: List broadcast messages
      type: http
    http:
      method: GET
      url: https://{account}.api-us1.com/api/3/broadcasts
    docs: List broadcast messages
  - info:
      name: Create an SMS broadcast message
      type: http
    http:
      method: POST
      url: https://{account}.api-us1.com/api/3/broadcasts
    docs: Create an SMS broadcast message
bundled: true

ActiveCampaign

APIs

ActiveCampaign API v3

Collections

ActiveCampaign API

Resources

Sources