ads
POST /v1/ads/report/schedules
Create or replace a client's weekly or monthly PDF report (za-200).
Authentication
Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/ads/report/schedules \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "cadence": <string<weekly, monthly>>, "recipients": <string[]> }'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
Gated on ads.manage; audit action ads.report_schedule.save. One schedule per client organisation and cadence: posting the same cadence again replaces it (200), a new one answers 201. Weekly reports are sent on Monday at 06:00 UTC, monthly ones on the 1st at 06:00 UTC, by a Temporal workflow. A bad field answers 422 badLimit naming it.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | The client organisation the report is about. |
cadence | string<weekly, monthly> | Yes | — |
window_days | integer<7, 30, 90> | No | Default 7 (weekly) or 30 (monthly). |
recipients | string[] | Yes | — |
locale | string | No | One of the 58 platform languages. |
enabled | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsReportSchedule | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429