Skip to content
vocapable.Docs

Reserve a customer immediately before calling or messaging them

POST
/v1/workspace/reservations
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/reservations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contact_id": "example", "purpose": "call", "channel": "sms", "seconds": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceReservationRequest
object
contact_id
required
Contact Id
string
purpose
required
Purpose
string
Allowed values: call message
channel
Any of:
string
Allowed values: sms email
seconds
Any of:
integer
>= 15 <= 900

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceReservation

A short server-owned lease on a customer, taken immediately before acting.

object
id
required
Id
string
subject_type
required
Subject Type
string
Allowed value: contact
subject_id
required
Subject Id
string
holder
required
WorkspaceReservationHolder
object
kind
required
Kind
string
Allowed values: human ai
user_id
required
Any of:
string
name
required
Name
string
purpose
required
Purpose
string
Allowed values: call message
acquired_at
required
Acquired At
string format: date-time
expires_at
required
Expires At
string format: date-time
released_at
required
Any of:
string format: date-time
release_reason
required
Any of:
string
Allowed values: completed cancelled expired abandoned superseded failed
policy
required
Any of:
WorkspacePolicySummary

The current contact-policy answer for the viewing person, on one channel.

object
channel
required
Channel
string
Allowed values: voice sms email
allowed
required
Allowed
boolean
holds
required
Holds
Array<object>
WorkspacePolicyHold
object
code
required
Code
string
Allowed values: do_not_contact owned_by_teammate owner_unassigned device_not_ready not_available no_address contact_review_needed ai_consent_missing callback_scheduled timezone_unknown outside_local_window frequency_cap_reached service_not_entitled spend_cap_reached
message
required
Message
string
recovery
required
Recovery
string
recipient_local_time
required
Any of:
string format: date-time
window_opens_at
required
Any of:
string format: date-time
evaluated_at
required
Evaluated At
string format: date-time
policy_version
required
Policy Version
string
window_start_local
Any of:
string format: time
window_end_local
Any of:
string format: time
window_jurisdictions
Window Jurisdictions
Array<string>
frequency_cap
Any of:
integer
frequency_cap_period_hours
Any of:
integer
cap_clears_at
Any of:
string format: date-time
rules_version
Any of:
string
Example
{
  "subject_type": "contact",
  "holder": {
    "kind": "human"
  },
  "purpose": "call",
  "release_reason": "completed",
  "policy": {
    "channel": "voice",
    "holds": [
      {
        "code": "do_not_contact"
      }
    ]
  }
}

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