Skip to main content
PATCH
Update Phone Number

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Phone number ID

Pattern: ^[1-9]\d*$

Body

application/json
tenantId
number

Tenant ID

diCommentName
string

Comment/description

Maximum string length: 255
recording

Recording mode (no, yes, yeschange)

Available options:
no
fax

Fax mode (no, force, forcestoreandforward)

Available options:
no
faxEmail
string

Fax email address

Maximum string length: 500
faxStore

Store fax (1 = yes, 0 = no)

Available options:
1
namePrefix
string

Caller ID name prefix

Maximum string length: 255
unconditionalStatus

Unconditional forwarding (1 = on, 0 = off)

Available options:
1
emailRecording
string

Email address for recording delivery

Maximum string length: 255
storeAndForwardNumber
string

Store and forward number

Maximum string length: 255
branchId
number

Branch ID

routingDestinations
object[]

Routing destinations

forwardingDestinations
object[]

Forwarding destinations

smsDestinations
object[]

SMS destinations

Response

Updated phone number

id
number
required

Phone number ID

number
string
required

Phone number

registeredCNAM
string | null
required

Registered caller ID name

tenant
object | null
required

Parent tenant

branch
object | null
required

Assigned branch

diCommentName
string | null
required

Comment/description

recording
string | null
required

Recording mode

fax
string | null
required

Fax mode

faxEmail
string | null
required

Fax email

faxStore
number | null
required

Fax store enabled (1/0)

namePrefix
string | null
required

Caller ID name prefix

unconditionalStatus
number | null
required

Unconditional forwarding (1/0)

emailRecording
string | null
required

Recording email address

storeAndForwardNumber
string | null
required

Store and forward number

smsExt
object | null
required

SMS-assigned extension

registeredSMS
number

Whether SMS is provisioned (1/0)

routingDestinations
object[]

Routing destinations

forwardingDestinations
object[]

Forwarding destinations

smsDestinations
object[]

SMS destinations