Skip to main content
ZStack
Alerting & Response/On-Call

CreateOnCallOverride

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

POST/api/v1/oncall/overrides

Operation ID

CreateOnCallOverride

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • scheduleUuid
    StringRequired

    UUID of the schedule for which the override is created

    Example: sched-00112233

  • originalUser
    StringRequired

    User ID of the person being replaced during the override

    Example: user-abc123

  • substituteUser
    StringRequired

    User ID of the person taking over the shift

    Example: user-xyz789

  • startTime
    StringRequired

    Timestamp when the override period begins

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

  • endTime
    StringRequired

    Timestamp when the override period ends

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

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the override record

    Example: ovrd-aabbccdd

  • scheduleUuid
    String

    UUID of the schedule this override belongs to

    Example: sched-00112233

  • originalUser
    String

    User ID of the person being replaced

    Example: user-abc123

  • substituteUser
    String

    User ID of the person taking over the shift

    Example: user-xyz789

  • startTime
    String

    Timestamp when the override period starts

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

  • endTime
    String

    Timestamp when the override period ends

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

  • reason
    String

    Reason provided for the shift override

    Example: Annual leave

  • createDate
    String

    Timestamp when the override was created

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