Skip to main content

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.

Required scope: advertising:write

Grant 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, weekly or monthly.
  • 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) and timezone (optional, any IANA zone, default the app timezone).
  • format (optional): csv or xlsx, 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 show has_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​

OK

Response Headers
    Content-Type