Skip to content
vocapable.Docs

Connect this company to the Vocapable account manager who invited you

POST
/v1/customer-invites/claim
curl --request POST \
  --url https://api.vocapable.com/v1/customer-invites/claim \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Link this company to the sales account, once. Grants nothing.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CustomerInviteToken
object
token
required
Token
string
>= 1 characters <= 128 characters
Examplegenerated
{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CustomerInvitePreview
object
business_name
required
Business Name
string
invited_by
required
Invited By
string
email_hint
required
Email Hint
string
claimed_here
required
Claimed Here
boolean
blocker
required
Any of:
string
Examplegenerated
{
  "business_name": "example",
  "invited_by": "example",
  "email_hint": "example",
  "claimed_here": true,
  "blocker": "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": {}
    }
  ]
}