PATCH /api/v2/callrouters/{id}
Updates the API call router with the given ID.
Rate limit: 1 per 5 minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The API call router's ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
routing_url |
String | No |
The URL that should be used to drive call routing decisions. |
name |
String | No |
[single-line only] A human-readable display name for the router. |
default_target_id |
Integer | No |
The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails. |
enabled |
Boolean | No |
If set to False, the call router will skip the routing url and instead forward calls straight to the default target. |
default_target_type |
String | No |
The entity type of the default target. Possible values:
|
office_id |
Integer | No |
The ID of the office to which this router belongs. |
secret |
String | No |
[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. |
reset_error_count |
Boolean | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.