Update an on-call schedule for a team

patch

https://api.firehydrant.io/v1/teams/{team_id}/on_call_schedules/{schedule_id}

Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for name and description will be ignored if the schedule has more than one rotation. If the schedule has only one rotation, you can continue to update that rotation using the rotation-specific parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

string

required

schedule_id

string

required

Body Params

name

string | null

A new name for the on-call schedule.

description

string | null

A new, detailed description for the on-call schedule.

rotation_name

string | null

A new name for the schedule's rotation.

rotation_description

string | null

A new, detailed description for the schedule's rotation.

color

string | null

A hex color code that will be used to represent the schedule's rotation in FireHydrant's UI.

time_zone

string | null

The time zone in which the on-call schedule's rotation will operate. This value must be a valid IANA time zone name.

slack_user_group_id

string | null

The ID of a Slack user group to sync the rotation's on-call members to.

members

array of objects | null

An ordered list of objects that specify members of the schedule's rotation.

members

strategy

object | null

An object that specifies how the rotation's on-call shifts should be generated.

restrictions

array of objects | null

A list of objects that restrict the schedule's rotation to specific on-call periods.

restrictions

effective_at

string | null

An ISO8601 time string specifying when the updated schedule should take effect. This value must be provided if editing an attribute that would affect how the schedule's shifts are generated, such as the time zone, members, strategy, or restrictions.

member_ids

array of strings | null

This parameter is deprecated; use members instead.

member_ids

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for name and description will be ignored if the schedule has more than one rotation. If the schedule has only one rotation, you can continue to update that rotation using the rotation-specific parameters.