Troubleshoot and FAQs

Learn about the V5 Contact API

Q. What happens if the contact already exists?

A. Current behavior: The API returns a 400 error with the message Contact already exists.

Planned behavior: As part of upgrade, the API will return 200 for all cases, including contacts that already exist. The request will be handled internally.

Q. What is the maximum number of contacts allowed in one request?

A. You can create up to 1,000 contacts per request.

Q. What happens if some contacts succeed and others fail?

A. Current behavior: There is currently no rollback mechanism. This means contacts that are successfully processed are not rolled back if other contacts in the same request fail.

Q. How does the customer check the final result of an async request?

Currently, there is no mechanism for customers to check the final processing result of an asynchronous request.

Q. Is notify_callback officially supported by V5 Create Contact?

No. notify_callback is not officially supported by the V5 Create Contact API. Do not include notify_callback in requests sent to the V5 Create Contact API.

Q. If EMAIL and MOBILE are already provided as top-level contact fields, should they also be included inside attributes?

A. No. There is no need to include EMAIL or MOBILE inside the attributes object if they are already provided as top-level contact fields.

Q. What is the difference between contact-level and request-level audience_details?

A. Contact-level audience_details adds that specific contact to the specified audience.

Request-level audience_details adds all contacts in the request to the specified audience.

Example:

  • Contact-level: John is added to Audience A, while Mary is not.
  • Request-level: Both John and Mary are added to Audience A.

Q. When should I use audience_id vs. audience_name?

A. You can use either audience_id or audience_name to specify an audience.

  • Use audience_id if you know the audience ID.
  • Use audience_name if you know the audience name.

Choose whichever is available to you.

Q. What do list and ccg mean, and when should each be used?

A. list and ccg are two types of audiences with different purposes.

  • list (List): A subset of the Contact Master that can be used for different engagement activities. For example, you can create lists for newsletter subscribers, new users, or paid users and use them for campaigns, journeys, or suppression.
  • ccg (Control Group List): A Control Group List used for the control group feature within a journey. Its scope is currently limited to journeys.
Audience typeWhat it isWhere it can be used
listA subset of the Contact MasterCampaigns, journeys, suppression, and other supported activities
ccgA Control Group ListJourneys only