Receive Emails: Contacts & audience

Save Segment

Creates or updates a segment of this mailbox.

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

A segment belongs to one mailbox. To use it in another mailbox, save a copy there.

i

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

Arguments

  • segment_idstringoptional

    Leave it out to create a new segment.

  • namestringrequired

    Up to 200 characters.

  • whereobjectrequired

    The filter. Same format as list_contacts.

  • sortobjectoptional

    { field }: email, created_at, last_open_at, last_click_at, open_count or click_count.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          name: "Opened in 30 days",
          where: {
            last_open_at: {
              within_days: 30
            }
          }
        }
      }
    ]
  },
  { 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": "save_segment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segment": {
          "segment_id": "seg_8Hq2",
          "name": "Opened in 30 days",
          "where": {
            "last_open_at": {
              "within_days": 30
            }
          },
          "sort": null,
          "created_at": "2026-11-21T10:00:00Z",
          "updated_at": "2026-11-21T10:00:00Z"
        }
      }
    }
  ]
}

Response fields

  • segment

    The saved segment.

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.

  • 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.