Skip to main content
POST
Upsert Clients

Permissions

Requires Client matters admin (write:client_matters).

Matching and results

A live or soft-deleted client with the same trimmed client_id is updated or restored. Matched clients appear in updated, even when their fields do not change. New clients appear in created. HTTP 200 can include row failures in errors; valid rows still succeed. A repeated identifier in the batch produces duplicate_client_id for the later row. See the Client Matters guide for examples and migration steps.

Authorizations

Authorization
string
header
required

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

Body

application/json
clients
object[]
required
Required array length: 1 - 10000 elements

Response

Per-row results for the submitted clients.

created
object[]
required
updated
object[]
required

Includes restored clients and matched clients whose fields did not change.

errors
object[]
required