Update a compliance client

Vorschau

patchhttps://api.expiryedge.com/v2/compliance-clients/{id}

editor or admin60/min

Anfrage

curl -X PATCH 'https://api.expiryedge.com/v2/compliance-clients/cli_123' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "industry": "Dental",
  "is_archived": true
}'

Antwort

{
  "name": "Example name",
  "primary_contact_name": "Example name",
  "email": "name@example.com",
  "phone": "+15555550123",
  "website": "string",
  "address": "string",
  "industry": "string",
  "status": "Active",
  "notes": "string",
  "custom_fields": {},
  "id": "cli_123",
  "organization_id": "org_123",
  "user_id": "use_123",
  "is_archived": true,
  "archived_at": "2026-10-15T09:00:00Z",
  "created_at": "2026-09-27T14:05:00.000Z"
}

Only fields present change; is_archived archives or restores the client.

Pfadparameter

idstringerforderlich

Body-Parameter

application/json

namestring
max length: 200
primary_contact_namestring
emailstring
phonestring
websitestring
addressstring
industrystring
statusstring
ErlaubtActiveInactive
notesstring
custom_fieldsmap of string
is_archivedboolean

Rückgabe

200

The client after the change.

namestring
max length: 200
primary_contact_namestring
emailstring
phonestring
websitestring
addressstring
industrystring
statusstring
ErlaubtActiveInactive
notesstring
custom_fieldsmap of string
idstring
organization_idstring
user_idstring
is_archivedboolean
archived_atstring | null
created_atstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time
updated_atstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time

Fehler

`400`	Invalid parameters or body (`VALIDATION_FAILED`; `details` names the fields).
`401`	Missing, invalid or expired token (`UNAUTHORIZED`).
`403`	Your role can't do this, or your account has no organization (`FORBIDDEN`).
`404`	No such record in your organization (records in other organizations are also 404).
`405`	Wrong HTTP method for this path; the `Allow` header lists the valid ones.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.