Skip to content
vocapable.Docs

A customer's email: synced mail you may see, email replies, sending mailboxes

GET
/v1/workspace/inbox/threads/{contact_id}/email
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/inbox/threads/example/email \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
contact_id
required
Contact Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceEmailConversation
object
contact_id
required
Contact Id
string
email_addresses
required
Email Addresses
Array<string>
mailboxes
required
Mailboxes
Array<object>
WorkspaceSendingMailbox

A mailbox this person may send a reviewed reply from, and the identity it sends as.

object
installation_id
required
Installation Id
string
provider
required
Provider
string
Allowed values: gmail outlook
mailbox
required
Mailbox
string
address
required
Address
string
visibility
required
Visibility
string
Allowed values: private team
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
messages
required
Messages
Array<object>
WorkspaceMailMessage

Metadata of one synced message (no body is ever stored).

object
id
required
Id
string
installation_id
required
Installation Id
string
provider
required
Provider
string
Allowed values: gmail outlook
direction
required
Direction
string
Allowed values: inbound outbound
from_address
required
Any of:
string
to_addresses
required
To Addresses
Array<string>
subject
required
Any of:
string
snippet
required
Any of:
string
received_at
required
Any of:
string format: date-time
thread_id
required
Any of:
string
replies
required
Replies
Array<object>
WorkspaceEmailReply
object
reply
required
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
subject
required
Any of:
string
installation_id
required
Any of:
string
mailbox
required
Any of:
string
reply_to_mail_id
required
Any of:
string
operation_status
required
Any of:
string
held_reason
required
Any of:
string
delivery_note
required
Delivery Note
string
sending
required
WorkspaceEmailSendAvailability
object
available
required
Available
boolean
code
required
Code
string
Allowed values: available no_mailbox mailbox_not_active no_address do_not_contact
requirement
required
Any of:
string
policy
required
WorkspacePolicySummary

The current contact-policy answer for the viewing person, on one channel.

object
channel
required
Channel
string
Allowed values: voice sms email
allowed
required
Allowed
boolean
holds
required
Holds
Array<object>
WorkspacePolicyHold
object
code
required
Code
string
Allowed values: do_not_contact owned_by_teammate owner_unassigned device_not_ready not_available no_address contact_review_needed ai_consent_missing callback_scheduled timezone_unknown outside_local_window frequency_cap_reached service_not_entitled spend_cap_reached
message
required
Message
string
recovery
required
Recovery
string
recipient_local_time
required
Any of:
string format: date-time
window_opens_at
required
Any of:
string format: date-time
evaluated_at
required
Evaluated At
string format: date-time
policy_version
required
Policy Version
string
window_start_local
Any of:
string format: time
window_end_local
Any of:
string format: time
window_jurisdictions
Window Jurisdictions
Array<string>
frequency_cap
Any of:
integer
frequency_cap_period_hours
Any of:
integer
cap_clears_at
Any of:
string format: date-time
rules_version
Any of:
string
delivery_note
required
Delivery Note
string
Example
{
  "mailboxes": [
    {
      "provider": "gmail",
      "visibility": "private"
    }
  ],
  "messages": [
    {
      "provider": "gmail",
      "direction": "inbound"
    }
  ],
  "replies": [
    {
      "reply": {
        "channel": "sms",
        "state": "draft",
        "approval": {
          "status": "awaiting_review"
        },
        "origin": "reply",
        "send_basis": "review",
        "purpose": "informational",
        "media": [
          {
            "status": "pending"
          }
        ]
      }
    }
  ],
  "sending": {
    "code": "available"
  },
  "policy": {
    "channel": "voice",
    "holds": [
      {
        "code": "do_not_contact"
      }
    ]
  }
}

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