Skip to main content
PATCH
Update a client

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

clientId
string
required

Client (plaintiff) id

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
firstName
string
Required string length: 1 - 200
lastName
string
Required string length: 1 - 200
email
string<email>
Maximum string length: 320
phone
string
Required string length: 1 - 50
zipCode
string
Required string length: 1 - 20
dateOfBirth
string
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

{ success: true, client }

success
boolean
required
{key}
any