Skip to content
vocapable.Docs

Save your private notes on a live call

PATCH
/v1/workspace/calls/{call_id}/notes
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/calls/example/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "text": "example", "tags": [ "quote_requested" ], "expected_revision": 1 }'

Replaces the text and tags. expected_revision is the revision this client last saw (omit only for the first save); a save from another device meanwhile answers 409 stale_revision.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
call_id
required
Call Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCallNotesSave

The whole note as it stands now (text and tags replace what was saved).

object
text
required
Text
string
<= 5000 characters
tags
Tags
Array<string>
<= 4 items
Allowed values: quote_requested emergency complaint wrong_number
expected_revision
Any of:
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallNotes

The handler’s private notes while a call lives (PRD E8-R2): kept on the server so they survive the app being closed and follow the person to another device. They feed the wrap-up and are discarded when it is saved.

object
call_id
required
Call Id
string
text
required
Text
string
tags
required
Tags
Array<string>
Allowed values: quote_requested emergency complaint wrong_number
revision
required
Revision
integer
updated_at
required
Updated At
string format: date-time
Example
{
  "tags": [
    "quote_requested"
  ]
}

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