Skip to main content
POST
Update schedule

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Schedule create/update/preview request body. The server accepts the same shape as the schedule detail model; only the key fields are listed here. For update, set schedule_id. For preview, start and end are required.

schedule_id
integer<int64> | null

Schedule ID. Required on update.

schedule_name
string | null

Schedule display name. Max 40 characters.

Maximum string length: 40
name
string | null

Legacy schedule name field. Used when schedule_name is empty.

Maximum string length: 40
description
string | null

Schedule description. Max 500 characters.

Maximum string length: 500
team_id
integer<int64> | null

Owning team ID.

layers
object[]

Rotation layers.

notify
object

Notification configuration attached to a schedule.

start
integer<int64>

Preview window start (Unix seconds, 10 digits). Required for /schedule/preview.

end
integer<int64>

Preview window end (Unix seconds, 10 digits). Required for /schedule/preview. Max 45 days after start.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Empty response.