Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RingCentral

RingCentral Automatic Location Updates API

The Automatic Location Updates API from RingCentral — 21 operation(s) for automatic location updates.

Provider Profile APIs.io OpenAPI GitHub

RingCentral Automatic Location Updates API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automatic Location Updates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 36 operations across 21 paths, and defines 80 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.

36 operations 21 paths 80 schemas 5 DELETE13 GET13 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

RingCentral Automatic Location Updates 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 36

Across 21 paths, the API surfaces 36 operations — 5 DELETE, 13 GET, 13 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Automatic Location Updates 36
GET
/restapi/v1.0/account/{accountId}/emergency-locations
List Emergency Locations
listEmergencyLocations 9 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-locations
Add Emergency Location
createEmergencyLocation 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-locations/{locationId}
Get Emergency Location
readEmergencyLocation 3 params → 200
PUT
/restapi/v1.0/account/{accountId}/emergency-locations/{locationId}
Update Emergency Location
updateEmergencyLocation 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/emergency-locations/{locationId}
Delete Emergency Location
deleteEmergencyLocation 4 params → 200204207
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations
List User Emergency Locations
getExtensionEmergencyLocations 9 params → 200
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations
Create User Emergency Location
createExtensionEmergencyLocation 2 params body → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId}
Update User Emergency Location
updateExtensionEmergencyLocation 3 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId}
Delete User Emergency Location
deleteExtensionEmergencyLocation 4 params → 204
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId}
Get User Emergency Location
getExtensionEmergencyLocation 3 params → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/tasks/{taskId}
Get Emergency Map Configuration Task
readAutomaticLocationUpdatesTask 2 params → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/users
List Users
listAutomaticLocationUpdatesUsers 9 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/users/bulk-assign
Enable Automatic Location Updates for Users
assignMultipleAutomaticLocationUpdatesUsers 1 param body → 204
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create
Create Multiple Wireless Points
createMultipleWirelessPoints 1 param body → 202
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks
Get Network Map
listNetworks 6 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks
Create Network
createNetwork 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
Get Network
readNetwork 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
Update Network
updateNetwork 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
Delete Network
deleteNetwork 2 params → 204
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-validate
Validate Multiple Switches
validateMultipleSwitches 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches
List Account Switches
listAccountSwitches 6 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches
Create Switch
createSwitch 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
Get Switch
readSwitch 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
Update Switch
updateSwitch 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
Delete Switch
deleteSwitch 2 params → 204
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate
Validate Multiple Wireless Points
validateMultipleWirelessPoints 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points
List Wireless Points
listWirelessPoints 6 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points
Create Wireless Point
createWirelessPoint 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
Get Wireless Point
readWirelessPoint 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
Update Wireless Point
updateWirelessPoint 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
Delete Wireless Point
deleteWirelessPoint 2 params → 204
GET
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices
List Devices
listDevicesAutomaticLocationUpdates 9 params → 200
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices/bulk-assign
Enable Automatic Location Updates Feature
assignMultipleDevicesAutomaticLocationUpdates 1 param body → 204
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-create
Create Multiple Switches
createMultipleSwitches 1 param body → 202
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update
Update Multiple Wireless Points
updateMultipleWirelessPoints 1 param body → 202
POST
/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-update
Update Multiple Switches
updateMultipleSwitches 1 param body → 202

Schemas 80

The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are CommonEmergencyLocationAddressInfoAu (17 properties), CommonEmergencyLocationAddressInfoFr (16 properties), LocationUpdatesEmergencyAddressInfoRequest (13 properties), CommonEmergencyLocationAddressInfoDefault (13 properties). Each schema is shown below with its type and property counts.

ShortSiteInfo
object
2 properties
LocationDeletionInfo
object
4 properties
ValidateMultipleSwitchesRequest
object
1 property
UpdateMultipleSwitchesRequest
object
1 property
PageNavigationUri
object
1 property
EmergencyAddressType
string
AutomaticLocationUpdatesPhoneNumberInfo
object
2 properties
EmergencyAddressAutoUpdateSiteInfo
object
2 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
EmergencyAddressStatus
string
UpdateMultipleSwitchesResponse
object
1 property
SwitchInfo
object
8 properties
AutomaticLocationUpdatesDeviceType
string
Device type
CreateWirelessPoint
object
5 properties 2 required
AutomaticLocationUpdatesModelFeature
string
UpdateMultipleWirelessPointsRequest
object
1 property
CreateMultipleWirelessPointsRequest
object
1 property
CreateMultipleSwitchesResponse
object
Information on a task for multiple switches creation
1 property
AutomaticLocationUpdatesPhoneLineType
string
SwitchSiteInfo
object
2 properties
EmergencyAddressAutoUpdateUsersBulkAssignResource
object
2 properties
CommonEmergencyLocationAddressInfoAu
object
17 properties
AssignMultipleDevicesAutomaticLocationUpdates
object
2 properties
WirelessPointValidated
object
4 properties
NetworksList
object
4 properties
PrivateIpRangeInfo
object
8 properties
ListDevicesAutomaticLocationUpdates
object
4 properties
SwitchValidated
object
5 properties
PublicIpRangeInfo
object
4 properties
LocationDeletionErrorInfo
object
3 properties
ValidateMultipleSwitchesResponse
object
1 property
SyncStatus
string
Resulting status of emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true
EmergencyLocationRequestResource
EmergencyLocationInfoRequest
object
8 properties
TaskResultRecordErrorsInfo
object
4 properties
ValidationError
object
3 properties
CreateMultipleWirelessPointsResponse
object
1 property
CreateSwitchInfo
object
6 properties 1 required
AddressStatus
string
Emergency address status
EnumeratedPagingModel
object
6 properties 1 required
Visibility
string
Visibility of an emergency response location. If Private is set, then location is visible only for the restricted number of users, specified in owners array
SwitchesList
object
3 properties
EmergencyLocationResponseResource
CommonEmergencyLocationAddressInfo
LocationUpdatesEmergencyAddressInfoRequest
object
Emergency address assigned to the switch. Only one of a pair emergencyAddress or emergencyLocationId should be specified, otherwise the error is returned
13 properties
BulkTaskInfo
object
4 properties
AutomaticLocationUpdatesDeviceInfo
object
8 properties
EmergencyLocationInfo
object
Emergency response location information
3 properties 1 required
AutomaticLocationUpdatesUserInfo
object
7 properties
CommonEmergencyLocationResource
object
Company emergency response location details
11 properties
TaskResultRecord
object
6 properties
EmergencyAddressInfo
PrivateIpRangeInfoRequest
object
7 properties
CreateMultipleSwitchesRequest
object
1 property
UpdateNetworkRequest
object
5 properties 3 required
AutomaticLocationUpdatesTaskInfo
object
6 properties
UpdateMultipleWirelessPointsResponse
object
1 property
ERLLocationInfo
object
Emergency response location information
3 properties
CreateNetworkRequest
object
4 properties 3 required
ValidateMultipleWirelessPointsResponse
object
1 property
EmergencyLocationUsageStatus
string
AutomaticLocationUpdatesSiteInfo
object
Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (compa…
4 properties
ValidateMultipleWirelessPointsRequest
object
1 property
UpdateSwitchInfo
object
6 properties
LocationOwnerInfo
object
3 properties
AutomaticLocationUpdatesUserList
object
4 properties
EmergencyLocationsResource
object
2 properties
EmergencyLocationsPaging
object
6 properties 6 required
TaskResultInfo
object
Task detailed result. Returned for failed and completed tasks
1 property
CommonEmergencyLocationAddressInfoFr
object
16 properties
CreateUserEmergencyLocationRequest
object
4 properties
NetworkInfo
object
6 properties
WirelessPointsList
object
4 properties
GetLocationDeletionMultiResponse
object
3 properties
WirelessPointInfo
object
8 properties 3 required
CommonEmergencyLocationAddressInfoDefault
object
13 properties
UsageStatus
string
Status of emergency response location usage.
AutomaticLocationUpdatesPhoneLine
object
2 properties
UpdateWirelessPoint
object
5 properties
AutomaticLocationUpdatesModelInfo
object
HardPhone model information
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-automatic-location-updates-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
AE Profile APIs.io
RingCentral Team Messaging API
AE Profile APIs.io
RingCentral Video API
AE Profile APIs.io
RingCentral Fax API
AE Profile APIs.io
RingCentral Data API
AE Profile APIs.io
RingCentral Audio and Video AI API
AE Profile APIs.io
RingCentral Call Log API
AE Profile APIs.io
RingCentral Call Analytics API
AE Profile APIs.io
RingCentral Presence API
AE Profile APIs.io
RingCentral Voicemail API
AE Profile APIs.io
RingCentral Provisioning API
AE Profile APIs.io
RingCentral Webhooks and Subscriptions API
AE Profile APIs.io
#Automatic Location Updates
← Back to R APIs
API Details
ID
ringcentral:ringcentral-automatic-location-updates-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network