Skip to main content
PUT
Update
🔑 Requires the call_routes.update scope.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The call route's ID

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json
custom_language
enum<string>
required

The language we speak voice prompts in, via text-to-speech

Available options:
en-US,
en-GB,
fr-FR,
es-ES,
pt-PT,
pt-BR,
de-DE,
nl-NL
Example:

"en-US"

name
string
required

Name for this call route

Example:

"Regulator urgent request"

path
object[]
required

Who to page when a call comes in. Retires any phone-tree menu on the route; send an empty list to keep the menu.

Example:
responder_caller_id
enum<string>
required

Which number responders see when we call them:

  • route_number: this route's own number
  • oncall_number: an incident.io on-call number
Available options:
route_number,
oncall_number
Example:

"route_number"

use_caller_allowlist
boolean
required

Whether to only answer calls from this route's allowed callers. Needs at least one allowed caller.

Example:

true

Response

OK response.

call_route
object
required

A call route is a phone number your customers can call to reach whoever is on call, for an urgent support line or a regulator hotline.

When a call comes in we work down the route's path, ringing each level's targets in turn until someone answers, then connect them to the caller. A trailing voicemail node records a message instead. Every call raises an alert, so calls can open incidents through an alert route.

List and edit call routes here. Create and delete them in the dashboard.