Update Ad Report
PUT/api/advertising/reports/:report
Updates a saved report. Every field is optional; send only what changes. When definition is sent, its metrics and dimensions keys are required inside it, and the whole definition is replaced.
advertising:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields
name(≤ 150 chars).definition(object): same keys as Create Ad Report.
Schedule fields
frequency(optional, nullable):daily,weeklyormonthly.day_of_week(optional, 1-7, ISO: 1 = Monday) for weekly;day_of_month(optional, 1-31; clamps to the month's last day) for monthly.time(optional, H:i, default 07:00) andtimezone(optional, any IANA zone, default the app timezone).format(optional):csvorxlsx, the attachment format for deliveries and the default for Export Saved Ad Report.email_recipients(optional, nullable, ≤ 20 emails).slack_webhook_url(optional, nullable): a Slack incoming-webhook URL (https://hooks.slack.com/services|workflows|triggers/…). It is never returned; responses showhas_slack_webhook.is_active(optional boolean): pause or resume the schedule.
next_run_at (UTC) is recomputed on every save; it is null when the report is inactive or has no frequency and recipients.
Requires the advertising.manage permission.
Also requires the advertising-manager feature (Advertising Manager plan); without it the endpoint returns 404.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.