Skip to main content
POST
Create a contact

Authorizations

Authorization
string
header
required

Your API key, e.g. flv_9f2a8c1e…

Body

application/json
name
string
required
Required string length: 1 - 255
avatar
string | null
required
phone
string
required
Required string length: 6 - 20
email
string<email>
assigneeId
string<uuid> | null
stageId
string<uuid> | null
tagIds
string<uuid>[]

Response

id
string<uuid>
required
name
string
required
phone
string | null
required

Digits only, no + prefix

email
string | null
required
avatar
string | null
required
notes
string | null
required
status
enum<string>
required
Available options:
active,
archived
isBlocked
boolean
required

Blocked contacts cannot send or receive messages

sourceMethod
string | null
required

How the contact entered the system, e.g. MANUAL, IMPORT

assigneeId
string<uuid> | null
required

Must be set before a message can be sent to this contact

stageId
string<uuid> | null
required
tags
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
lastInteractionAt
string<date-time> | null
required