Skip to main content
POST
/
schedules
/
{schedule_id}
/
overrides
Override a schedule shift
curl --request POST \
  --url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "user_references": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ]
}
'
{
  "override": {
    "id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "users": [
      {
        "id": "<string>",
        "name": "<string>",
        "email": "[email protected]",
        "role": "owner",
        "seat": "viewer",
        "time_zone": "<string>",
        "slack_id": "<string>"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Path Parameters

​
schedule_id
string
required

The ID of the schedule.

Body

application/json
​
start
string<date-time>
required

The start date and time of the override. ISO 8601 format, UTC timezone.

​
end
string<date-time>
required

The end date and time of the override. ISO 8601 format, UTC timezone.

​
user_references
object[]
required

The users that that will be on-call during the override.

Required array length: 1 - 4 elements
Example:
{
  "type": "email",
  "value": "[email protected]"
}

Response

Default Response

​
override
object
required
Example:
{
  "id": "ovr_i9fo8GI1YBAQhtoArC3N1",
  "start": "2024-12-01T00:00:00Z",
  "end": "2024-12-08T00:00:00Z",
  "users": [
    {
      "id": "usr_C0GwCFdk0I4pBMRny4qYV",
      "name": "Dena",
      "email": "[email protected]",
      "role": "standard",
      "seat": "member",
      "slack_id": "U082GMAFR1T"
    }
  ]
}