Skip to main content
POST
Create a contact

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
email
string<email>
required
first_name
string | null
Example:

"John"

last_name
string | null
Example:

"Doe"

subscribed
boolean
default:true
Example:

true

metadata
object

Custom properties for the contact. Supports string, number, boolean, and date (as ISO string) values.

Example:
tags
string[]

Tags for categorization. Lowercase, max 50 chars each, max 20 tags.

Example:

Response

Contact created

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
email
string<email>
required
first_name
string | null
required
last_name
string | null
required
metadata
object | null
required

Custom properties for the contact. Supports string, number, boolean, and date (as ISO string) values.

subscribed
boolean
required
unsubscribed_at
string<date-time> | null
required
tags
string[]
required

Tags for categorization.

Example:
created_at
string<date-time>
required
updated_at
string<date-time>
required