Call Router -- Update

patch

https://dialpad.com/api/v2/callrouters/{id}

Updates the API call router with the given ID.

Rate limit: 1200 per minute.

Path Params

string

required

The API call router's ID

Body Params

default_target_id

int64 | null

The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails.

default_target_type

string | null

enum

The entity type of the default target.

enabled

boolean | null

If set to False, the call router will skip the routing url and instead forward calls straight to the default target.

name

string | null

[single-line only]

A human-readable display name for the router.

office_id

int64 | null

The ID of the office to which this router belongs.

reset_error_count

boolean | null

Sets the auto-disablement routing error count back to zero.

Call routers maintain a count of the number of errors that have occured within the past hour, and automatically become disabled when that count exceeds 10.

Setting enabled to true via the API will not reset that count, which means that the router will likely become disabled again after one more error. In most cases, this will be useful for testing fixes in your routing API, but in some circumstances it may be desirable to reset that counter.

routing_url

string | null

The URL that should be used to drive call routing decisions.

secret

string | null

[single-line only]

The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters.

Response

200A successful response