Contactos: listas

Crear lista

Crea una lista. Elige tu propio id para que tu código pueda referirse a ella, o deja que el servidor genere uno.

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

Necesita el scope contact:create en tu API key.

i

Una lista agrupa contactos para enviar. El contacto en sí pertenece a la cuenta: añadirlo a una lista no lo copia.

Argumentos

  • list_idstringopcional

    Tu propio id: a-z, 0-9, _ y -, hasta 40 caracteres. Se genera si se omite. Un id que ya existe falla con ALREADY_EXISTS.

    p. ej. "customers"

  • namestringopcional

    Nombre visible.

    p. ej. "Customers"

  • descriptionstringopcional

    Texto libre que se muestra con la lista.

  • sourcestringopcional

    De dónde vienen los contactos, como referencia.

    p. ej. "checkout"

  • customobjectopcional

    Tus propios datos, hasta 50 claves.

    p. ej. { "origin": "checkout", "year": 2026 }

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "create_list",
        args: {
          list_id: "customers",
          name: "Customers",
          description: "Everyone who bought at least once",
          source: "checkout",
          custom: {
            origin: "checkout",
            year: 2026
          }
        }
      }
    ]
  },
  { 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": "create_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "list_id": "customers",
        "name": "Customers",
        "description": "Everyone who bought at least once",
        "source": "checkout",
        "status": "ready",
        "custom": {
          "origin": "checkout",
          "year": 2026
        },
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-12T15:22:41.000Z",
        "stats": {
          "total": 0,
          "ok": 0,
          "opened": 0,
          "clicked": 0
        }
      }
    }
  ]
}

Campos de la respuesta

  • list_id

    El id que enviaste o el generado.

  • status

    ready.

  • stats

    Contadores, todos en 0 para una lista nueva.

Siguiente paso: llenarla

Envía list_id con Upsert Contacts para importar directamente a la lista, o usa Add To Lists para contactos que ya tienes.

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…

  • CMDALREADY_EXISTS

    Se llamó a create_list con un list_id que ya existe.

  • CMDINTERNAL

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