Sign in

v1

latestOpenAPI 3.0.02026-08-04361225.7 KB
Clients

Update client

Updates an existing client account (partial update)

patch/api/clients/{id}

Path parameters

idstring uuid required

Client UUID

Request body

namestring

Client/company name

emailstring

Contact email address

lookupKeystring

Lookup key for client identification

Example request

{
  "name": "Acme Corporation",
  "email": "contact@acme.com",
  "lookupKey": "acme-corp"
}

Response

Client updated successfully

idstring required

Client unique identifier

namestring required

Client/company name

emailobject nullable required

Contact email address

lookupKeyobject nullable required

Lookup key for external integrations

createdAtstring date-time required

Creation timestamp

updatedAtobject nullable required

Last update timestamp

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "createdAt": "2025-01-01T00:00:00.000Z"
}