Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The PUT /skills/{skillId}/users endpoint replaces the users who have the skill that matches the skill ID provided.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#7ec9f4
borderStylesolid
titleIn this page

Table of Contents

Request parameters

Query parameters

The endpoint accepts the following query parameters:

Insert excerpt
_ExcerptAPICloudNextGen
_ExcerptAPICloudNextGen
nopaneltrue

Headers

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

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Parameters

skillID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The skill ID of the required skill.

Requests

Example Request

Code Block
languagepowershell
themeMidnight
curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/skills/8e22b1fe-d2ea-403d-8c03-50eb21188e79/users" \
-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 a users object in JSON format as in the request body.

Tip

This endpoint replaces the skills linked users.

  • To add a new user, you must request the current user list and append the new user Id and level. 
  • To remove a user, you must request the current user list and remove the target user Id from the list.

Example request body

Code Block
languagejs
themeMidnight
{
  "users": [
    {
      "userId": "85e4de21-30a0-4a37-88e1-1484c6183a50",
      "agentSkillLevel": 65
    }
  ]
}

where:

  • userIDThe unique ID of the user with the skill.
  • agentSkillLevelThe skill level of the agent with the skill.

Responses

Successful response

Successful requests return a 200 Success code.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue