Skip to content
vocapable.Docs

Create Ticket

POST
/v1/support/tickets
curl --request POST \
  --url 'https://api.vocapable.com/v1/support/tickets?company_id=example' \
  --header 'Content-Type: application/json' \
  --cookie __Host-vcp-session=<__Host-vcp-session> \
  --data '{ "request_key": "example", "subject": "example", "body": "example", "priority": "critical" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
company_id
required
Company Id
string
>= 1 characters <= 100 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SupportCreate
object
request_key
required
Request Key
string
>= 8 characters <= 100 characters /^[A-Za-z0-9_-]+$/
subject
required
Subject
string
>= 1 characters <= 200 characters
body
required
Body
string
>= 1 characters <= 4000 characters
priority
Priority
string
default: normal
Allowed values: critical high normal low

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
SupportDetail
object
ticket
required
SupportTicket
object
id
required
Id
string
subject
required
Subject
string
preview
required
Preview
string
status
required
Status
string
Allowed values: open waiting_customer resolved
priority
required
Priority
string
Allowed values: critical high normal low
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
source
required
Source
string
Allowed values: customer_portal staff ai_call
customer
required
Any of:
SupportCompany
object
id
required
Id
string
name
required
Name
string
customer_identity
required
Customer Identity
string
Allowed values: verified_session staff_linked unverified
assignee
required
Any of:
SupportAssignee
object
staff_user_id
required
Staff User Id
string
display_name
required
Display Name
string
source_call_id
required
Any of:
string
source_company_id
required
Any of:
string
body
required
Body
string
messages
required
Messages
Array<object>
SupportMessage
object
id
required
Id
string
body
required
Body
string
author
required
Author
string
Allowed values: customer support
created_at
required
Created At
string format: date-time
setup_context
Any of:
PaidSetupSupportContext
object
schema_version
Schema Version
integer
default: 1
Allowed value: 1
company_id
required
Company Id
string
request_key
required
Request Key
string
request_sha256
required
Request Sha256
string
/^[a-f0-9]{64}$/
captured_at
required
Captured At
string format: date-time
captured_by
required
Captured By
string
topic
required
Topic
string
Allowed values: setup payment phone business_answers voice call_checks live_changes other
agent_id
required
Agent Id
string
agent_name
required
Agent Name
string
product
required
Product
string
Allowed values: engage workforce sales receptionist
phase
required
Phase
string
setup_revision
required
Setup Revision
integer
>= 1
draft_updated_at
required
Any of:
string format: date-time
saved_draft_matches
required
Saved Draft Matches
boolean
phone
Any of:
SetupSupportPhone
object
id
required
Id
string
status
required
Status
string
mode
required
Mode
string
Allowed values: managed byo
route_mode
required
Any of:
string
routes_to_this_agent
required
Routes To This Agent
boolean
serving
Any of:
SetupSupportServing
object
id
required
Id
string
version
required
Version
integer
status
required
Any of:
string
original_activation_version_id
Any of:
string
edit_id
Any of:
string
edit_base_version_id
Any of:
string
edit_base_still_serving
Any of:
boolean
restored_from_version_id
Any of:
string
qualification_job
Any of:
SetupSupportJob
object
id
required
Id
string
status
required
Status
string
step
required
Step
string
issue_code
required
Any of:
string
updated_at
required
Updated At
string format: date-time
live_release_count
required
Live Release Count
integer
application_id
required
Application Id
string
order_id
required
Order Id
string
order_status
required
Order Status
string
Allowed value: settled
Example
{
  "ticket": {
    "status": "open",
    "priority": "critical",
    "source": "customer_portal",
    "customer_identity": "verified_session"
  },
  "messages": [
    {
      "author": "customer"
    }
  ],
  "setup_context": {
    "schema_version": 1,
    "topic": "setup",
    "product": "engage",
    "phone": {
      "mode": "managed"
    },
    "order_status": "settled"
  }
}

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