Receive Emails: Contacts & audience

Delete Segment

Deletes a segment of this mailbox.

POSThttps://g.sendcorex.com/v1command: delete_segment
i

Needs the organize permission (not available to read-only tokens).

Arguments

  • segment_idstringrequired

    The segment id.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "delete_segment",
        args: {
          segment_id: "seg_8Hq2"
        }
      }
    ]
  },
  { 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_segment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "deleted": true
      }
    }
  ]
}

Response fields

  • deleted

    true when it was deleted.

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.

  • CMDNOT_FOUND

    The message, thread or folder does not exist for this token.

  • CMDREAD_ONLY_ACCESS

    The token or app has Read only access and the command writes. In the attachment upload route it is HTTP 403.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.