Skip to content
vocapable.Docs

Approve, send back or decline

POST
/v1/workspace/inbox/replies/{message_id}/review
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/inbox/replies/example/review \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "decision": "approve", "reason": "example", "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
message_id
required
Message Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceReplyReview
object
decision
required
Decision
string
Allowed values: approve request_changes decline
reason
Any of:
string
<= 1000 characters
expected_revision
required
Expected Revision
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
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
Example
{
  "channel": "sms",
  "state": "draft",
  "approval": {
    "status": "awaiting_review"
  },
  "origin": "reply",
  "send_basis": "review",
  "purpose": "informational",
  "media": [
    {
      "status": "pending"
    }
  ]
}

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