Attach a document

POST /api/2.0/mail/messages/{id:[0-9]+}/document

Request

Attaches a document to the message with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

Message ID

fileIdstring

Document ID

versionstring

Document version

needSaveToTempboolean

Specifies if this document needs to be saved to a template message or not

Examples

POST /api/2.0/mail/messages/%7Bid:[0-9]+%7D/document HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url 'https://example.com/api/2.0/mail/messages/%7Bid:[0-9]+%7D/document' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Attached document

fileIdintegerformat: int32

fileNamestring

sizeintegerformat: int64

contentTypestring

needSaveToTempboolean

contentIdstring

fileNumberintegerformat: int32

storedNamestring

streamIdstring

attachedAsLinkboolean

tempStoredUrlstring

401

Unauthorized