Skip to main content
PATCH
PATCH /schedules/{id}
Required permissions: schedules.update, publications.execute. Send an Idempotency-Key for this change. It is an operation ID, not an API key. Generate a UUID and reuse it when retrying the same request.
Use your Platform API key in Postman or your backend. Keep it private; do not enter it in this public page. Your workspace permissions and plan limits apply.
See the quickstart for request examples. Required fields and responses are listed below.

Authorizations

Authorization
string
header
required

Platform API key for one workspace. Create it in Settings with an expiry date or Never expire. Keep it private; use it from Postman or your backend, not browser code. Widget keys are not accepted.

Headers

Idempotency-Key
string
required

An operation ID, not your API key. Generate a UUID for each new change and reuse it when retrying the same request. See https://docs.layarva.com/developers/platform-request-keys for Postman, PowerShell and Node.js examples. Upload instructions are refreshed when requested again.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Path Parameters

id
string
required
Pattern: ^[A-Za-z0-9_-]{1,100}$

Body

application/json

Send application/json using the fields below. JSON requests must be no larger than 64 KiB.

Valid IANA timezone. Exact immutable Ready version plus publications.execute scope and publishing policy required. ONE_TIME needs startAtUtc; end must be after start. WEEKLY requires windows; other types require no windows. Windows have distinct days 0=Sunday..6=Saturday. Overlaps and same Playlist as Channel default rejected. Channel without a default produces DRAFT. PATCH requires expectedUpdatedAt and at least one editable field. Server-only cross-field/refinement rules are enforced beyond this JSON Schema.

expectedUpdatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
name
string
Required string length: 1 - 120
playlistVersionId
string
Pattern: ^[A-Za-z0-9_-]{1,100}$
channelId
string
Pattern: ^[A-Za-z0-9_-]{1,100}$
scheduleType
enum<string>
Available options:
ALWAYS,
ONE_TIME,
WEEKLY
timezone
string
Maximum string length: 100
startAtUtc
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
endAtUtc
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
weeklyWindows
object[]
Maximum array length: 14
paused
boolean

Response

Safe live-authorized result

data
object
required