Update user's licenses

The UPDATE /users/{userId}/licenses endpoint updates the licenses for the user matching the provided user ID.

In this page


Most URLs in the example code use the following values:

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Parameters

The endpoint accepts the following query parameter:

userID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The user ID of the required user.

Requests

Example request

curl -L -X PATCH "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/licenses" \
-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 licenseTypes object in JSON format as in the request body.

{
  "licenseTypes": {
    "analytics": "creator",
    "krispnoisecancellation": "none"
  }
}

where:

  • userId. The unique ID of the user.
  • licenseTypes. The license types assigned to the user.
    • analytics. The type of the analytics license. Possible values: creator, viewer, none.
    • krispnoisecancellation. The type of the krispnoisecancellation license. Possible values: enabled, none.

Responses

Successful response

Successful requests return a 200 Success code.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.