Skip to main content
PUT
Update contact

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

Body

application/json

Update an existing contact in the current workspace. Every field is optional — only the keys present in the request body are changed. Scramble reads these rules to document the request body.

name
string | null

Contact's full display name.

Maximum string length: 191
first_name
string | null

Optional name parts.

Maximum string length: 191
middle_name
string | null
Maximum string length: 191
last_name
string | null
Maximum string length: 191
title
string | null

Optional salutation/title (e.g. Mr, Dr).

Maximum string length: 50
phone
string | null

Phone number in international format (digits, E.164).

Maximum string length: 32
country_code
string | null

Country dial code (e.g. +91). Prefixed onto the phone if missing.

Maximum string length: 10
email
string<email> | null

Email address.

Maximum string length: 191
language
string | null

Preferred language / locale.

Maximum string length: 80
address
string | null

Postal address.

Maximum string length: 1000
note
string | null

Free-text note attached to the contact.

Maximum string length: 2000
attributes
string[] | null

Free-form key/value attributes stored against the contact.

is_unsubscribed
boolean | null

Whether the contact has opted out of messages.

group_ids
integer[] | null

Group ids the contact belongs to (replaces the existing set).

Scope the existence check to the caller's workspace so a foreign group id is rejected (was a global exists → cross-tenant ref).

Response

Successful response.

data
any[]
required
meta
string
required