Update number properties

This action will update a number's properties

Try this request in your browser

/api/ /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 Integer
name String
destination_type String
destination_id Integer
caller_id_prefix String
callerid_passthrough Bool
recording_enabled Bool 

The request output will be shown here...

URL

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

 Integer null

name

The name for the number

 String null

destination_type

The type of destination

 String null

destination_id

The ID of the destintion

 Integer null

caller_id_prefix

The caller ID prefix

 String null

callerid_passthrough

Whether or not caller IDs should pass through when unanswered

 Bool true

recording_enabled

Whether or not recording is enabled

 Bool null

Errors

Error Attributes

NumberNotFound

No number was found given the ID provided

  • id

    The provided ID

NoAccessToNumber

Your authenticated identity is not permitted to access this number

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a number structure.

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