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

Get the Connect API schema

Download the Connect API schema to load into tools like Postman for building and validating your GraphQL requests.

This file reflects the schema as of August 12, 2026. Because the API evolves, check back periodically for the latest version. If the schema doesn't match what you see at your endpoint, contact support.

How to use it

Click the button above to download connect-external.graphql.
In Postman, create or open a GraphQL request pointed at your Connect API endpoint.
In the request's Schema tab, select Upload schema file and choose the downloaded .graphql file.
Postman will use the schema to enable autocomplete and validate your queries and mutations as you build them.

Authentication

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

Rate limits

The number of requests from a single IP address cannot exceed 15000 per 300 seconds.
By default, the number of requests associated with a Connect subscription is limited to 25 per second.

If you need to increase the limit, contact your account manager.

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 keys (unique IDs) 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.
To add new contacts to your audience, use the createContacts mutation.
To import contacts from a file, use the createImportJob 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).

The Get consent statuses for contacts page shows how to check contacts' consent statuses per channel or per consent group (depending on how your organization handles consent).
If you want to specify consent statuses when adding contacts to the audience, see Create contacts with consent statuses.
As you interact with contacts, their consent statuses may change. To learn more about your options, see Update consent statuses for contacts.

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:

Product catalog API

Manage products and categories:

Query the product catalog
Query products / Query a product by ID
Add a custom attribute
Add a product / Import products from a file
Update a product
Delete products
Query/add/update/delete product categories

Introduction to the Connect API