Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
User Settings

Update Extension

Updates the user settings.

put/restapi/v1.0/account/{accountId}/extension/{extensionId}

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Request body

status'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen'
extensionNumberstring

Extension number available

setupWizardState'NotStarted' | 'Incomplete' | 'Completed'

Initial configuration wizard state

partnerIdstring

Additional extension identifier, created by partner application and applied on client side

ivrPinstring

IVR PIN

passwordstring

Password for extension

type'User' | 'FaxUser' | 'FlexibleUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'DelegatedLinesGroup' | 'GroupCallPickup'

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

subType'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown' | 'Emergency'

Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned

Response

Success

idinteger

Internal identifier of an extension

uristring uri

Canonical URI of an extension

extensionNumberstring

Extension short number

extensionNumbersstring[]
namestring

Extension name. For user extension types the value is a combination of the specified first name and last name

partnerIdstring

For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid=XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension

setupWizardState'NotStarted' | 'Incomplete' | 'Completed'

Initial configuration wizard state

status'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned'

Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned

type'User' | 'FaxUser' | 'FlexibleUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Bot' | 'Room' | 'RoomConnector' | 'Limited' | 'Site' | 'ProxyAdmin' | 'DelegatedLinesGroup' | 'GroupCallPickup'

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

subType'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency'

Extension subtype, if applicable. For any unsupported subtypes the Unknown value will be returned

hiddenboolean

Hides extension from showing in company directory. Supported for extensions of User type only