Recibir correos: Contactos y público

Listar segmentos

Lista los segmentos guardados de este buzón, con los campos personalizados y los totales. Solo lectura.

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

Argumentos

Este endpoint no recibe argumentos.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "list_segments"
      }
    ]
  },
  { 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);

Respuesta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "list_segments",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segments": [
          {
            "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"
          }
        ],
        "fields": [
          {
            "key": "plan",
            "name": "Plan",
            "type": "enum",
            "options": [
              "free",
              "pro"
            ]
          }
        ],
        "stats": {
          "total": 1240
        }
      }
    }
  ]
}

Campos de la respuesta

  • segments[]

    segment_id, name, where, sort, created_at y updated_at.

  • fields

    Campos personalizados de la cuenta. Se crean en el dashboard.

  • stats

    Totales de contactos de este buzón.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.