Update an existing caller ID route

This action will update an existing caller ID route matching the given ID.

Try this request in your browser

/api/ /caller_id_routes/update

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id String
name String
number String
destination_id Integer
destination_type String

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/caller_id_routes/update

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the caller ID route

String null

name

A name/description for this route

String null

number

The phone number that you wish this route to apply to

String null

destination_id

The ID of the destintion

Integer null

destination_type

The type of the destination

String null

Errors

Error Attributes

CallerIDRouteNotFound

No caller ID route was found given the ID provided

  • id

    The provided ID

NoAccessToCallerIDRoute

Your authenticated identity is not permitted to access this caller ID route

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a caller id route structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.