Update customer

Update customer in the credential-bound company. Send an optional Idempotency-Key to store the terminal response for safe retries for 24 hours. When supplied, If-Match must contain the latest ETag; stale versions return 412. Requires the customers: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 customer. The schema identifies required and optional values.

string
length ≤ 255
string | null
string | null
string | null
string | null
string | null
enum
Allowed:
string | null
string | null
string | null
string | null
uri | null
string | null
uuid | null
custom_fields
array of strings
custom_fields
cc_emails
array of strings | null

The customer's saved copy list, up to 5 addresses. Omit to leave it as it is; send [] or null to clear it.

cc_emails
billing_address
object | null
shipping_address
object | null
tag_ids
array of uuids
tag_ids
contact_people
array of objects
length ≤ 50
contact_people
Headers
string
length ≤ 191

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

string

Optional. 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
*/*