openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Other API
description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign
version: 3.0.0
contact:
name: ActiveCampaign Support
url: https://www.activecampaign.com
x-generated-from: documentation
servers:
- url: https://{yourAccountName}.api-us1.com/api/3
description: US-based Users
variables:
yourAccountName:
default: yourAccountName
security:
- ApiToken: []
tags:
- name: Other
paths:
/activities:
get:
summary: ActiveCampaign List a Contact's Activities
description: View your 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-contact-activities
parameters:
- name: contact
in: query
description: Required Contact ID
schema:
type: integer
format: int32
- name: after
in: query
description: Filter for activities after a specific DateTime
schema:
type: string
format: date
- name: include
in: query
description: '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'
schema:
type: string
default: activities to include
- name: orders[tstamp]
in: query
description: Order activities by tstamp
schema:
type: string
- name: emails
in: query
description: 'FALSE: Excludes email data fields under each activity. No specific connection to emails is mentioned in the JSON data. TRUE: Returns deal activities that include email data fields like "connection_email." Each deal activity specifies the addition of email connection information along with timestamps and relevant metadata.'
schema:
type: boolean
default: false
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n\tcontacts: [{\n cdate: \"2018-02-13T13:25:54-06:00\",\n email: \"test@example.com\",\n firstName: \"Test\",\n lastName: \"Contact\",\n created_timestamp: \"2019-11-13 16:18:00\",\n updated_timestamp: \"2021-04-06 11:25:59\",\n id: \"4\"\n }],\n activityRecipients: [{\n reltype: \"Subscriber\",\n relid: \"4\",\n activityid: \"865\",\n recipient: {\n type: \"contact\",\n id: \"4\"\n }],\n\tactivities: [{\n tstamp: \"2019-01-03T12:16:19-06:00\",\n subscriberid: \"4\",\n reference_type: \"SubscriberEmail\",\n reference_id: \"13\",\n reference_action: \"\",\n jsonData: null,\n userid: \"1\",\n permission: \"\",\n referenceModelName: \"contact-email\",\n notes: [ ],\n recipients: [\n\t \"1496\"\n ],\n reference: {\n type: \"contact-email\",\n id: \"13\"\n },\n user: \"1\",\n id: \"865\"\n }],\n\tmeta: {\n\t\ttotal: \"1\"\n\t}\n}"
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/geoIps/{geoAddressID}/geoAddress:
get:
summary: ActiveCampaign Retrieve a Contacts Geo IP Address
description: ''
operationId: retrieve-a-contacts-geo-ip-address
parameters:
- name: geoAddressID
in: path
description: ID of the contact
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"geoAddress\": {\n \"ip4\": \"1234567890\",\n \"country2\": \"US\",\n \"country\": \"United States\",\n \"state\": \"New York\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"area\": \"0\",\n \"lat\": \"40.7128\",\n \"lon\": \"-74.0060\",\n \"tz\": \"America/Chicago\",\n \"tstamp\": \"2023-12-20T14:14:46-06:00\",\n \"links\": [],\n \"id\": \"3\"\n }\n}"
schema:
type: object
properties:
geoAddress:
type: object
properties:
ip4:
type: string
example: '1234567890'
country2:
type: string
example: US
country:
type: string
example: United States
state:
type: string
example: New York
city:
type: string
example: New York
zip:
type: string
example: '10001'
area:
type: string
example: '0'
lat:
type: string
example: '40.7128'
lon:
type: string
example: '-74.0060'
tz:
type: string
example: America/Chicago
tstamp:
type: string
example: '2023-12-20T14:14:46-06:00'
links:
type: array
id:
type: string
example: '3'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for Subscriber with id 100\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Subscriber with id 100
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/emailActivities:
get:
summary: ActiveCampaign List All Email Activities
description: ''
operationId: list-all-email-activities
parameters:
- name: filters[subscriberid]
in: query
description: Set this parameter to return only email activities belonging to a given subscriber.
schema:
type: integer
format: int32
- name: filters[dealId]
in: query
description: Set this parameter to return only email activities belonging to a given deal.
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/records/{schemdId}/external/{externalId}:
get:
summary: ActiveCampaign Get a Record by External Id
description: ''
operationId: get-a-single-record-using-external-id
parameters:
- name: schemdId
in: path
description: ID of schema
schema:
type: string
required: true
- name: externalId
in: path
description: External ID for record
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"record\": {\n \"id\": \"1fba439a-208e-48e6-bd23-f6c97c3e0519\",\n \"externalId\": \"test-obj-1\",\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"primary-contact\": [\n \"14\"\n ]\n },\n \"createdTimestamp\": \"2021-04-16T16:12:22.222685095Z\",\n \"updatedTimestamp\": \"2021-04-16T16:13:12.022671090Z\"\n }\n}"
schema:
type: object
properties:
record:
type: object
properties:
id:
type: string
example: 1fba439a-208e-48e6-bd23-f6c97c3e0519
externalId:
type: string
example: test-obj-1
schemaId:
type: string
example: 6449c3f3-b68d-46d1-850b-c8aea998ce1b
fields:
type: array
items:
type: object
properties:
id:
type: string
example: my-number-field
value:
type: integer
example: 100
default: 0
relationships:
type: object
properties:
primary-contact:
type: array
items:
type: string
example: '14'
createdTimestamp:
type: string
example: '2021-04-16T16:12:22.222685095Z'
updatedTimestamp:
type: string
example: '2021-04-16T16:13:12.022671090Z'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: "{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}"
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: integer
example: 400
default: 0
title:
type: string
example: Bad Request
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/connections:
post:
summary: ActiveCampaign Create a Connection
description: Create a new connection resource.
operationId: create-connection
requestBody:
content:
application/json:
schema:
type: object
properties:
connection:
properties:
service:
type: string
description: The name of the service.
externalid:
type: string
description: The id of the account in the external service.
name:
type: string
description: The name associated with the account in the external service. Often this will be a company name (e.g., 'My Toystore, Inc.').
logoUrl:
type: string
description: The URL to a logo image for the external service.
linkUrl:
type: string
description: The URL to a page where the integration with the external service can be managed in the third-party's website.
listId:
type: string
description: The ID of list where new contacts from connection will be synced
required:
- service
- externalid
- name
- logoUrl
- linkUrl
type: object
examples:
JSON:
value:
connection:
service: fooCommerce
externalid: toystore123
name: Toystore, Inc.
logoUrl: http://example.com/i/foo.png
linkUrl: http://example.com/foo/
listId: '1'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"connection\": {\n \"isInternal\": 0,\n \"service\": \"fooCommerce\",\n \"externalid\": \"toystore123\",\n \"name\": \"Toystore, Inc.\",\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n\t\t\"listId\": \"1\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-02T14:56:05-06:00\",\n \"links\": {\n \"customers\": \"/connections/1/customers\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
connection:
type: object
properties:
isInternal:
type: integer
example: 0
default: 0
service:
type: string
example: fooCommerce
externalid:
type: string
example: toystore123
name:
type: string
example: Toystore, Inc.
logoUrl:
type: string
example: http://example.com/i/foo.png
linkUrl:
type: string
example: http://example.com/foo/
listId:
type: string
example: '1'
cdate:
type: string
example: '2017-02-02T14:56:05-06:00'
udate:
type: string
example: '2017-02-02T14:56:05-06:00'
links:
type: object
properties:
customers:
type: string
example: /connections/1/customers
id:
type: string
example: '1'
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign List All Connections
description: List all existing connection resources.
operationId: list-all-connections
parameters:
- name: filters[service]
in: query
description: Filter by the external service name.
schema:
type: string
- name: filters[externalid]
in: query
description: Filter by the external id associated with a connection.
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"connections\": [\n {\n \"service\": \"shopify\",\n \"externalid\": \"foo.myshopify.com\",\n \"name\": \"Foo, Inc.\",\n \"isInternal\": \"1\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"lastSync\": \"2017-02-02T13:09:07-06:00\",\n \"logoUrl\": \"\",\n \"linkUrl\": \"\",\n \"listId\": \"0\",\n \"cdate\": \"2017-02-02T13:09:07-06:00\",\n \"udate\": \"2017-02-02T13:09:12-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/1/customers\"\n },\n \"id\": \"1\"\n },\n {\n \"service\": \"fooCommerce\",\n \"externalid\": \"johndoe@example.com\",\n \"name\": \"Acme, Inc.\",\n \"isInternal\": \"0\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"lastSync\": null,\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n \"listId\": \"1\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-03T15:54:51-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/2/customers\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}"
schema:
type: object
properties:
connections:
type: array
items:
type: object
properties:
service:
type: string
example: shopify
externalid:
type: string
example: foo.myshopify.com
name:
type: string
example: Foo, Inc.
isInternal:
type: string
example: '1'
status:
type: string
example: '1'
syncStatus:
type: string
example: '0'
lastSync:
type: string
example: '2017-02-02T13:09:07-06:00'
logoUrl:
type: string
example: ''
linkUrl:
type: string
example: ''
listId:
type: string
example: '0'
cdate:
type: string
example: '2017-02-02T13:09:07-06:00'
udate:
type: string
example: '2017-02-02T13:09:12-06:00'
links:
type: object
properties:
customers:
type: string
example: /api/3/connections/1/customers
id:
type: string
example: '1'
meta:
type: object
properties:
total:
type: string
example: '2'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/connections/{id}:
get:
summary: ActiveCampaign Retrieve a Connection
description: Retrieve an existing connection resource.
operationId: get-connection
parameters:
- name: id
in: path
description: The id of the connection to retrieve
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"connection\": {\n \"isInternal\": 0,\n \"service\": \"fooCommerce\",\n \"externalid\": \"toystore123\",\n \"name\": \"Toystore, Inc.\",\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n \"listId\": \"1\", \n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-02T14:56:05-06:00\",\n \"links\": {\n \"customers\": \"/connections/1/customers\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
connection:
type: object
properties:
isInternal:
type: integer
example: 0
default: 0
service:
type: string
example: fooCommerce
externalid:
type: string
example: toystore123
name:
type: string
example: Toystore, Inc.
logoUrl:
type: string
example: http://example.com/i/foo.png
linkUrl:
type: string
example: http://example.com/foo/
listId:
type: string
example: '1'
cdate:
type: string
example: '2017-02-02T14:56:05-06:00'
udate:
type: string
example: '2017-02-02T14:56:05-06:00'
links:
type: object
properties:
customers:
type: string
example: /connections/1/customers
id:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: ActiveCampaign Update a Connection
description: Update an existing connection resource.
operationId: update-connection
parameters:
- name: id
in: path
description: The id of the connection to update
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
connection:
properties:
service:
type: string
description: The name of the service.
externalid:
type: string
description: The id of the account in the external service.
name:
type: string
description: The name associated with the account in the external service.
logoUrl:
type: string
description: The URL to a logo image for the third-party service.
linkUrl:
type: string
description: The link to the third-party integrator's site.
status:
type: integer
description: The status of the connection (0 = error; 1 = connected)
format: int32
syncStatus:
type: integer
description: The status of a sync triggered on the connection (0 = sync stopped; 1 = sync running).
format: int32
required: []
type: object
examples:
JSON:
value:
connection:
externalid: johndoe@example.com
name: Acme, Inc.
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"connection\": {\n \"service\": \"fooCommerce\",\n \"externalid\": \"johndoe@example.com\",\n \"name\": \"Acme, Inc.\",\n \"isInternal\": \"0\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"logoUrl\": \"http://foocorp.net/i/path3523.png\",\n \"linkUrl\": \"http://example.com/\",\n \"listId\": \"1\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-03T15:54:51-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/2/customers\"\n },\n \"id\": \"2\"\n }\n}"
schema:
type: object
properties:
connection:
type: object
properties:
service:
type: string
example: fooCommerce
externalid:
type: string
example: johndoe@example.com
name:
type: string
example: Acme, Inc.
isInternal:
type: string
example: '0'
status:
type: string
example: '1'
syncStatus:
type: string
example: '0'
logoUrl:
type: string
example: http://foocorp.net/i/path3523.png
linkUrl:
type: string
example: http://example.com/
listId:
type: string
example: '1'
cdate:
type: string
example: '2017-02-02T14:56:05-06:00'
udate:
type: string
example: '2017-02-03T15:54:51-06:00'
links:
type: object
properties:
customers:
type: string
example: /api/3/connections/2/customers
id:
type: string
example: '2'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: ActiveCampaign Delete a Connection
description: Delete an existing connection resource.
operationId: delete-connection
parameters:
- name: id
in: path
description: The id of the connection to delete.
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Other
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/configs/{id}:
put:
summary: ActiveCampaign Update Settings
description: ''
operationId: set-config
parameters:
- name: id
in: path
description: ID of the config to edit
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"config\": {\n \"keyname\": \"pagination.users_index\",\n \"section\": \"\",\n \"item\": \"\",\n \"userid\": \"1\",\n \"val\": \"20\",\n \"cdate\": \"2018-08-08T13:38:38-05:00\",\n \"udate\": \"2018-09-20T14:07:07-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/configs/6/owner\"\n },\n \"id\": \"6\",\n \"owner\": \"1\"\n }\n}"
schema:
type: object
properties:
config:
type: object
properties:
keyname:
type: string
example: pagination.users_index
section:
type: string
example: ''
item:
type: string
example: ''
userid:
type: string
example: '1'
val:
type: string
example: '20'
cdate:
type: string
example: '2018-08-08T13:38:38-05:00'
udate:
type: string
example: '2018-09-20T14:07:07-05:00'
links:
type: object
properties:
owner:
type: string
example: https://:account.api-us1.com/api/3/configs/6/owner
id:
type: string
example: '6'
owner:
type: string
example: '1'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for ConfigResult with id 100\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for ConfigResult with id 100
deprecated:
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-other-api-openapi.yml