Contactos: segmentos

Guardar segmento

Guarda una consulta con un nombre, para que tu aplicación y el dashboard puedan ejecutarla después. Los contactos no se copian: el segmento se vuelve a evaluar cada vez que se ejecuta.

POSThttps://g.sendcorex.com/v1/contactscommand: save_segment
i

Necesita el scope contact:create en tu API key.

i

El where se valida al guardar: una clave o campo desconocido falla con INVALID_ARGS ahora, no en la siguiente ejecución.

Argumentos

  • segment_idstringopcional

    Tu propio id. Se genera si se omite. Guardar con un id que ya existe reemplaza ese segmento.

    p. ej. "engaged-vips"

  • namestringopcional

    Nombre visible.

    p. ej. "Engaged VIPs"

  • whereobjectobligatorio

    El mismo where que Query Contacts.

  • sortstring | objectopcional

    El mismo sort que Query Contacts.

    p. ej. "open_rate"

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          segment_id: "engaged-vips",
          name: "Engaged VIPs",
          where: {
            tags: {
              has: "vip"
            },
            last_open_at: {
              within_days: 30
            }
          },
          sort: "open_rate"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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": "save_segment",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segment_id": "engaged-vips",
        "name": "Engaged VIPs",
        "where": {
          "tags": {
            "has": "vip"
          },
          "last_open_at": {
            "within_days": 30
          }
        },
        "sort": {
          "field": "open_rate"
        },
        "created_at": "2026-10-10T12:00:00.000Z",
        "updated_at": "2026-10-10T12:00:00.000Z"
      }
    }
  ]
}

Campos de la respuesta

  • (segment)

    El segmento tal como quedó guardado.

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.

  • 401INVALID_API_KEY

    La API key no existe, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…

  • CMDINTERNAL

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