Skip to main content
PUT
Update

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings β†’ API keys)

Path Parameters

schedule_id
string
required

The parent schedule ID

Example:

"01FDAG4SAP5TYPT98WGR2N7W91"

id
string
required

The sync rule ID

Example:

"01JXYZ000000000000000000CD"

Body

application/json
sync_type
enum<string>
required

Which schedule members sync to the user group

Available options:
on_call,
all_users
Example:

"on_call"

annotations
object

Annotations that track metadata about this resource

Example:

Response

200 - application/json

OK response.

schedule_sync_rule
object
required

A sync rule links a schedule to a sync target, telling us which of the schedule's members should flow into the target's Slack user group.

sync_type decides who is synced: on_call syncs only the people currently on call, while all_users syncs everyone on the schedule. By default every rotation on the schedule is included; set rotation_id to scope the rule to a single rotation. As the schedule's shifts change hands, we keep the target's Slack user group membership in step with the rule.