Skip to main content
PATCH
Update a client

Authorizations

Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

client_id
string
required

Body

application/json

All fields optional; only fields present are updated.

external_id
string | null
email
string<email> | null
name
string | null
phone
string | null

Contact phone number for the client.

metadata
object

Response

OK

id
string
required
Example:

"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

created_at
string<date-time>
required
external_id
string | null

Integrator-supplied identifier; useful for joining to your own systems.

email
string<email> | null
name
string | null
phone
string | null

Contact phone number for the client.

metadata
object

Free-form key-value pairs for integrator use. Max 20 keys.

updated_at
string<date-time>