Skip to main content
PATCH
PATCH /api/contacts/{contactId}

Authorizations

Authorization
string
header
required

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

Path Parameters

contactId
string
required

Body

application/json
displayName
string
Required string length: 1 - 200
phoneE164
string | null
whatsappJid
string | null
Maximum string length: 128
Pattern: ^[0-9A-Za-z._:-]{1,100}@(s\.whatsapp\.net|g\.us|lid)$
email
string<email> | null
Maximum string length: 320
birthday
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
relationship
string | null
Required string length: 1 - 100
title
string | null
Required string length: 1 - 100
addresses
object[]
Maximum array length: 10

Response

Success

id
string<uuid>
required
userId
string<uuid>
required
displayName
string
required
Required string length: 1 - 200
phoneE164
string | null
required
Pattern: ^\+[1-9][0-9]{6,14}$
whatsappJid
string | null
required
Maximum string length: 128
Pattern: ^[0-9A-Za-z._:-]{1,100}@(s\.whatsapp\.net|g\.us|lid)$
email
string<email> | null
required
Maximum string length: 320
birthday
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
relationship
string | null
required
Required string length: 1 - 100
title
string | null
required
Required string length: 1 - 100
addresses
object[]
required
Maximum array length: 10
source
enum<string>
required
Available options:
manual,
phone_import,
mcp_import
createdAt
string<date-time>
required
updatedAt
string<date-time>
required