On-call schedules

Create an on-call schedule

Creates an empty, active rotation. Idempotent by name: repeating the call with a name this company already uses returns the existing schedule with 200 instead of 201, so a retry after a timeout cannot produce twins with the shifts split between them. Fill it afterwards with POST /api/v1/schedules/{schedule}/rotation.

post/api/v1/schedules

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/schedules
  • Auth: API key in header X-API-Key

Request body

namestring required

Repeating a create with a name that already exists in this company returns the existing schedule with 200 instead of creating a twin — retrying after a timeout is therefore safe.

timezonestring required

IANA zone name, e.g. "Europe/Warsaw" or "UTC". Validated against the zone database: an unknown name is rejected with 422 rather than stored, because a schedule with a bogus zone fails on the first rotation generation.

default_handoff_day_of_weekinteger

ISO-8601 weekday the weekly handoff happens on: 1 = Monday … 7 = Sunday. Defaults to 1 when omitted.

default_handoff_hourinteger

Hour of the handoff in the schedule's timezone. Defaults to 9 when omitted.

default_handoff_minuteinteger

Minute of the handoff. Defaults to 0 when omitted.

Response

A schedule with this name already existed; it is returned unchanged.

Changes

No recorded changes to this operation across all 1 revision of this API.