Receive Emails: Contacts & audience

Check Recipients

Tells which recipients unsubscribed from this mailbox. Read only.

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

Arguments

  • emailsstring[]required

    1 to 100 addresses.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "check_recipients",
        args: {
          emails: [
            "ana@empresa.com",
            "joao@empresa.com"
          ]
        }
      }
    ]
  },
  { 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": "check_recipients",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "recipients": [
          {
            "email": "ana@empresa.com",
            "subscribed": true,
            "unsubscribed_at": null
          },
          {
            "email": "joao@empresa.com",
            "subscribed": false,
            "unsubscribed_at": "2026-11-02T14:10:00Z"
          }
        ]
      }
    }
  ]
}

Response fields

  • recipients[]

    email, subscribed and unsubscribed_at.

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.

  • CMDINTERNAL

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