Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.

Path Parameters

audienceId
string<uuid>
required

The ID of the static audience to add the contact to.

Body

application/json
email
string<email>

The contact's email address. At least one of cnvContactId, userId, or email is required.

Example:

"jane@example.com"

cnvContactId
string<uuid>

The Conversion contact ID. At least one of cnvContactId, userId, or email is required.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

userId
string

An external user identifier for the contact. At least one of cnvContactId, userId, or email is required.

Example:

"user_12345"

Response

Contact added to the audience successfully.

data
object