Remove folder messages

DELETE /api/2.0/mail/folders/{folderid:[0-9]+}/messages

Request

Removes all the messages from the trash or spam folder.

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

folderidinteger

Folder ID: 4 - Trash, 5 - Spam

Examples

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

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

Responses

200

Folder ID

401

Unauthorized