Suggest reviews from finished calls (notes are enough; no recording needed)

POST

/v1/workspace/coaching/suggestions

curl --request POST \
  --url https://api.vocapable.com/v1/workspace/coaching/suggestions \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Responses

200

Successful Response

Media typeapplication/json

WorkspaceCoachingSuggestionsResult

object

created

required

Created

integer

items

required

Items

Array<object>

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

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

null

null

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

string

null

null

call

required

Any of:

WorkspaceCoachingCall

WorkspaceCoachingCall

object

id

required

Id

string

organization_id

required

Any of:

string

string

null

null

organization_name

required

Any of:

string

string

null

null

direction

required

Direction

string

outcome

required

Any of:

string

string

null

null

notes

required

Any of:

string

string

null

null

next_step

required

Any of:

string

string

null

null

ended_at

required

Any of:

string

string format: date-time

null

null

recording_available

required

Any of:

boolean

boolean

null

null

null

null

scenario

required

Any of:

WorkspacePracticeScenario

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

null

null

reason

required

Any of:

string

string

null

null

response

required

Any of:

string

string

null

null

responded_at

required

Any of:

string

string format: date-time

null

null

shared_at

required

Any of:

string

string format: date-time

null

null

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

{
  "items": [
    {
      "kind": "suggested_review",
      "status": "suggested",
      "actions": [
        "share"
      ]
    }
  ]
}