client-reports

PATCH `/v1/client-reports/clients/{client_id}`

Change a client or its schedule.

Authentication

Send an API key as a bearer token. The key must carry the sites.create permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/client-reports/clients/{client_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Requires sites.create.

Parameters

Name	Type	Required	What it is
`client_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`name`	`string`	No	—
`brand_id`	`object`	No	—
`domains`	`string[]`	No	—
`recipients`	`string[]`	No	—
`locale`	`string`	No	The client's language — any enabled language code.
`sections`	`ClientReportSectionKey[]`	No	—
`contact_name`	`string`	No	—
`notes`	`string`	No	Your own notes; never printed.
`cadence`	`ClientReportCadence`	No	—
`send_email`	`boolean`	No	—
`narrative`	`boolean`	No	zs-541: open each report with a few paragraphs in plain words, written by AI in the client's language from the report's own figures. Paid from Zinn® credits through the connected…
`active`	`boolean`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`brand_id`	`object`	Yes	—
`logo_sha256`	`string`	Yes	The client's own mark (E5); empty when none.
`domains`	`string[]`	Yes	—
`recipients`	`string[]`	Yes	—
`locale`	`string`	Yes	—
`sections`	`ClientReportSectionKey[]`	Yes	—
`contact_name`	`string`	Yes	—
`notes`	`string`	Yes	—
`cadence`	`ClientReportCadence`	Yes	—
`send_email`	`boolean`	Yes	—
`narrative`	`boolean`	Yes	zs-541: reports open with a summary in plain words.
`active`	`boolean`	Yes	—
`next_run_at`	`object`	Yes	—
`last_run_at`	`object`	Yes	—
`created_at`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

PATCH /v1/client-reports/clients/{client_id}