Skip to main content
POST
/
v2
/
campaigns
/
{campaignId}
/
contacts
curl --request POST \
  --url https://pub-api.conversion.ai/api/v2/campaigns/{campaignId}/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

​
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

​
campaignId
string<uuid>
required

The ID of the campaign 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 campaign successfully.

​
data
object