Receive Emails: Folders & counters

Delete Folder

Delete a custom folder. Only the folder record is removed: the messages inside it are kept.

POSThttps://g.sendcorex.com/v1command: delete_folder

The messages that are in the folder stay where they are. Move them to another folder first if you still want to see them in a listing.

Arguments

folderstringrequired
The slug of the folder to delete.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "delete_folder",
        args: {
          folder: "projeto-x"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "delete_folder",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "folder": "projeto-x",
        "deleted": true
      }
    }
  ]
}

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

401TOKEN_EXPIRED
The access token has expired. Call Refresh Token and repeat the request.
401INVALID_TOKEN
The token is malformed, unknown or revoked.
429RATE_LIMITED
More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.
CMDINVALID_ARGS
A required argument is missing or invalid.
CMDNOT_FOUND
The message, thread or folder does not exist for this token.
CMDINTERNAL
Server error. The detail is only written to the server log.