Skip to main content
POST
Upsert contact

Authorizations

Authorization
string
header
required

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

Path Parameters

identifier
string
required

Contact identifier: the numeric contact id, an email address, or a phone number.

Minimum string length: 1

Body

application/json
firstName
string

Contact's first name.

Maximum string length: 100
lastName
string

Contact's last name.

Maximum string length: 100
email

Contact's email address, or an empty string to clear it.

phoneNumber
string

Contact's phone number in E.164-like digits (10-20 digits, optional leading +).

Required string length: 10 - 20
Pattern: \+?\d{10,20}
avatar
string

URL of the contact's avatar image.

gender
enum<string>

Contact's gender.

Available options:
male,
female,
unknown

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