Skip to content
vocapable.Docs

Remove someone from the company and hand their work to a teammate

POST
/v1/workspace/team/people/{user_id}/offboard
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/team/people/example/offboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reassign_to_user_id": "example", "reason": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceOffboardRequest
object
reassign_to_user_id
required
Reassign To User Id
string
>= 1 characters <= 64 characters
reason
Any of:
string
<= 500 characters
Examplegenerated
{
  "reassign_to_user_id": "example",
  "reason": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceOffboardResult
object
user_id
required
User Id
string
reassigned_to
required
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
organizations
required
Organizations
integer
contacts
required
Contacts
integer
opportunities
required
Opportunities
integer
tasks
required
Tasks
integer
handoffs
required
Handoffs
integer
cases
required
Cases
integer
meetings
required
Meetings
integer
installations
required
Installations
integer
workflows
required
Workflows
integer
reservations_released
required
Reservations Released
integer
routing_drafts_updated
required
Routing Drafts Updated
integer
live_routing_needs_republish
required
Live Routing Needs Republish
boolean
access_revoked
required
Access Revoked
boolean
Examplegenerated
{
  "user_id": "example",
  "reassigned_to": {
    "user_id": "example",
    "name": "example"
  },
  "organizations": 1,
  "contacts": 1,
  "opportunities": 1,
  "tasks": 1,
  "handoffs": 1,
  "cases": 1,
  "meetings": 1,
  "installations": 1,
  "workflows": 1,
  "reservations_released": 1,
  "routing_drafts_updated": 1,
  "live_routing_needs_republish": true,
  "access_revoked": true
}

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