Skip to content
vocapable.Docs

Add an internal note, or save a customer reply for review

POST
/v1/workspace/cases/{case_id}/comments
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/cases/example/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "visibility": "internal", "body": "example" }'

An internal comment stays inside the company. A customer reply is NOT sent here: it becomes a reply awaiting review, sent only after approval through the inbox path.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
case_id
required
Case Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCaseCommentCreate
object
visibility
required
Visibility
string
Allowed values: internal customer
body
required
Body
string
>= 1 characters <= 1600 characters

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceCase
object
id
required
Id
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
contact_id
required
Any of:
string
contact_name
required
Any of:
string
source_type
required
Any of:
string
Allowed values: call message caller_request conversation manual
source_id
required
Any of:
string
title
required
Title
string
summary
required
Any of:
string
urgency
required
Urgency
string
Allowed values: low normal high urgent
owner
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
team
required
Any of:
string
status
required
Status
string
Allowed values: draft triaged assigned acknowledged waiting_customer waiting_internal resolved reopened
response_due_at
required
Any of:
string format: date-time
response_overdue
required
Response Overdue
boolean
acknowledged_at
required
Any of:
string format: date-time
escalated_at
required
Any of:
string format: date-time
resolution
required
Any of:
string
resolved_at
required
Any of:
string format: date-time
resolved_by
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
reopened_at
required
Any of:
string format: date-time
created_by
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
comments
required
Comments
Array<object>
WorkspaceCaseComment
object
id
required
Id
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
visibility
required
Visibility
string
Allowed values: internal customer
body
required
Body
string
delivery_state
required
Any of:
string
Allowed values: pending sent delivered failed
reply
required
Any of:
WorkspaceReply

A reply to a customer: drafted, reviewed as an exact version, then sent once.

object
id
required
Id
string
contact_id
required
Any of:
string
case_id
required
Any of:
string
channel
required
Channel
string
Allowed values: sms email
body
required
Body
string
state
required
State
string
Allowed values: draft pending_review changes_requested declined approved sending provider_accepted delivered failed uncertain scheduled canceled
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
approval
required
Any of:
WorkspaceReplyApproval
object
id
required
Id
string
status
required
Status
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
reviewer
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
decided_by
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
reason
required
Any of:
string
revision
required
Revision
integer
to_address
required
Any of:
string
from_address
required
Any of:
string
provider_status
required
Any of:
string
error
required
Any of:
string
sent_at
required
Any of:
string format: date-time
delivered_at
required
Any of:
string format: date-time
can_edit
required
Can Edit
boolean
can_review
required
Can Review
boolean
can_send
required
Can Send
boolean
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
origin
required
Origin
string
Allowed values: reply compose recap
send_basis
required
Send Basis
string
Allowed values: review trusted_role
purpose
required
Any of:
string
Allowed values: informational marketing
scheduled_for
required
Any of:
string format: date-time
media
required
Media
Array<object>
WorkspaceMessageMedia
object
id
required
Id
string
content_type
required
Content Type
string
size_bytes
required
Any of:
integer
status
required
Status
string
Allowed values: pending stored failed
can_cancel
required
Can Cancel
boolean
created_at
required
Created At
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
source_call
Any of:
WorkspaceCaseSourceCall

The call a case was opened from (PRD E10-R6), so its recording and transcript are one tap from the case. Present on a case’s detail only.

kind=workspace: a call your team made or answered - call_id is the conversation’s first row, which the recording (/calls/{id}/recording) and transcript (/calls/{id}/transcript) routes take; may_open says whether THIS viewer may open them (a handler of the call, or recording_access), and only then are recording and transcript filled. kind=ai_receptionist: the AI receptionist’s call (open it from the activity record).

object
kind
required
Kind
string
Allowed values: workspace ai_receptionist
call_id
required
Call Id
string
started_at
required
Any of:
string format: date-time
direction
required
Any of:
string
handler
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
may_open
required
May Open
boolean
recording
required
Any of:
string
Allowed values: available saving deleted none
transcript
required
Any of:
string
Allowed values: available none
Example
{
  "source_type": "call",
  "urgency": "low",
  "status": "draft",
  "comments": [
    {
      "visibility": "internal",
      "delivery_state": "pending",
      "reply": {
        "channel": "sms",
        "state": "draft",
        "approval": {
          "status": "awaiting_review"
        },
        "origin": "reply",
        "send_basis": "review",
        "purpose": "informational",
        "media": [
          {
            "status": "pending"
          }
        ]
      }
    }
  ],
  "source_call": {
    "kind": "workspace",
    "recording": "available",
    "transcript": "available"
  }
}

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