Update the phone number settings

PUT /api/2.0/crm/voip/numbers/{numberId:\w+}/settings

Request

Updates the settings of the phone number with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

numberIdstring

Phone number ID

greetingstring

New first greeting that callers hear when they call to this phone number

holdUpstring

New music on hold that callers hear when they are placed in the waiting queue

waitstring

New URL to which the customer is redirected to the voice mail service when the waiting timeout is exceeded

voiceMailstring

New message that callers hear when the waiting queue length or max waiting time is exceeded and the callers are able to leave a voicemail message

workingHoursunknown

New phone number working hours

allowOutgoingCallsarray of boolean

Defines if a phone number allows making the outgoing calls or not

recordarray of boolean

Defines if the phone number allows recording the calls or not

aliasstring

New phone number alias

Examples

PUT /api/2.0/crm/voip/numbers/%7BnumberId:/w+%7D/settings HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url 'https://example.com/api/2.0/crm/voip/numbers/%7BnumberId:/w+%7D/settings' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated phone number settings

401

Unauthorized