Skip to main content
PUT
Update
🔑 Requires the schedule_pay_configs.update scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

id
string
required

Unique identifier for this pay config

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

Body

application/json
base_rate_cents
integer<int64>
required

Rate paid for any time no rule covers, in the lowest denomination of the currency

Example:

1200

currency
string
required

Currency this config pays in, in ISO 4217 format

Example:

"GBP"

name
string
required

Human readable name for this pay config

Example:

"Engineering on-call"

rate_time_unit
enum<string>
required

The unit of time every rate on this config is quoted per. Pay is pro-rated by the second either way.

Available options:
hour,
day
Example:

"hour"

timezone
string
required

IANA timezone this config's rules are interpreted in

Example:

"Europe/London"

Response

OK response.

pay_config
object
required

A pay config sets what someone is paid for being on call: a base rate, plus rules that override it at particular times. An on-call pay report prices each person's shifts against one.

Rules are evaluated in the order they are returned, and the first one that covers a shift wins. Any time no rule covers is paid at the base rate.