Update

Update a sync rule’s sync_type in place. If the rule’s sync target is shared with other schedules, the change propagates to every linked schedule and the entire operation aborts if the caller lacks edit permission on any of them.

PUT /v2/schedules/{schedule_id}/sync_rules/{id}

Update

cURL

curl --request PUT \
  --url https://api.incident.io/v2/schedules/{schedule_id}/sync_rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annotations": {
    "incident.io/terraform/version": "3.0.0"
  },
  "sync_type": "on_call"
}
'

200

{
  "schedule_sync_rule": {
    "created_at": "2021-08-17T13:28:57.801578Z",
    "id": "01JXYZ000000000000000000CD",
    "schedule_id": "01JXYZ000000000000000000EF",
    "schedule_sync_target": {
      "add_bot_to_group": true,
      "created_at": "2021-08-17T13:28:57.801578Z",
      "id": "01JXYZ000000000000000000AB",
      "linked_schedules": [
        {
          "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
          "name": "Primary On-Call Schedule",
          "team_ids": [
            "01JPQA75EPNEES4479P16P4XAB"
          ]
        }
      ],
      "slack_team_id": "T02A1AZHG3J",
      "slack_user_group_id": "S06MNNU5BMK",
      "updated_at": "2021-08-17T13:28:57.801578Z"
    },
    "schedule_sync_target_id": "01JXYZ000000000000000000AB",
    "sync_type": "on_call",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

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

Show child attributes

Example:

{ "incident.io/terraform/version": "3.0.0" }

Response

200 - application/json

OK response.

schedule_sync_rule · object · required

Show child attributes