Skip to main content
POST
Create a Contact

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Body

Schema for creating a contact

channel
object
required

Schema for creating a contact channel option

segment_ids
string[]

The ID of the segment to add the contact to

Maximum array length: 10

Response

200 - application/json

Schema for the contact

id
string
required
name
string | null
required
blocked
boolean
required
unsubscribed
boolean
required
ai_replies
boolean
required
is_admin
boolean
required
channels
object[]
required
segments
object[]
required
properties
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
blocked_at
string<date-time>
unsubscribed_at
string<date-time>
unsubscribe_reason
string
unsubscribe_feedback
string
ai_replies_at
string<date-time>