POST
/
v1
/
attachments

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

draft_id
string
message_id
string
is_inline
boolean
required

Body

multipart/form-data
file
string
required

Response

200 - application/json
content_id
string

Applicable to Email messages with inline attachments. Corresponds to the Content-ID (CID) of an inline image or other attachment displayed within the message content. For instance, an inline image might be referenced in the HTML message body as <img src="cid:image01.png">. In this example, the content_id would be 'image01.png'.

content_type
string
required

MIME type of the attachment (e.g., image/png, application/pdf).

conversation_id
string
required

Conversation ID of the conversation the attachment belongs to..

draft_id
string

Draft ID of the draft the attachment belongs to. Either this or message_id must be provided, but not both.

filename
string
required

Original filename of the attachment.

id
string
required

Unique identifier of the attachment.

is_inline
boolean
required

Only applies to Email messages. Indicates if the attachment is displayed inline (using CID) within the message content or as a regular attachment.

message_id
string

Message ID of the message the attachment belongs to. Either this or draft_id must be provided, but not both.

size
integer
required

Size of the attachment in bytes.