Skip to main content
POST
Create a contact

Authorizations

Authorization
string
header
required

Pass your team's API key as a Bearer token: Authorization: Bearer YOUR_API_KEY. Find your API key in the dashboard under Settings. The key must belong to the same team as the teamId in the request body.

Body

application/json
phoneNumber
string
required

The contact's phone number. Required.

Example:

"+84775352590"

teamId
string<uuid>
required

Your team ID. Must match the team the API key belongs to.

name
string

Full name.

Example:

"Jane Doe"

email
string<email>
companyName
string
campaignId
string<uuid>

Optional. Enrolls the created contact into this active campaign (best-effort — a failed enrollment does not fail the request).

{key}
any

Any additional keys are stored as custom contact properties.

Response

Contact created.

message
string
Example:

"Contact 123e4567-e89b-12d3-a456-426614174000 created successfully"

contactId
string<uuid>