RingCentral User Settings API
The User Settings API from RingCentral — 9 operation(s) for user settings.
RingCentral User Settings API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Settings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 17 operations across 9 paths, and defines 101 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.
Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.
17 operations
9 paths
101 schemas
3 DELETE7 GET2 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
RingCentral User Settings API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow.
By default, every request must be authenticated.
Paths & Operations 17
Across 9 paths, the API surfaces 17 operations — 3 DELETE, 7 GET, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
User Settings 17
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}
Get Scaled Profile Image
POST
/restapi/v2/accounts/{accountId}/batch-provisioning/users
Create Multiple User Extensions
DELETE
/restapi/v2/accounts/{accountId}/extensions
Delete User Extensions
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}
Get Extension
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}
Update Extension
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}deprecated
Delete Extension
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/grant
List Extension Grants
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing
Get User Conferencing Settings
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing
Update User Conferencing Settings
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
Get User Profile Image
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
Update User Profile Image
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
Upload User Profile Image
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
Delete User Profile Image
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
Get Extension Caller ID
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
Update Extension Caller ID
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings
Get Notification Settings
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings
Update Notification Settings
Schemas 101
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are GetExtensionInfoResponse (26 properties), ExtensionUpdateRequest (16 properties), GrantInfo (12 properties), ContactInfo (12 properties). Each schema is shown below with its type and property counts.
ExtensionInfoGrants
object
Extension information
5 properties
CustomFieldInfo
object
3 properties
DepartmentInfo
object
Please note that the Department extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology
3 properties
ConferencePhoneNumberInfo
object
2 properties
ExtensionGrantListEvent
object
5 properties
BatchProvisionUsersRequestItem
object
Describes request for user extension provisioning
7 properties
2 required
EmailRecipientInfo
object
6 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties
2 required
UpdateConferencingInfoRequest
object
2 properties
PageNavigationUri
object
1 property
ExtensionGreetingLanguageInfoRequest
object
1 property
GetExtensionInfoResponse
object
26 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
ExtensionCallerIdInfo
object
5 properties
ExtensionNumber
string
Short number of an extension. Actual max length depends on system length limit for extension.
ExtensionCountryInfoRequest
object
1 property
BulkItemResultModel
object
2 properties
1 required
CallerIdByFeatureInfo
object
2 properties
InboundTextsInfo
object
4 properties
PhoneNumberDefinitionNumberId
object
To be used to assign a number by ID
1 property
1 required
ExtensionFormattingLocaleInfoRequest
object
1 property
DeviceDefinition
object
3 properties
3 required
PermissionInfoInt
object
International Calling permission
1 property
PostalAddress
object
Postal address/location
6 properties
4 required
InboundFaxesInfo
object
6 properties
CountryInfoShortModel
CallerIdPhoneInfo
object
3 properties
ExtensionServiceFeatureInfo
object
3 properties
RegionalSettings
object
Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings
6 properties
SiteReference
object
1 property
ContactBusinessAddressInfo
object
User's business address. The default is Company (Auto-Receptionist) settings
5 properties
CountryInfoMinimalModel
object
2 properties
NotificationSettingsUpdateRequest
object
9 properties
ExtensionLanguageInfoRequest
object
1 property
FormattingLocaleInfo
object
Formatting language preferences for numbers, dates and currencies
3 properties
CallerIdByDevice
object
Caller ID settings by device
2 properties
GreetingLanguageInfo
object
Information on language used for telephony greetings
3 properties
UserTransitionInfo
object
For NotActivated extensions only. Welcome email settings
2 properties
BasicContactInfo
object
Personal contact information
3 properties
ContactInfo
object
Detailed contact information
12 properties
CallerIdDeviceInfo
object
3 properties
NotificationSettings
object
11 properties
CallerIdDeviceInfoRequest
object
1 property
CountryInfoBasicModel
BatchProvisionUsersSuccessItem
object
2 properties
2 required
ExtensionPermissions
object
Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'
2 properties
ExtensionCallerIdInfoRequest
object
5 properties
CallerIdByFeatureRequest
object
Caller ID settings by feature
2 properties
BulkOperationExtensionReference
object
Information about an extension this device is assigned to
1 property
1 required
ExtensionInfoEventBody
object
Notification payload body
4 properties
PhoneNumberInfoConferencing
object
6 properties
SetupWizardStateForUpdateEnum
string
Initial configuration wizard state
ProfileImageInfoURI
object
1 property
CallerIdPhoneInfoRequest
object
1 property
ReferenceInfo
object
3 properties
VoicemailsInfo
object
7 properties
EnumeratedPagingModel
object
6 properties
1 required
CallerIdByDeviceInfo
object
2 properties
ExtensionTimezoneInfoRequest
object
1 property
ExtensionInfoEvent
object
5 properties
BulkDeleteUsersResponse
object
1 property
1 required
ProvisioningSiteInfo
object
Site data. If multi-site feature is turned on for an account, then ID of a site must be specified. In order to assign a wireless point to the main site (compan…
4 properties
CallerIdByFeature
object
Caller ID settings by feature
2 properties
CallerIdByDeviceRequest
object
Caller ID settings by device
2 properties
BatchProvisionErrorItem
object
2 properties
2 required
BatchProvisionUsersResponse
object
1 property
1 required
PhoneNumberDefinitionPreferredAreaCode
object
To use as selection hint when a "toll" number to be selected from the number pool.
1 property
1 required
CallerIdByDeviceInfoRequest
object
2 properties
AssignedCountryInfo
object
Information on a country assigned to an extension user. Returned for the User extension type only
4 properties
ExtensionGrantListEventBody
object
Notification payload body
2 properties
Roles
object
6 properties
PhoneNumberE164
string
Phone number in e.164 format (with '+' prefix)
BulkDeleteUsersRequest
object
2 properties
1 required
PhoneNumberTollType
string
Indicates if a number is toll or toll-free
GetExtensionAccountInfo
object
Account information
2 properties
MissedCallsInfo
object
4 properties
ExtensionRegionalSettingRequest
object
7 properties
ProfileImageInfo
object
Information on profile image
5 properties
1 required
CallerIdByFeatureInfoRequest
object
2 properties
GetConferencingInfoResponse
object
9 properties
GrantInfo
object
12 properties
BatchProvisionUsersRequest
object
Describes request for user extension provisioning
1 property
1 required
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
OutboundFaxesInfo
object
4 properties
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property
1 required
PhoneNumberDefinitionTollType
object
To use as selection criteria when a number to be selected from the number pool.
1 property
1 required
ExtensionUpdateRequest
object
16 properties
CostCenterInfo
object
Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
2 properties
ExtensionCurrencyInfoRequest
object
1 property
PronouncedNameInfo
object
3 properties
CallQueueExtensionInfo
object
For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product te…
4 properties
ExtensionStatusInfo
object
Status information (reason, comment). Returned for 'Disabled' status only
3 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property
1 required
CallQueueInfoRequest
object
For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product te…
4 properties
PronouncedNamePromptInfo
object
3 properties
PermissionInfoAdmin
object
Admin permission
1 property
TimezoneInfo
object
Extension timezone information
5 properties
RegionalLanguageInfo
object
Information on a language set as regional
3 properties
ContactInfoUpdateRequest
object
11 properties
PhoneNumberDefinitionDirectNumberWithReservationId
object
To be used for direct number assignment in case number pool is not supported
2 properties
1 required
GetExtensionGrantListResponse
object
4 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from RingCentral 12
Other APIs RingCentral publishes across the network.
RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API
#User Settings