Skip to content
vocapable.Docs

Declare your availability

PUT
/v1/workspace/me/presence
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/me/presence \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "state": "available", "reason": "example", "until": "2026-04-15T12:00:00Z", "expected_revision": 1 }'

Declared presence only. It is not device readiness and never proves reachability: routing still requires a fresh ready device check. In a contact-center company the toggle obeys the agent state machine (CC2-R1: e.g. not while on a call - choose a next status instead), exactly like the status control.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspacePresenceUpdate
object
state
required
State
string
Allowed values: available away offline
reason
Any of:
string
<= 120 characters
until
Any of:
string format: date-time
expected_revision
Any of:
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePresence
object
user_id
required
User Id
string
state
required
State
string
Allowed values: available away offline
reason
required
Any of:
string
until
required
Any of:
string format: date-time
revision
required
Revision
integer
updated_at
required
Updated At
string format: date-time
Example
{
  "state": "available"
}

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