Export message attachments

PUT /api/2.0/mail/messages/attachments/export

Request

Exports all the message attachments to the folder with documents.

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

id_messageinteger

Message ID

id_folderstring

Folder ID (if this parameter is empty, the "My documents" folder is used)

Examples

PUT /api/2.0/mail/messages/attachments/export HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/mail/messages/attachments/export \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Number of attachments exported

401

Unauthorized