Update a legacy contact

Deprecated — sunset 2027-03-31. Use /customers and /vendors.

A contact is the LEGACY unified party record (a person or an organisation) from before customers and vendors became separate resources; a 2024 migration moved the contacts that existed then into customers and vendors, recorded as migrated_customer_id / migrated_vendor_id and exposed as successor. New integrations should use /customers and /vendors instead. Updates a contact that has not been migrated; a migrated contact is immutable and answers 422, so update its successor instead. Send an optional Idempotency-Key to store the terminal response for safe retries for 24 hours. If-Match is required with the latest ETag; stale versions return 412. Requires the contacts:write OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to update a legacy contact. The schema identifies required and optional values.

string
enum
Allowed:
string
length ≤ 255
string | null
string | null
uuid | null
custom_fields
object
person
object
organisation
object
tag_ids
array of uuids
tag_ids
phone
array of objects | null
phone
email
array of objects | null
email
web
array of objects | null
web
addresses
array of objects
length ≤ 20
addresses
Headers
string
length ≤ 191

Optional unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*