Update an existing internal number

This action will update an existing internal number matching the given id.

Try this request in your browser

/api/ /internal_numbers/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
destination_type
destination_id
caller_id_prefix String
caller_id_passthrough Boolean 

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/internal_numbers/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 internal number

 String null

name

The name for the number

 String null

destination_type

null

destination_id

null

caller_id_prefix

The prefix to add on calls from this number

 String null

caller_id_passthrough

Whether or not caller IDs should pass through when unanswered

 Boolean null

Errors

Error Attributes

InternalNumberNotFound

No internal number was found given the ID provided

  • id

    The provided ID

NoAccessToInternalNumber

Your authenticated identity is not permitted to access this internal number

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a internal number structure.

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