Skip to content
vocapable.Docs

Set or remove skills for many people (CC7-R3)

POST
/v1/workspace/contact-center/agents/skills/bulk
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/agents/skills/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_ids": [ "example" ], "skills": [ { "skill_id": "example", "proficiency": 1 } ], "remove_skill_ids": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcAgentSkillsBulk

CC7-R3: set skill levels and/or remove skills for many people at once (their other skills are untouched). A team lead may do it for their team subtree (web and phone).

object
user_ids
required
User Ids
Array<string>
>= 1 items <= 500 items
skills
Skills
Array<object>
<= 50 items
CcAgentSkillSet
object
skill_id
required
Skill Id
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
proficiency
required
Proficiency
integer
>= 1 <= 5
remove_skill_ids
Remove Skill Ids
Array<string>
<= 50 items
Examplegenerated
{
  "user_ids": [
    "example"
  ],
  "skills": [
    {
      "skill_id": "example",
      "proficiency": 1
    }
  ],
  "remove_skill_ids": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcAgentSkillsBulkResults
object
changed
required
Changed
integer
unchanged
required
Unchanged
integer
refused
required
Refused
integer
results
required
Results
Array<object>
CcAgentSkillsBulkResult
object
user_id
required
User Id
string
outcome
required
Outcome
string
Allowed values: changed unchanged refused
reason
Any of:
string
agents
required
Agents
Array<object>
CcAgent
object
user_id
required
User Id
string
name
required
Name
string
role
required
Role
string
revision
required
Revision
integer
skills
required
Skills
Array<object>
CcAgentSkill
object
skill_id
required
Skill Id
string
name
required
Name
string
proficiency
required
Proficiency
integer
>= 1 <= 5
queues
required
Queues
Array<object>
CcAgentQueue
object
id
required
Id
string
name
required
Name
string
priority
Priority
integer
default: 5
Example
{
  "results": [
    {
      "outcome": "changed"
    }
  ],
  "agents": [
    {
      "queues": [
        {
          "priority": 5
        }
      ]
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}