Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
POSTOnCallSince 1.0SynchronousAuth Required

CreateOnCallOverride

Create a shift override to substitute one on-call member for another

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • scheduleUuidStringRequired

    UUID of the schedule for which the override is created

    Example: sched-00112233

  • originalUserStringRequired

    User ID of the person being replaced during the override

    Example: user-abc123

  • substituteUserStringRequired

    User ID of the person taking over the shift

    Example: user-xyz789

  • startTimeStringRequired

    Timestamp when the override period begins

    Example: 2026-01-15T08:00:00Z

  • endTimeStringRequired

    Timestamp when the override period ends

    Example: 2026-01-15T08:00:00Z

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the override record

    Example: ovrd-aabbccdd

  • scheduleUuidString

    UUID of the schedule this override belongs to

    Example: sched-00112233

  • originalUserString

    User ID of the person being replaced

    Example: user-abc123

  • substituteUserString

    User ID of the person taking over the shift

    Example: user-xyz789

  • startTimeString

    Timestamp when the override period starts

    Example: 2026-01-15T08:00:00Z

  • endTimeString

    Timestamp when the override period ends

    Example: 2026-01-15T08:00:00Z

  • reasonString

    Reason provided for the shift override

    Example: Annual leave

  • createDateString

    Timestamp when the override was created

    Example: 2026-01-15T08:00:00Z

Endpoint

POST/api/v1/oncall/overrides

/api/v1/oncall/overrides

Operation ID

CreateOnCallOverride

Permalink

Request Example

curl -X POST '{host}/api/v1/oncall/overrides' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"scheduleUuid":"sched-00112233","originalUser":"user-abc123","substituteUser":"user-xyz789","startTime":"2026-01-15T08:00:00Z","endTime":"2026-01-15T08:00:00Z","reason":"Annual leave"}'

Response Example

200
{
  "uuid": "ovrd-aabbccdd",
  "scheduleUuid": "sched-00112233",
  "originalUser": "user-abc123",
  "substituteUser": "user-xyz789",
  "startTime": "example",
  "endTime": "example",
  "reason": "Annual leave",
  "createDate": "example"
}

Change History

This API has no change history records yet.

View all change history