Skip to navigation
API Referenceaudiences

Add Contact

Create a new omni-channel contact for an audience.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

audience_idstringRequired
The unique ID for the audience.

Query parameters

merge_field_validation_modeenumOptional

Defines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default.

Allowed values:
data_modeenumOptional

Indicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them.

Allowed values:

Request

An instance of a contact.
email_channelobjectOptional
languagestringOptional
The contact's detected language.
merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

sms_channelobjectOptional
tagslist of strings or objectsOptional

An array of tags to add to the contact. Accepts tag name strings or objects with name and status. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.

update_existingbooleanOptional

If a contact already exists, update them instead of returning a conflict error. When true and a matching contact is found (by email or phone), the existing contact is updated with the provided channel data. Defaults to false.

Response

This endpoint returns an object.
audience_idstringOptionalRead-only
The unique ID for the audience.
created_atdatetimeOptionalRead-only
The date that the contact was created.
email_channelobjectOptional
idstringOptionalRead-only
The unique ID for the contact.
languageenumOptional
The contact's detected language. Empty string when no language has been detected or set.
last_updated_atdatetimeOptionalRead-only
The date that the contact was last updated.
merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

sms_channelobjectOptional
sourceobjectOptional
The source from which the parent's entity was created.
statusenumOptionalRead-only
The status of a contact.
Allowed values:
tagslist of stringsOptional
The tags assigned to this contact.