Receive Emails: Newsletters

List Unsubscribed

The lists you unsubscribed from.

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

Arguments

  • limitnumberoptional

    1 to 100. Defaults to 25.

  • cursorstringoptional

    The next_cursor of the previous page.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "list_unsubscribed",
        args: {
          limit: 25
        }
      }
    ]
  },
  { 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": "list_unsubscribed",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "lists": [
          {
            "list_key": "news.shop.com",
            "list_id": "Shop News <news.shop.com>",
            "from_email": "news@shop.com",
            "from_name": "Shop News",
            "method": "one_click",
            "target": "https://shop.com/u/abc",
            "status": "done",
            "http_status": 200,
            "message_uid": "Vj0xQUJDMTIz",
            "attempts": 1,
            "unsubscribed_at": "2026-10-26T01:00:00Z",
            "updated_at": "2026-10-26T01:00:00Z"
          }
        ],
        "has_more": false,
        "next_cursor": null
      }
    }
  ]
}

Response fields

  • lists[].unsubscribed_at

    When you first asked. Emails after this date mean the list ignored the request.

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.

  • CMDINVALID_CURSOR

    The cursor is malformed or belongs to another account or folder.

  • CMDINTERNAL

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