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: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /trackingLogs/{eventId}/contact: get: summary: ActiveCampaign Get Contact by Event ID description: Get the contact that was involved in an event. operationId: get-contact-by-event-id parameters: - name: eventId in: path description: The Event's ID schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"contact\": {\n \"cdate\": \"2022-09-22T12:36:33-05:00\",\n \"email\": \"jd@example.com\",\n \"phone\": \"555-555-5555\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"0\",\n \"orgname\": \"\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"ef73fe360240b8bf171744f7f341524f\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"example.com\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2022-09-27T14:57:35-05:00\",\n \"udate\": \"2022-09-22T12:36:33-05:00\",\n \"edate\": \"2022-09-27T13:36:04-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"created_utc_timestamp\": \"2022-09-22 12:36:33\",\n \"updated_utc_timestamp\": \"2022-09-27 13:36:04\",\n \"created_timestamp\": \"2022-09-22 12:36:33\",\n \"updated_timestamp\": \"2022-09-27 13:36:04\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"email_empty\": false,\n \"mpp_tracking\": \"0\",\n \"links\": {\n \"bounceLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/bounceLogs\",\n \"contactAutomations\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactAutomations?limit=1000&orders%5Blastdate%5D=DESC\",\n \"contactData\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactData\",\n \"contactGoals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactGoals\",\n \"contactLists\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactLists\",\n \"contactLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactLogs\",\n \"contactTags\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactTags\",\n \"contactDeals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactDeals\",\n \"deals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/deals\",\n \"fieldValues\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/fieldValues\",\n \"geoIps\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/geoIps\",\n \"notes\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/notes\",\n \"organization\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/organization\",\n \"plusAppend\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/plusAppend\",\n \"trackingLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/trackingLogs\",\n \"scoreValues\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/scoreValues\",\n \"accountContacts\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/accountContacts\",\n \"automationEntryCounts\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/automationEntryCounts\"\n },\n \"id\": \"112\",\n \"organization\": null\n }\n}" schema: type: object properties: contact: type: object properties: cdate: type: string example: '2022-09-22T12:36:33-05:00' email: type: string example: jd@example.com phone: type: string example: 555-555-5555 firstName: type: string example: John lastName: type: string example: Doe orgid: type: string example: '0' orgname: type: string example: '' segmentio_id: type: string example: '' bounced_hard: type: string example: '0' bounced_soft: type: string example: '0' bounced_date: type: string example: '0000-00-00' ip: type: string example: '0' ua: type: string example: '' hash: type: string example: ef73fe360240b8bf171744f7f341524f socialdata_lastcheck: type: string example: '0000-00-00 00:00:00' email_local: type: string example: '' email_domain: type: string example: example.com sentcnt: type: string example: '0' rating_tstamp: type: string example: '0000-00-00' gravatar: type: string example: '0' deleted: type: string example: '0' anonymized: type: string example: '0' adate: type: string example: '2022-09-27T14:57:35-05:00' udate: type: string example: '2022-09-22T12:36:33-05:00' edate: type: string example: '2022-09-27T13:36:04-05:00' deleted_at: type: string example: '0000-00-00 00:00:00' created_utc_timestamp: type: string example: '2022-09-22 12:36:33' updated_utc_timestamp: type: string example: '2022-09-27 13:36:04' created_timestamp: type: string example: '2022-09-22 12:36:33' updated_timestamp: type: string example: '2022-09-27 13:36:04' created_by: type: string example: '0' updated_by: type: string example: '0' email_empty: type: boolean example: false default: true mpp_tracking: type: string example: '0' links: type: object properties: bounceLogs: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/bounceLogs contactAutomations: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactAutomations?limit=1000&orders%5Blastdate%5D=DESC contactData: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactData contactGoals: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactGoals contactLists: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactLists contactLogs: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactLogs contactTags: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactTags contactDeals: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/contactDeals deals: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/deals fieldValues: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/fieldValues geoIps: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/geoIps notes: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/notes organization: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/organization plusAppend: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/plusAppend trackingLogs: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/trackingLogs scoreValues: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/scoreValues accountContacts: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/accountContacts automationEntryCounts: type: string example: https://yourAccountName.api-us1.com/api/3/contacts/112/automationEntryCounts id: type: string example: '112' organization: {} deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /localevent: post: summary: ActiveCampaign Local Events description: Published by TrackCmp. Creates an em_local_event row in production database. operationId: local-events requestBody: content: application/json: schema: type: object properties: localEvent: type: object description: Data about local event sent by TrackCmp properties: email: type: string description: Email of the contact tstamp: type: string description: Time the event happened. format: date-time input: type: string description: 'Example: "{\"event\":\"__pagevisit\",\"url\":\"www.url.com\"}"' format: json responses: '201': description: '201' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '403': description: '403' content: application/json: examples: Result: value: '{"message": "Email message"}' schema: type: object properties: message: type: string example: Email message deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /stripo/personalizationTags: get: summary: ActiveCampaign Personalization Tags description: '' operationId: personalization-tags parameters: - name: scope in: query description: '(optional) Comma separated values: contacts,accounts,deals,customobjects,message,messageVariables,social,surveymonkey,dropbox,ecom' schema: type: string - name: campaignId in: query description: (optional) schema: type: integer format: int32 responses: '200': description: '200' content: application/json: examples: Result: value: "[\n {\n \"type\": \"standard\",\n \"id\": \"contacts\",\n \"category\": \"Contactpersonen\",\n \"entries\": [\n {\n \"value\": \"%EMAIL%\",\n \"label\": \"E-mailadres\"\n },\n {\n \"value\": \"%FULLNAME%\",\n \"label\": \"Volledige naam\"\n },\n {\n \"value\": \"%FIRSTNAME%\",\n \"label\": \"Voornaam\"\n },\n {\n \"value\": \"%LASTNAME%\",\n \"label\": \"Achternaam\"\n },\n {\n \"value\": \"%PHONE%\",\n \"label\": \"Telefoonnummer\"\n },\n {\n \"value\": \"%GEO-COUNTRY%\",\n \"label\": \"GEO - Country\"\n },\n {\n \"value\": \"%GEO-REGION%\",\n \"label\": \"GEO - Region\"\n },\n {\n \"value\": \"%GEO-CITY%\",\n \"label\": \"GEO - City\"\n },\n {\n \"value\": \"%GEO-POSTALCODE%\",\n \"label\": \"GEO - ZIP/Postal Code\"\n },\n {\n \"value\": \"%GEO-AREACODE%\",\n \"label\": \"GEO - Area Code\"\n },\n {\n \"value\": \"%SUBDATE%\",\n \"label\": \"Datum ingeschreven\"\n },\n {\n \"value\": \"%SUBTIME%\",\n \"label\": \"Tijd ingeschreven\"\n },\n {\n \"value\": \"%SUBSCRIBERIP%\",\n \"label\": \"Contact's IP Address\"\n },\n {\n \"value\": \"%LISTNAME%\",\n \"label\": \"Contact's List\"\n },\n {\n \"value\": \"%SUBSCRIBERID%\",\n \"label\": \"ID contactpersoon\"\n },\n {\n \"value\": \"%CONTACT_JOBTITLE%\",\n \"label\": \"Functie\"\n }\n ]\n },\n {\n \"type\": \"standard\",\n \"id\": \"message\",\n \"category\": \"Bericht\",\n \"entries\": [\n {\n \"value\": \"%UNSUBSCRIBELINK%\",\n \"label\": \"Uitschrijflink\"\n },\n {\n \"value\": \"%SENDER-INFO%\",\n \"label\": \"List Sender Info (multiple lines)\"\n },\n {\n \"value\": \"%SENDER-INFO-SINGLELINE%\",\n \"label\": \"List Sender Info (single line)\"\n },\n {\n \"value\": \"%SENDER-LIST-REMINDER%\",\n \"label\": \"Afzender info herinnering\"\n },\n {\n \"value\": \"%WEBCOPY%\",\n \"label\": \"Web Copy\"\n },\n {\n \"value\": \"%WEBCOPY-NOSOCIAL%\",\n \"label\": \"Web Copy (no social links)\"\n },\n {\n \"value\": \"%UPDATELINK%\",\n \"label\": \"Update Subscription Account Link\"\n },\n {\n \"value\": \"%FORWARD2FRIEND%\",\n \"label\": \"Send to Friend Link\"\n },\n {\n \"value\": \"%UNSUBSCRIBELINK%&ALL\",\n \"label\": \"Unsubscribe Link (All Lists)\"\n },\n {\n \"value\": \"%TODAY%\",\n \"label\": \"Today's Date\"\n },\n {\n \"value\": \"%TODAY*%\",\n \"label\": \"Today's Date +/- X day(s)\"\n }\n ]\n },\n {\n \"type\": \"standard\",\n \"id\": \"messageVariables\",\n \"category\": \"Statische berichtvariabelen\",\n \"entries\": []\n },\n {\n \"type\": \"standard\",\n \"id\": \"accounts\",\n \"category\": \"Accounts\",\n \"entries\": [\n {\n \"value\": \"%ACCT_NAME%\",\n \"label\": \"Account: Naam\"\n },\n {\n \"value\": \"%ACCT_OWNER_FIRST_NAME%\",\n \"label\": \"Voornaam accounteigenaar\"\n },\n {\n \"value\": \"%ACCT_OWNER_LAST_NAME%\",\n \"label\": \"Achternaam accounteigenaar\"\n },\n {\n \"value\": \"%ACCT_OWNER_FULL_NAME%\",\n \"label\": \"Naam accounteigenaar\"\n },\n {\n \"value\": \"%ACCT_OWNER_EMAIL%\",\n \"label\": \"E-mailadres accounteigenaar\"\n },\n {\n \"value\": \"%ACCT_URL%\",\n \"label\": \"Account: URL\"\n },\n {\n \"value\": \"%ACCT_CREATED_DATE%\",\n \"label\": \"Account: Gemaakt op\"\n },\n {\n \"value\": \"%ACCT_UPDATED_DATE%\",\n \"label\": \"Account: Laatst bijgewerkt op\"\n },\n {\n \"value\": \"%ACCT_ADDRESS_1%\",\n \"label\": \"Account: Address 1\"\n },\n {\n \"value\": \"%ACCT_ADDRESS_2%\",\n \"label\": \"Account: Address 2\"\n },\n {\n \"value\": \"%ACCT_CITY%\",\n \"label\": \"Account: City\"\n },\n {\n \"value\": \"%ACCT_STATE_PROVINCE%\",\n \"label\": \"Account: State/Province\"\n },\n {\n \"value\": \"%ACCT_POSTAL_CODE%\",\n \"label\": \"Account: Postal Code\"\n },\n {\n \"value\": \"%ACCT_COUNTRY%\",\n \"label\": \"Account: Country\"\n },\n {\n \"value\": \"%ACCT_PHONE_NUMBER%\",\n \"label\": \"Account: Phone Number\"\n },\n {\n \"value\": \"%ACCT_DESCRIPTION%\",\n \"label\": \"Account: Description\"\n },\n {\n \"value\": \"%ACCT_NUMBER_OF_EMPLOYEES%\",\n \"label\": \"Account: Number of Employees\"\n },\n {\n \"value\": \"%ACCT_ANNUAL_REVENUE%\",\n \"label\": \"Account: Annual Revenue\"\n },\n {\n \"value\": \"%ACCT_INDUSTRY_VERTICAL%\",\n \"label\": \"Account: Industry/Vertical\"\n }\n ]\n },\n {\n \"type\": \"standard\",\n \"id\": \"social\",\n \"category\": \"Sociaal\",\n \"entries\": [\n {\n \"value\": \"%SOCIALSHARE%\",\n \"label\": \"Social Submit Links\"\n },\n {\n \"value\": \"%SOCIAL-FACEBOOK-LIKE%\",\n \"label\": \"Facebook Like Button\"\n },\n {\n \"value\": \"%SOCIALSHARE-FACEBOOK%\",\n \"label\": \"Facebook Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-FACEBOOK-LINK%\",\n \"label\": \"Facebook Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-TWITTER%\",\n \"label\": \"Twitter Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-TWITTER-LINK%\",\n \"label\": \"Twitter Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-LINKEDIN%\",\n \"label\": \"LinkedIn Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-LINKEDIN-LINK%\",\n \"label\": \"LinkedIn Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-REDDIT%\",\n \"label\": \"Reddit Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-REDDIT-LINK%\",\n \"label\": \"Reddit Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-DIGG%\",\n \"label\": \"Digg Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-DIGG-LINK%\",\n \"label\": \"Digg Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-DELICIOUS%\",\n \"label\": \"del.icio.us Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-DELICIOUS-LINK%\",\n \"label\": \"del.icio.us Share Link\"\n },\n {\n \"value\": \"%SOCIALSHARE-STUMBLEUPON%\",\n \"label\": \"StumbleUpon Share Icon\"\n },\n {\n \"value\": \"%SOCIALSHARE-STUMBLEUPON-LINK%\",\n \"label\": \"StumbleUpon Share Link\"\n }\n ]\n },\n {\n \"type\": \"standard\",\n \"id\": \"deals\",\n \"category\": \"Deals\",\n \"entries\": [\n {\n \"value\": \"%DEAL_TITLE%\",\n \"label\": \"Deal: Titel\"\n },\n {\n \"value\": \"%DEAL_DESCRIPTION%\",\n \"label\": \"Deal: Omschrijving\"\n },\n {\n \"value\": \"%DEAL_OWNER_FIRST_NAME%\",\n \"label\": \"Dealeigenaar: Voornaam\"\n },\n {\n \"value\": \"%DEAL_OWNER_LAST_NAME%\",\n \"label\": \"Dealeigenaar: Achternaam\"\n },\n {\n \"value\": \"%DEAL_OWNER_FULL_NAME%\",\n \"label\": \"Dealeigenaar: volledige naam\"\n },\n {\n \"value\": \"%DEAL_OWNER_EMAIL%\",\n \"label\": \"Dealeigenaar: E-mailadres\"\n },\n {\n \"value\": \"%DEAL_OWNER_SIGNATURE%\",\n \"label\": \"Dealeigenaar: handtekening\"\n },\n {\n \"value\": \"%DEAL_VALUE%\",\n \"label\": \"Deal: Waarde\"\n },\n {\n \"value\": \"%DEAL_STATUS%\",\n \"label\": \"Deal: Status\"\n },\n {\n \"value\": \"%DEAL_PIPELINE%\",\n \"label\": \"Deal: Pijplijn\"\n },\n {\n \"value\": \"%DEAL_STAGE%\",\n \"label\": \"Deal: Fase\"\n },\n {\n \"value\": \"%DEAL_CREATED_DATE%\",\n \"label\": \"Deal: Gemaakt op\"\n },\n {\n \"value\": \"%DEAL_UPDATED_DATE%\",\n \"label\": \"Deal: Laatst bijgewerkt op\"\n },\n {\n \"value\": \"%DEAL_FORECASTED_CLOSE_DATE%\",\n \"label\": \"Deal: Forecasted Close Date\"\n }\n ]\n },\n {\n \"type\": \"app\",\n \"id\": \"ecom\",\n \"category\": \"E-commerce\",\n \"entries\": [\n {\n \"value\": \"%ECOMMERCE_TOTAL_REVENUE%\",\n \"label\": \"eCommerce - Totale inkomsten van contact\"\n },\n {\n \"value\": \"%ECOMMERCE_TOTAL_ORDERS%\",\n \"label\": \"eCommerce - Totaal aantal orders van het contact\"\n },\n {\n \"value\": \"%ECOMMERCE_TOTAL_PRODUCTS%\",\n \"label\": \"eCommerce - Totaal aantal producten besteld\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_ORDER_PRICE%\",\n \"label\": \"eCommerce - Prijs van laatste bestelling\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_ORDER_CURRENCY%\",\n \"label\": \"eCommerce - Valuta van de laatste bestelling\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_ORDER_SHIPPING_METHOD%\",\n \"label\": \"eCommerce - Verzendmethode van de laatste bestelling\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_ORDER_PRODUCT_COUNT%\",\n \"label\": \"eCommerce - Producttelling van laatste bestelling\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_PRODUCT_ID%\",\n \"label\": \"eCommerce - ID van laatste product gekocht\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_PRODUCT_NAME%\",\n \"label\": \"eCommerce - Naam van laatste product gekocht\"\n },\n {\n \"value\": \"%ECOMMERCE_LAST_PRODUCT_CATEGORY%\",\n \"label\": \"eCommerce - Categorie van laatste product is gekocht\"\n }\n ]\n },\n {\n \"type\": \"app\",\n \"id\": \"surveymonkey\",\n \"category\": \"SurveyMonkey\",\n \"entries\": [\n {\n \"value\": \"\",\n \"label\": \"\"\n }\n ]\n },\n {\n \"type\": \"app\",\n \"id\": \"dropbox\",\n \"category\": \"Dropbox\",\n \"entries\": [\n {\n \"value\": \"\",\n \"label\": \"\"\n }\n ]\n },\n {\n \"type\": \"customobjects\",\n \"id\": \"customobjects\",\n \"category\": \"\",\n \"entries\": []\n }\n]" schema: type: array items: type: object properties: type: type: string example: standard id: type: string example: contacts category: type: string example: Contactpersonen entries: type: array items: type: object properties: value: type: string example: '%EMAIL%' label: type: string example: E-mailadres '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /stripo/config: get: summary: ActiveCampaign Stripo Config description: '' operationId: stripo-config parameters: - name: campaignId in: query schema: type: integer format: int32 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"stripoScriptSrc\": \"https://plugins.stripo.email/static/stripo.js\",\n \"stripoApiBaseUrl\": \"https://plugins.stripo.email/stripo-plugin-api-gateway/api/v1\",\n \"localeCode\": \"en\",\n \"allowedScriptSourceDomains\": [\n \"https://plugins.stripo.email\",\n \"http://localhost:5000/dist/hosted-mounter.js\"\n ],\n \"contentApiUrl\": \"http://localhost:7003\",\n \"hostedMounterJsUrl\": \"http://localhost:5000/dist/hosted-mounter.js\",\n \"colorPickerBrandKits\": [\n {\n \"domain\": \"\",\n \"brandkitName\": \"\",\n \"name\": \"\",\n \"shortDescription\": \"\",\n \"longDescription\": \"\",\n \"employeeCountRange\": \"\",\n \"foundedYear\": 0,\n \"companyStructure\": \"\",\n \"companyLocation\": {\n \"city\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"region\": \"\",\n \"state\": \"\",\n \"subregion\": \"\"\n },\n \"industries\": [],\n \"links\": [],\n \"logos\": [],\n \"symbols\": [],\n \"icons\": [],\n \"colors\": {\n \"primary\": \"\",\n \"lightBackground\": \"\",\n \"darkBackground\": \"\",\n \"accents\": []\n },\n \"fonts\": {\n \"titleFont\": \"\",\n \"titleWeight\": \"\",\n \"bodyFont\": \"\",\n \"bodyWeight\": \"\"\n },\n \"templateIds\": [],\n \"isPrimary\": false,\n \"language\": \"english\"\n }\n ],\n \"brandingFooterHtmlContent\": \"\",\n \"allMessagesArr\": [\n {\n \"percentage\": \"100\",\n \"percentage300\": \"300\",\n \"ed_version\": \"3\",\n \"subject\": \"Test for counter\",\n \"fromname\": \"Local Dev\",\n \"fromemail\": \"localdev@email.localdev\",\n \"reply2\": \"localdev@email.localdev\",\n \"preheader_text\": \"\",\n \"id\": \"5\"\n }\n ]\n}" schema: type: object properties: stripoScriptSrc: type: string example: https://plugins.stripo.email/static/stripo.js stripoApiBaseUrl: type: string example: https://plugins.stripo.email/stripo-plugin-api-gateway/api/v1 localeCode: type: string example: en allowedScriptSourceDomains: type: array items: type: string example: https://plugins.stripo.email contentApiUrl: type: string example: http://localhost:7003 hostedMounterJsUrl: type: string example: http://localhost:5000/dist/hosted-mounter.js colorPickerBrandKits: type: array items: type: object properties: domain: type: string example: '' brandkitName: type: string example: '' name: type: string example: '' shortDescription: type: string example: '' longDescription: type: string example: '' employeeCountRange: type: string example: '' foundedYear: type: integer example: 0 default: 0 companyStructure: type: string example: '' companyLocation: type: object properties: city: type: string example: '' country: type: string example: '' countryCode: type: string example: '' region: type: string example: '' state: type: string example: '' subregion: type: string example: '' industries: type: array links: type: array logos: type: array symbols: type: array icons: type: array colors: type: object properties: primary: type: string example: '' lightBackground: type: string example: '' darkBackground: type: string example: '' accents: type: array fonts: type: object properties: titleFont: type: string example: '' titleWeight: type: string example: '' bodyFont: type: string example: '' bodyWeight: type: string example: '' templateIds: type: array isPrimary: type: boolean example: false default: true language: type: string example: english brandingFooterHtmlContent: type: string example: '' allMessagesArr: type: array items: type: object properties: percentage: type: string example: '100' percentage300: type: string example: '300' ed_version: type: string example: '3' subject: type: string example: Test for counter fromname: type: string example: Local Dev fromemail: type: string example: localdev@email.localdev reply2: type: string example: localdev@email.localdev preheader_text: type: string example: '' id: type: string example: '5' '422': description: '422' content: application/json: examples: Result: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Invalid attribute\",\n \"detail\": \"Provided campaign ID \\\"177\\\" does not exist\",\n \"source\": {\n \"pointer\": \"/data/attributes/campaignId\"\n }\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: Invalid attribute detail: type: string example: Provided campaign ID "177" does not exist source: type: object properties: pointer: type: string example: /data/attributes/campaignId deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /content/editorMarkup/{messageId}: get: summary: ActiveCampaign Get Editor Markup description: Get Editor Markup operationId: get-editor-markup parameters: - name: messageId in: path description: required schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"html\": \"

Test html

\",\n \"css\": \"p { color: red; }\"\n}" schema: type: object properties: html: type: string example:

Test html

css: type: string example: 'p { color: red; }' '404': description: '404' content: application/json: examples: Result: value: "{\n \"message\": \"No markup for message\"\n}" schema: type: object properties: message: type: string example: No markup for message deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /prism/urlWhitelistings: post: summary: ActiveCampaign Add Domain to Whitelist description: Add a domain to the site tracking whitelist operationId: add-domain-to-whitelist requestBody: content: application/json: schema: type: object properties: data: properties: attributes: type: object description: '' properties: whitelisted_domain: type: string default: example.com description: The domain name to add to the whitelist whitelisted_page: type: string default: '*' description: The page to while list under the domain. `*` means all pages should be whitelisted. If only example.com/website needs to whitelisted, then the value should be `website`. conversations_enabled: type: boolean default: 'false' description: Whether to enable conversations wp_enabled: type: boolean default: 'false' description: Whether to enable web personalization tracking_enabled: type: boolean description: Whether to enable site tracking default: 'true' required: - whitelisted_domain - whitelisted_page - conversations_enabled - wp_enabled - tracking_enabled type: type: string default: urlWhitelistings required: - attributes - type type: object required: - data examples: Request Example: value: siteTrackingDomain: name: example.com responses: '201': description: Created content: application/json: examples: Result: value: data: type: urlWhitelistings id: '534756' attributes: whitelisted_domain: example.com whitelisted_page: '*' tracking_enabled: true conversations_enabled: false wp_enabled: false url_regex: '#^example\.com(\/.*)?$#' updated_at: '2025-07-29T05:40:11Z' created_at: '2025-07-29T05:40:11Z' '400': description: '400' content: application/json: examples: Bad Request: value: '{}' summary: Bad Request schema: type: object properties: {} '409': description: Conflict content: application/json: examples: Conflict: value: '{}' summary: Conflict deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Whitelisted Domains description: List of all whitelisted site tracking domains operationId: list-all-whitelisted-domains responses: '200': description: '200' content: application/json: examples: OK: value: data: - type: urlWhitelistings id: '490469' attributes: whitelisted_domain: example.com whitelisted_page: '*' url_regex: '#^example\.com(\/.*)?$#' conversations_enabled: 0 tracking_enabled: 1 created_at: '2024-01-03T17:19:36Z' updated_at: '2025-04-24T19:11:32Z' wp_enabled: 0 summary: OK schema: type: object properties: siteTrackingDomains: type: array items: type: object properties: name: type: string example: example.com meta: type: object properties: total: type: integer example: 1 default: 0 deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK /prism/urlWhitelistings/{domain_id}: delete: summary: ActiveCampaign Remove Domain from Whitelist description: Remove a domain from the site tracking whitelist operationId: remove-domain-from-whitelist parameters: - name: domain_id in: path required: true description: The id of the whitelisted domain. Can be retrieved using the GET /prism/urlWhitelistings endpoint schema: type: string default: '' responses: '204': description: '204' content: application/json: examples: Result: value: '' No Content: value: '{}' summary: No Content deprecated: false tags: - Other x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ApiToken: type: apiKey name: Api-Token in: header description: Your ActiveCampaign API token