curl --request POST \
--url https://pub-api.conversion.ai/api/v2/audiences/{audienceId}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jane@example.com"
}
'
{
"data": {
"added": true,
"cnvContactId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
Audiences
Add Contact to Audience
Add a contact to a static audience. The contact is identified by cnvContactId, userId, or email.
POST
/
v2
/
audiences
/
{audienceId}
/
contacts
curl --request POST \
--url https://pub-api.conversion.ai/api/v2/audiences/{audienceId}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jane@example.com"
}
'
{
"data": {
"added": true,
"cnvContactId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
Authorizations
Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.
Path Parameters
The ID of the static audience to add the contact to.
Body
application/json
The contact's email address. At least one of cnvContactId, userId, or email is required.
Example:
"jane@example.com"
The Conversion contact ID. At least one of cnvContactId, userId, or email is required.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
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.
Show child attributes
Show child attributes
Was this page helpful?