Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Create an on-call override

Creates an override for a user between two RFC 3339 timestamps, with an optional reason.

POST https://app.upfour.io/v1/oncall-schedules/{scheduleID}/overrides
POST https://app.upfour.io/v1/oncall-schedules/{scheduleID}/overrides

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs oncall.write.
Path
Body
More fields1
Headers

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope oncall.write stable Idempotency-Key supported returns 201

Parameters

FieldTypeDescription
scheduleID required uuid path parameter

Body

application/json required 4 fields

ends_atstring (date-time)required

RFC 3339, after starts_at.

In the app: Until
starts_atstring (date-time)required

RFC 3339.

In the app: From
user_iduuidrequired
In the app: Who covers
All other fields1 fields
reasonstring
In the app: Reason (optional)

Returns

A successful request returns 201 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data OnCallOverride
OnCallOverride · 10 fields
FieldTypeDescription
created_at string (date-time)
ends_at string (date-time)
id uuid
reason string
schedule_id uuid
starts_at string (date-time)
user_id uuid
email string
first_name string
last_name string

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.