Skip to content
vocapable.Docs

Record that this company saved the prepared business information

POST
/v1/setup-handoffs/{handoff_id}/accept
curl --request POST \
  --url https://api.vocapable.com/v1/setup-handoffs/example/accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "knowledge_pack_id": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
handoff_id
required
Handoff Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SetupHandoffAccept
object
knowledge_pack_id
required
Knowledge Pack Id
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "knowledge_pack_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SetupHandoffOffer
object
id
required
Id
string
business_name
required
Business Name
string
prepared_by
required
Prepared By
string
facts
required
Facts
Array<object>
SetupHandoffFact
object
label
required
Label
string
text
required
Text
string
source_url
required
Source Url
string
evidence
required
Evidence
string
use_case
required
Use Case
string
scope
required
Any of:
string
status
required
Status
string
Examplegenerated
{
  "id": "example",
  "business_name": "example",
  "prepared_by": "example",
  "facts": [
    {
      "label": "example",
      "text": "example",
      "source_url": "example",
      "evidence": "example"
    }
  ],
  "use_case": "example",
  "scope": "example",
  "status": "example"
}

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