Receive Emails: Rules

Get Rule

One rule with its conditions, exceptions and actions.

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

Arguments

  • idstringrequired

    The rule_id.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_rule",
        args: {
          id: "Vj0xUlVMRTAx"
        }
      }
    ]
  },
  { 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": "get_rule",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "id": "Vj0xUlVMRTAx",
        "rule_id": "Vj0xUlVMRTAx",
        "name": "Clients always in Inbox",
        "match": "all",
        "conditions": [
          {
            "field": "from_domain",
            "op": "in_list",
            "value": "acme.com, globex.com"
          },
          {
            "field": "provider",
            "op": "is_any_of",
            "value": [
              "microsoft_365",
              "google_workspace"
            ]
          }
        ],
        "except": [
          {
            "field": "subject",
            "op": "contains",
            "value": "newsletter"
          }
        ],
        "actions": [
          {
            "type": "keep_inbox"
          },
          {
            "type": "label",
            "value": "Clients"
          },
          {
            "type": "star"
          }
        ],
        "stop": false,
        "timezone": "Asia/Kuala_Lumpur",
        "enabled": true,
        "position": 0,
        "hits": 128,
        "last_hit_at": "2026-10-25T09:12:44Z",
        "created_at": "2026-10-01T02:00:00Z",
        "updated_at": "2026-10-20T08:30:00Z"
      }
    }
  ]
}

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.