--- title: "Update Extension" method: PUT path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}" tags: ["User Settings"] --- # Update Extension `PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}` Updates the user settings. ## Path parameters - `accountId` string, required - `extensionId` string, required ## Request body - ExtensionUpdateRequest - `status` 'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen' - `statusInfo` ExtensionStatusInfo — Status information (reason, comment). Returned for 'Disabled' status only - `comment` string — A free-form user comment, describing the status change reason - `reason` 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily' — Type of suspension - `till` string, date-time — Date until which an account will get deleted. The default value is 30 days since the current date - `extensionNumber` string — Extension number available - `contact` ContactInfoUpdateRequest - `firstName` string — For User extension type only. Extension user first name - `lastName` string — For User extension type only. Extension user last name - `company` string — Extension user company name - `jobTitle` string - `email` string, email — Email of extension user - `businessPhone` string — Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format - `mobilePhone` string — Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format - `businessAddress` ContactBusinessAddressInfo — User's business address. The default is Company (Auto-Receptionist) settings - `country` string — Country name of a user's company - `state` string — State/province name of a user's company. Mandatory for the USA, UK and Canada - `city` string — City name of a user's company - `street` string — Street address of a user's company - `zip` string — Zip code of a user's company - `emailAsLoginName` boolean — If `true` then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is `false` - `pronouncedName` PronouncedNameInfo - `type` 'Default' | 'TextToSpeech' | 'Recorded' — The method used to pronounce the user's name: - `Default` - default extension name; first and last name specified in user's profile are pronounced using text-to-speech; - `TextToSpeech` - custom text specified by a user pronounced using text-to-speech; - `Recorded` - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval). - `text` string — Custom text (for `TextToSpeech` type only) - `prompt` PronouncedNamePromptInfo - `id` string - `contentUri` string, uri — Link to a prompt resource - `contentType` 'audio/mpeg' | 'audio/wav' — Content media type - `department` string — Extension user department, if any - `regionalSettings` ExtensionRegionalSettingRequest - `homeCountry` ExtensionCountryInfoRequest - `id` string — Internal identifier of a country - `timezone` ExtensionTimezoneInfoRequest - `id` string — Internal identifier of a timezone - `language` ExtensionLanguageInfoRequest - `id` string — Internal identifier of a language - `greetingLanguage` ExtensionGreetingLanguageInfoRequest - `id` string — Internal identifier of a greeting language - `formattingLocale` ExtensionFormattingLocaleInfoRequest - `id` string — Internal Identifier of a formatting language - `currency` ExtensionCurrencyInfoRequest - `id` string — Internal Identifier of a currency - `timeFormat` '12h' | '24h' — Time format setting - `setupWizardState` 'NotStarted' | 'Incomplete' | 'Completed' — Initial configuration wizard state - `partnerId` string — Additional extension identifier, created by partner application and applied on client side - `ivrPin` string — IVR PIN - `password` string — Password for extension - `callQueueInfo` CallQueueInfoRequest — For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology - `slaGoal` integer — Target percentage of calls that must be answered by agents within the service level time threshold - `slaThresholdSeconds` integer - `includeAbandonedCalls` boolean - `abandonedThresholdSeconds` integer - `transition` UserTransitionInfo — For NotActivated extensions only. Welcome email settings - `sendWelcomeEmailsToUsers` boolean — Specifies if a welcome/activation email is sent to the existing users during account confirmation - `sendWelcomeEmail` boolean — Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unassigned' to 'NotActivated/Disabled') - `customFields` CustomFieldInfo[] - `id` string — Internal identifier of a custom field - `value` string — Custom field value - `displayName` string - `site` SiteReference - `id` string — Internal identifier of a site - `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 - `references` ReferenceInfo[] — List of non-RC internal identifiers assigned to an extension - `ref` string — Non-RC identifier of an extension - `type` 'PartnerId' | 'CustomerDirectoryId' — Type of external identifier - `refAccId` string — Primary federation admin account identifier ## Response `200` Success - GetExtensionInfoResponse - `id` integer — Internal identifier of an extension - `uri` string, uri — Canonical URI of an extension - `account` GetExtensionAccountInfo — Account information - `id` string — Internal identifier of an account - `uri` string, uri — Canonical URI of an account resource - `contact` ContactInfo — Detailed contact information - `firstName` string — User's first name (for extensions of `User` type only) - `lastName` string — For User extension type only. User's last name (for extensions of `User` type only) - `name` string — Extension name (for extensions of `User` type - concatenation of first and last name) - `company` string — User's company name - `jobTitle` string — User's job title - `email` string, email — User's contact email - `businessPhone` string — User's contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format - `mobilePhone` string — User's mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format - `businessAddress` ContactBusinessAddressInfo — User's business address. The default is Company (Auto-Receptionist) settings - `country` string — Country name of a user's company - `state` string — State/province name of a user's company. Mandatory for the USA, UK and Canada - `city` string — City name of a user's company - `street` string — Street address of a user's company - `zip` string — Zip code of a user's company - `emailAsLoginName` boolean — Indicates that the contact email is enabled as a login name for this user. Please note that the email must be unique in this case. - `pronouncedName` PronouncedNameInfo - `type` 'Default' | 'TextToSpeech' | 'Recorded' — The method used to pronounce the user's name: - `Default` - default extension name; first and last name specified in user's profile are pronounced using text-to-speech; - `TextToSpeech` - custom text specified by a user pronounced using text-to-speech; - `Recorded` - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval). - `text` string — Custom text (for `TextToSpeech` type only) - `prompt` PronouncedNamePromptInfo - `id` string - `contentUri` string, uri — Link to a prompt resource - `contentType` 'audio/mpeg' | 'audio/wav' — Content media type - `department` string — User's department name - `costCenter` CostCenterInfo — Cost center information. Applicable if Cost Center feature is enabled. The default is `root` cost center value - `id` string — Internal identifier of a cost center - `name` string — Name of a cost center - `customFields` CustomFieldInfo[] - `id` string — Internal identifier of a custom field - `value` string — Custom field value - `displayName` string - `departments` DepartmentInfo[] — Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology - `id` string, uri — Internal identifier of a department extension - `uri` string, uri — Canonical URI of an extension resource - `extensionNumber` string — Short number of a department extension - `extensionNumber` string — Extension short number - `extensionNumbers` string[] - `name` string — Extension name. For user extension types the value is a combination of the specified first name and last name - `partnerId` string — 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 - `permissions` ExtensionPermissions — Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling' - `admin` PermissionInfoAdmin — Admin permission - `enabled` boolean — Specifies if a permission is enabled or not - `internationalCalling` PermissionInfoInt — International Calling permission - `enabled` boolean — Specifies if a permission is enabled or not - `profileImage` ProfileImageInfo — Information on profile image - `uri` string, uri, required — Link to a profile image. If an image is not uploaded for an extension, only `uri` is returned - `etag` string — Identifier of an image - `lastModified` string, date-time — Date/time when an image was last updated, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z - `contentType` string — The type of image - `scales` ProfileImageInfoURI[] — List of URIs to profile images in different dimensions - `uri` string, uri - `references` ReferenceInfo[] — List of non-RC internal identifiers assigned to an extension - `ref` string — Non-RC identifier of an extension - `type` 'PartnerId' | 'CustomerDirectoryId' — Type of external identifier - `refAccId` string — Primary federation admin account identifier - `roles` Roles[] - `uri` string, uri — Link to a role - `id` string — Internal identifier of a role - `autoAssigned` boolean - `displayName` string - `siteCompatible` boolean - `siteRestricted` boolean - `regionalSettings` RegionalSettings — Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings - `homeCountry` CountryInfoShortModel - `id` string — Internal identifier of a country - `uri` string, uri — Canonical URI of a country resource - `name` string — The official name of a country - `isoCode` string — A ISO country code value complying with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. - `callingCode` string — Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T) recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and [E.164](http://en.wikipedia.org/wiki/E.164), see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes) - `timezone` TimezoneInfo — Extension timezone information - `id` string — Internal identifier of a timezone - `uri` string, uri — Canonical URI of a timezone - `name` string — Short name of a timezone - `description` string — Meaningful description of the timezone - `bias` string - `language` RegionalLanguageInfo — Information on a language set as regional - `id` string — Internal identifier of a language set as regional - `localeCode` string — Localization code of a language set as regional - `name` string — Official name of a language set as regional - `greetingLanguage` GreetingLanguageInfo — Information on language used for telephony greetings - `id` string — Internal identifier of a greeting language - `localeCode` string — Localization code of a greeting language - `name` string — Official name of a greeting language - `formattingLocale` FormattingLocaleInfo — Formatting language preferences for numbers, dates and currencies - `id` string — Internal identifier of a formatting language - `localeCode` string — Localization code of a formatting language - `name` string — Official name of a formatting language - `timeFormat` '12h' | '24h' — Time format setting. The default value is '12h' = ['12h', '24h'] - `serviceFeatures` ExtensionServiceFeatureInfo[] — Extension service features is returned in response only when the logged-in user requests their own extension info, see also Extension Service Features - `enabled` boolean — Feature status; shows feature availability for an extension - `featureName` 'AccountFederation' | 'Archiver' | 'AutomaticCallRecordingMute' | 'AutomaticInboundCallRecording' | 'AutomaticOutboundCallRecording' | 'BlockedMessageForwarding' | 'Calendar' | 'CallerIdControl' | 'CallForwarding' | 'CallPark' | 'CallParkLocations' | 'CallSupervision' | 'CallSwitch' | 'CallQualitySurvey' | 'Conferencing' | 'ConferencingNumber' | 'ConfigureDelegates' | 'DeveloperPortal' | 'DND' | 'DynamicConference' | 'EmergencyAddressAutoUpdate' | 'EmergencyCalling' | 'EncryptionAtRest' | 'ExternalDirectoryIntegration' | 'Fax' | 'FaxReceiving' | 'FreeSoftPhoneLines' | 'HDVoice' | 'HipaaCompliance' | 'Intercom' | 'InternationalCalling' | 'InternationalSMS' | 'LinkedSoftphoneLines' | 'MMS' | 'MobileVoipEmergencyCalling' | 'OnDemandCallRecording' | 'Pager' | 'PagerReceiving' | 'Paging' | 'PasswordAuth' | 'PromoMessage' | 'Reports' | 'Presence' | 'RCTeams' | 'RingOut' | 'SalesForce' | 'SharedLines' | 'SingleExtensionUI' | 'SiteCodes' | 'SMS' | 'SMSReceiving' | 'SoftPhoneUpdate' | 'TelephonySessions' | 'UserManagement' | 'VideoConferencing' | 'VoipCalling' | 'VoipCallingOnMobile' | 'Voicemail' | 'VoicemailToText' | 'WebPhone' — Feature name - `reason` string — Reason for limitation of a particular service feature. Returned only if the enabled parameter value is `false`, see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for limitations, if any, are returned in response - `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 - `statusInfo` ExtensionStatusInfo — Status information (reason, comment). Returned for 'Disabled' status only - `comment` string — A free-form user comment, describing the status change reason - `reason` 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily' — Type of suspension - `till` string, date-time — Date until which an account will get deleted. The default value is 30 days since the current date - `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 - `callQueueInfo` CallQueueExtensionInfo — For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology - `slaGoal` integer — Target percentage of calls that must be answered by agents within the service level time threshold - `slaThresholdSeconds` integer — Period of time in seconds that is considered to be an acceptable service level - `includeAbandonedCalls` boolean — If `true` abandoned calls (hanged up prior to being served) are included into service level calculation - `abandonedThresholdSeconds` integer — Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation - `hidden` boolean — Hides extension from showing in company directory. Supported for extensions of User type only - `site` ProvisioningSiteInfo — 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 (company) the site ID should be set to `main-site` - `id` string, uri — Internal identifier of a site - `uri` string, uri — Link to a site resource - `name` string — Name of a site - `code` string — Site code value. Returned only if specified - `assignedCountry` AssignedCountryInfo — Information on a country assigned to an extension user. Returned for the User extension type only - `id` string — Internal identifier of an assigned country - `uri` string — Canonical URI of an assigned country resource - `isoCode` string — Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) - `name` string — Official name of a country --- [API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)