client-reports
POST /v1/client-reports/clients
Add a client, the domains a report covers, who receives it and how often.
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 POST https://api.zinndigital.com/v1/client-reports/clients \
-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
⛔ Refused past the clients your plan covers (5 / 25 / 100, plus packs). Empty domains means the report covers everything this account tracks. locale is the CLIENT's language — the report and its e-mail are written in it. Requires sites.create.
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 | — |
active | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
brand_id | object | Yes | — |
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 | — |
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