Skip to content

Replace the on-call roster

PUT
/organizations/{org_id}/on-call/members
curl --request PUT \
--url https://api.perstat.io/organizations/example/on-call/members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "members": [ { "position": 1, "user_id": "example" } ] }'

Replaces the ordered on-call rotation roster of the organization. Ids that are not current members are skipped; an empty list clears the roster, while a non-empty list in which no id resolves returns 400 to protect against accidental wipes. Requires organization admin rights and an on-call capable plan (402 otherwise). Accepts API keys with the on-call:write scope, subject to current role and resource grants.

org_id
required
string
Media typeapplication/json
object
members
required
Array<object>
object
position
required
integer format: int32
user_id
required

Interner User-UUID.

string
Examplegenerated
{
"members": [
{
"position": 1,
"user_id": "example"
}
]
}

Request succeeded. The response body contains the result.

Media typeapplication/json
object
members
required
Array<object>
object
position
required
integer format: int32
user_id
required

Interner User-UUID.

string
Examplegenerated
{
"members": [
{
"position": 1,
"user_id": "example"
}
]
}

The request is invalid. Check the supplied fields and values.

Authentication is missing or invalid.

The request exceeds an entitlement or limit of the current plan.

The authenticated caller does not have permission to perform this operation.

No accessible resource matches the supplied identifier.