Skip to content
vocapable.Docs

Apply one change to many members

POST
/v1/workspace/people/bulk
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/people/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "membership_ids": [ "example" ], "action": "set_role", "role": "manager", "custom_role_id": "example", "team_id": "example", "skills": { "additionalProperty": 1 }, "remove_skill_ids": [ "example" ], "queue_id": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspacePeopleBulkEdit
object
membership_ids
required
Membership Ids
Array<string>
>= 1 items <= 500 items
action
required
Action
string
Allowed values: set_role set_custom_role add_to_team remove_from_team set_primary_team deactivate reactivate set_skills add_to_queue remove_from_queue
role
Any of:
string
Allowed values: manager rep
custom_role_id
Any of:
string
<= 64 characters
team_id
Any of:
string
<= 64 characters
skills
Skills
object
<= 50 properties
key
additional properties
integer
>= 1 <= 5
remove_skill_ids
Remove Skill Ids
Array<string>
<= 50 items
queue_id
Any of:
string
<= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePeopleBulkResults
object
action
required
Action
string
Allowed values: set_role set_custom_role add_to_team remove_from_team set_primary_team deactivate reactivate set_skills add_to_queue remove_from_queue
changed
required
Changed
integer
unchanged
required
Unchanged
integer
refused
required
Refused
integer
results
required
Results
Array<object>
WorkspacePeopleBulkResult
object
membership_id
required
Membership Id
string
outcome
required
Outcome
string
Allowed values: changed unchanged refused
reason
required
Any of:
string
Example
{
  "action": "set_role",
  "results": [
    {
      "outcome": "changed"
    }
  ]
}

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": {}
    }
  ]
}