Replace user's address permissions
The PUT
/users/{userId}/permissions/addresses
endpoint replaces the user’s address permissions for the user matching the user ID provided.
In this page
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.cc.vonage.com USA nam https://nam.api.cc.vonage.com APAC apac https://apac.api.cc.vonage.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:write | Entire endpoint |
Parameters
userID
Type | Required | Example |
---|---|---|
String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
Requests
Example Request
curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/addresses" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>"
Request body parameters
The endpoint requires an addressPermissions
object in JSON format as in the request body.
Example request body
{ "addressPermissions": [ { "addressId": "1d75b21f-6d94-4477-9ba7-513a30bfc21d", "addressName": "Main line" }, { "addressId": "fd6e3099-8673-4b11-865b-2e15ec80911a", "addressName": "Callback line" } ] }
where:
addressPermissions
. The user’s address permissions.addressId
. The unique ID of the address that the user has access to.addressName
. The name the address that the user has access to.
Responses
Successful response
Successful requests return a 200 Success
code.
Try it out
For information, see Trying out Vonage Contact Center APIs.