Skip to content

Declare the caller available until a selected expiry

PUT
/v1/mobile/availability/me
curl --request PUT \
--url https://api.vocapable.com/v1/mobile/availability/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "available_until": "2026-04-15T12:00:00Z" }'
Media typeapplication/json
MobileAvailabilitySetRequest

Set the caller’s own availability until one explicit UTC instant.

object
available_until
required
Available Until
string format: date-time
Examplegenerated
{
"available_until": "2026-04-15T12:00:00Z"
}

Successful Response

Media typeapplication/json
MobileAvailabilityWindow

The privacy-minimized state shown in the mobile team view.

object
membership_id
required
Membership Id
string
rep_id
required
Rep Id
string
status
required
Status
string
Allowed values: available ended expired
available
required
Available
boolean
available_until
Any of:
string format: date-time
declared_at
Any of:
string format: date-time
ended_at
Any of:
string format: date-time
updated_at
Any of:
string format: date-time
Example
{
"status": "available"
}

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