Skip to main content
PATCH
Edit Fax Extension

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Extension ID

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

Body

application/json
name
string
Minimum string length: 3
emergencyLocationId
number
emergencyLocation
string | null
branchId
number
callerIdNumber
string | null
Pattern: ^[1-9]\d{9}$
outboundDialPrefix
Pattern: ^[1-9][0-9]{6}$
deviceId
number

Response

200 - application/json

Updated fax extension

id
number
required

Extension ID

tenant
object
required

Owning tenant

name
string | null
required

Extension name

number
string | null
required

Extension number

email
string | null
required

Extension email

peerName
string | null
required

SIP peer name

callerIdNumber
string | null
required

Outbound caller ID number

recording
string | null
required

Call recording mode

callLimit
number | null
required

Concurrent call limit

dialTimeout
number | null
required

Inbound ring timeout (seconds)

routingProfileId
number | null
required

Routing profile ID

emergencyLocationId
number | null
required

Emergency location ID

outboundDialPrefix
string | null
required

Outbound dial prefix

includeInPhonebook
string | null
required

Phonebook inclusion

enableForwarding
string | null
required

Forwarding state

emergencyLocationComment
string | null
required

Free-text emergency location comment

branch
object
required

Branch

emergencyLocation
object | null
required

Emergency location

devices
object[]
required

Assigned devices