---
title: "Upsert Schedule"
method: PUT
path: "/sites/{site_id}/reports/schedule"
tags: ["business-reports"]
---

# Upsert Schedule

`PUT /sites/{site_id}/reports/schedule`

## Request

- Base URL: `https://api.xeorank.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.xeorank.com/sites/{site_id}/reports/schedule`
- Auth: API key in header `X-Agent-Key`

Create or update the report schedule for a site.

Requires the ``scheduled_reports`` feature flag on the user's plan.

## Path parameters

- `site_id` string, uuid, required

## Query parameters

- `email` string, nullable

## Request body

- ApiRoutersBusinessReportsScheduleRequest
  - `frequency` string, required: weekly, monthly, or both
  - `is_active` boolean
  - `day_of_month` integer
  - `recipients` string[]
  - `timezone` string
  - `brand_terms` string[]

## Response `200`

Successful Response

- ScheduleOut
  - `id` string, uuid, required
  - `site_id` string, uuid, required
  - `frequency` string, required
  - `is_active` boolean, required
  - `day_of_month` integer, nullable
  - `recipients` unknown[], nullable
    - unknown
  - `timezone` string
  - `brand_terms` unknown[], nullable
    - unknown
  - `last_weekly_run_at` string, date-time, nullable
  - `last_monthly_run_at` string, date-time, nullable
  - `created_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/xeorank/apis/seo-intelligence-engine.md) · [All operations](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/llms.txt) · [OpenAPI document](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/revisions/449a3fd73454?raw)