Skip to main content
POST
Create contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
required

Contact's email address. Required when channel is smtp.

gender
enum<string>
required

Contact's gender.

Available options:
male,
female,
unknown
channel
enum<string>
required

Channel this contact is reachable on; determines which of phoneNumber/email/contactId is required.

Available options:
omnichannel,
webchat,
messenger,
whatsapp,
zalo,
smtp,
telegram,
instagram,
threads,
tiktok,
api
inboxId
string
required

Inbox id (numeric string) to create the contact in. Get it from inboxes.list.

Pattern: ^\d+$
phoneNumber

Contact's phone number. Required when channel is whatsapp.

contactId
string

Channel-specific user id (e.g. Messenger PSID). Required for channels other than webchat/omnichannel.

Maximum string length: 255
firstName
string

Contact's first name.

Maximum string length: 100
lastName
string

Contact's last name.

Maximum string length: 100

Response

OK

id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
avatar
string | null
required
phoneNumber
string | null
required
email
string | null
required
emailVerified
boolean
required
emailOptIn
boolean
required
firstName
string | null
required
lastName
string | null
required
fullName
string | null
required
gender
enum<string> | null
required
Available options:
male,
female,
unknown
lastReadAt
string<date-time> | null
required
ref
string | null
required
country
string | null
required
state
string | null
required
city
string | null
required
location
required
locale
string | null
required
timezone
string | null
required
subscribedAt
string<date-time> | null
required
broadcastSubscribedAt
string<date-time> | null
required
blockedAt
string<date-time> | null
required
workspaceId
string
required
contactCustomFields
object[]
tags
object[]
contactNotes
object[]
contactInboxes
object[]
conversation
object | null