Skip to content
vocapable.Docs

Draft feedback, assign practice, or ask for help

POST
/v1/workspace/coaching
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/coaching \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "feedback", "subject_user_id": "example", "call_id": "example", "body": "example", "scenario_pack_id": "example", "scenario_version": 1, "scenario_source_index": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCoachingCreate
object
kind
required
Kind
string
Allowed values: feedback practice help_request
subject_user_id
Any of:
string
<= 64 characters
call_id
Any of:
string
<= 64 characters
body
required
Body
string
>= 1 characters <= 8000 characters
scenario_pack_id
Any of:
string
<= 64 characters
scenario_version
Any of:
integer
>= 1
scenario_source_index
Any of:
integer

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceCoachingItem
object
id
required
Id
string
subject
required
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
author
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
kind
required
Kind
string
Allowed values: suggested_review feedback practice help_request
status
required
Status
string
Allowed values: suggested assigned draft shared acknowledged practice_completed disputed corrected
body
required
Any of:
string
call
required
Any of:
WorkspaceCoachingCall
object
id
required
Id
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
direction
required
Direction
string
outcome
required
Any of:
string
notes
required
Any of:
string
next_step
required
Any of:
string
ended_at
required
Any of:
string format: date-time
recording_available
required
Any of:
boolean
scenario
required
Any of:
WorkspacePracticeScenario

An approved answer from company knowledge, used as a practice scenario.

object
pack_id
required
Pack Id
string
pack_name
required
Pack Name
string
version
required
Version
integer
source_index
required
Source Index
integer
label
required
Label
string
text
required
Text
string
reason
required
Any of:
string
response
required
Any of:
string
responded_at
required
Any of:
string format: date-time
shared_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
actions
required
Actions
Array<string>
Allowed values: share acknowledge dispute correct complete_practice resolve_help mark_reviewed
Example
{
  "kind": "suggested_review",
  "status": "suggested",
  "actions": [
    "share"
  ]
}

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