Skip to main content
POST
Upload an attachment

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

conversationId
string
required

Query Parameters

name
string
required

The file name.

Body

application/octet-stream

The body is of type file.

Response

The staged attachment

id
string
name
string
mimeType
string
sizeBytes
integer
status
string

pending until a message binds the attachment; bound attachments carry the message's lifecycle.

direction
enum<string>

inbound = the person's message; outbound = the agent's reply.

Available options:
inbound,
outbound
caption
string | null
createdAt
string<date-time>