Update

Update the add_bot_to_group flag on a sync target. The change propagates to every schedule with an active sync rule pointing at this target; the entire operation aborts if the caller lacks edit permission on any of those schedules.

PUT /v2/schedule_sync_targets/{id}

Update

cURL

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

200

{
  "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"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

The sync target ID

Example:

"abc123"

Body

application/json

add_bot_to_group · boolean · required

Whether the incident.io bot should be added to the group

Example:

true

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_target · object · required

Show child attributes