---
title: "Create or Update Schedule"
method: POST
path: "/reports/templates/{template_id}/schedule"
tags: ["Reports"]
---

# Create or Update Schedule

`POST /reports/templates/{template_id}/schedule`

## Request

- Base URL: `https://api.rebrandly.com/v1`
- URL: `https://api.rebrandly.com/v1/reports/templates/{template_id}/schedule`
- Auth: API key in header `apikey`

Create or update the schedule for a report template.

**Feature Required:** `reports.custom`

## Path parameters

- `template_id` string, required

## Headers

- `Workspace` string
- `apikey` string, required

## Request body

- ReportScheduleInput: Input for creating/updating a schedule
  - `active` boolean: Whether the schedule is active
  - `recurrence` object
    - `period` 'day' | 'week' | 'month'
    - `units` integer
  - `timespan` object
    - `unit` 'hour' | 'day' | 'week' | 'month'
    - `units` integer
  - `timezone` string: Timezone for scheduling
  - `nextExecutionTimestamp` string, date-time: Next scheduled execution time

## Response `200`

Schedule created/updated

- ReportSchedule: Report template schedule configuration
  - `id` string, required: Schedule public ID
  - `templateId` string: Associated template ID
  - `active` boolean: Whether the schedule is active
  - `recurrence` object: Recurrence configuration
    - `period` 'day' | 'week' | 'month': Recurrence period unit
    - `units` integer: Number of period units between executions
  - `timespan` object: Data timespan for each execution
    - `unit` 'hour' | 'day' | 'week' | 'month'
    - `units` integer
  - `timezone` string: Timezone for scheduling (e.g., UTC, America/New_York)
  - `nextExecutionTimestamp` string, date-time: Next scheduled execution time
  - `createdAt` string, date-time
  - `updatedAt` string, date-time

## Other responses

- `403`: Forbidden - Insufficient permissions
- `404`: Resource not found

---

[API](https://skmtc.dev/rebrandly/apis/rebrandly-api.md) - [All operations](https://skmtc.dev/rebrandly/apis/rebrandly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rebrandly/apis/rebrandly-api/revisions/b098bf9fb684?raw)