API reference
Help centerCommunityDevelopersAcademyStatus

Introduction

The Connect API lets you seamlessly integrate with other services and set up data exchange in real time.

Authentication

To start using the Connect API, you must generate an API key in Connect and start authorizing your requests with it. See Authentication for instructions.

Audience API

The audience dataset is at the core of each Connect subscription. Audience structure is defined by fields (contact attributes). The maximum number of contact attributes you can add to the audience is 2000 (two thousand). Records in the audience are contacts (the people to target with marketing content). The number of contacts is unlimited.

The dataSets query lets you get information about your audience:

  • Its name and ID. The ID is required for mutations.
  • The names and IDs of consent groups in the audience. The IDs are necessary for updating contacts' consent statuses.
  • The contact attributes available in your audience. You may need them for adding and updating contacts.
  • The reference sets directly connected to your audience.

Each company defines their own contact attributes. The following options are available via the API:

Contacts API (without consent)

The Connect API gives you full control over the contacts in your audience. You can identify them using their IDs (recommended) or addressable attributes (emails or phone numbers).

  • The contacts query lets you get the full list of contacts in your audience and to find contacts based on your search criteria. The contact query is convenient for getting the attributes of a particular contact in your audience, but you can get the same result with contacts alone.
  • To add new contacts to your audience, use the createContacts mutation.
  • To update existing contacts, use the updateContacts mutation.
  • To delete contacts from the audience, use the deleteContacts mutation. Keep in mind that the action is irreversible. If in doubt, consider opting out inactive contacts from all communications instead of deleting them.

Contacts API (with consent)

You can modify the contact-related requests to support people's consent statuses (whether they agree to be contacted or not).

Reference set API

You can import additional datasets to Connect and map them to your audience. The system converts them to reference sets. The following options are available: