UpdatePath Escalations V2

Updates an escalation path.

We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.

put/v2/escalation_paths/{id}

Request

Base URL
https:////api.incident.io
Auth
none declared
TypeScript
https://skmtc.dev/incident/apis/incident-io/docs/v2/escalation_paths/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Unique identifier for this escalation path.

Request body

namestring required

The name of this escalation path, for the user's reference.

Example request

{
  "name": "Urgent Support",
  "path": [
    {
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "if_else": {
        "conditions": [
          {
            "operation": "one_of",
            "param_bindings": [
              {
                "array_value": [
                  {
                    "literal": "SEV123",
                    "reference": "incident.severity"
                  }
                ],
                "value": {
                  "literal": "SEV123",
                  "reference": "incident.severity"
                }
              }
            ],
            "subject": "incident.severity"
          }
        ],
        "else_path": [
          {}
        ],
        "then_path": [
          {}
        ]
      },
      "level": {
        "round_robin_config": {
          "enabled": false,
          "rotate_after_seconds": 120
        },
        "targets": [
          {
            "id": "lawrencejones",
            "schedule_mode": "currently_on_call",
            "type": "user",
            "urgency": "high"
          }
        ],
        "time_to_ack_interval_condition": "active",
        "time_to_ack_seconds": 1800,
        "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
      },
      "notify_channel": {
        "targets": [
          {
            "id": "lawrencejones",
            "schedule_mode": "currently_on_call",
            "type": "user",
            "urgency": "high"
          }
        ],
        "time_to_ack_interval_condition": "active",
        "time_to_ack_seconds": 1800,
        "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
      },
      "repeat": {
        "repeat_times": 3,
        "to_node": "01FCNDV6P870EA6S7TK1DSYDG0"
      },
      "type": "if_else"
    }
  ],
  "working_hours": [
    {
      "id": "abc123",
      "name": "abc123",
      "timezone": "abc123",
      "weekday_intervals": [
        {
          "end_time": "17:00",
          "start_time": "09:00",
          "weekday": "abc123"
        }
      ]
    }
  ]
}

Response

OK response.

Example response

{
  "escalation_path": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Urgent Support",
    "path": [
      {
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "if_else": {
          "conditions": [
            {
              "operation": {
                "label": "Lawrence Jones",
                "value": "01FCQSP07Z74QMMYPDDGQB9FTG"
              },
              "param_bindings": [
                {
                  "array_value": [
                    {
                      "label": "Lawrence Jones",
                      "literal": "SEV123",
                      "reference": "incident.severity"
                    }
                  ],
                  "value": {
                    "label": "Lawrence Jones",
                    "literal": "SEV123",
                    "reference": "incident.severity"
                  }
                }
              ],
              "subject": {
                "label": "Incident Severity",
                "reference": "incident.severity"
              }
            }
          ],
          "else_path": [
            {}
          ],
          "then_path": [
            {}
          ]
        },
        "level": {
          "round_robin_config": {
            "enabled": false,
            "rotate_after_seconds": 120
          },
          "targets": [
            {
              "id": "lawrencejones",
              "schedule_mode": "currently_on_call",
              "type": "user",
              "urgency": "high"
            }
          ],
          "time_to_ack_interval_condition": "active",
          "time_to_ack_seconds": 1800,
          "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
        },
        "notify_channel": {
          "targets": [
            {
              "id": "lawrencejones",
              "schedule_mode": "currently_on_call",
              "type": "user",
              "urgency": "high"
            }
          ],
          "time_to_ack_interval_condition": "active",
          "time_to_ack_seconds": 1800,
          "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
        },
        "repeat": {
          "repeat_times": 3,
          "to_node": "01FCNDV6P870EA6S7TK1DSYDG0"
        },
        "type": "if_else"
      }
    ],
    "working_hours": [
      {
        "id": "abc123",
        "name": "abc123",
        "timezone": "abc123",
        "weekday_intervals": [
          {
            "end_time": "17:00",
            "start_time": "09:00",
            "weekday": "abc123"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.