Skip to content
vocapable.Docs

Ask a manager to review why calling this customer is held

POST
/v1/workspace/calls/hold-reviews
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/calls/hold-reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contact_id": "example" }'

A review request never grants calling or messaging permission: it creates an owned review task and a timeline entry, and the contact stays held until the evidence changes.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceHoldReviewRequest
object
contact_id
required
Contact Id
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "contact_id": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceTask
object
id
required
Id
string
kind
required
Kind
string
Allowed values: follow_up callback delivery review case_response meeting_prep
title
required
Title
string
organization_id
required
Any of:
string
contact_id
required
Any of:
string
opportunity_id
required
Any of:
string
subject_type
required
Any of:
string
Allowed values: handoff case meeting approval call quote
subject_id
required
Any of:
string
owner
required
Any of:
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
due_at
required
Any of:
string format: date-time
status
required
Status
string
Allowed values: open done cancelled
completed_at
required
Any of:
string format: date-time
completed_by_user_id
required
Any of:
string
completion_note
required
Any of:
string
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "kind": "follow_up",
  "subject_type": "handoff",
  "status": "open"
}

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