Skip to main content
PATCH
Update a schedule

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Path Parameters

id
string
required

The id.

Body

application/json

Partial update of a recurring schedule. Only provided fields are applied.

name
string

New schedule name (1-100 chars; cannot be empty).

frequency
enum<string>
Available options:
weekly,
biweekly,
monthly
dayOfWeek
integer
Required range: 0 <= x <= 6
dayOfMonth
integer
Required range: 1 <= x <= 28
status
enum<string>
Available options:
active,
paused,
cancelled
recipients
object[]
Minimum array length: 1
requiresApproval
boolean

Coerced: only the literal boolean true enables it.

Response

The updated schedule.

data
object
required