|docs
Start Trial
REST APISchedules_v3

Update an event

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Update an existing event.

Restrictions based on event timing:

  • Past events (effective_until in the past): Cannot be modified
  • Active events (currently producing shifts): Can only update effective_until
  • Future events (effective_since in the future): All fields can be updated

Authorization

api_key
Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the schedule.

rotation_id*string

The ID of the rotation.

event_id*string

The ID of the event.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Which fields can be updated depends on the event's current state:

  • Active events (already started): only effective_until can be changed
  • Future events: all fields can be changed
  • Past events: no fields can be changed (returns 400)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json