Contactos: campos personalizados

Definir campo

Crea un campo personalizado, o cámbiale el nombre y las opciones. Cada campo tiene su propio índice, así que puedes filtrar y ordenar por él de inmediato.

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

Necesita el scope contact:create en tu API key.

i

Llamarlo otra vez con el mismo key y type actualiza el nombre y las opciones. El tipo nunca cambia: intentarlo falla con TYPE_LOCKED. Para cambiarlo, elimina el campo y créalo de nuevo.

Argumentos

  • keystringobligatorio

    a-z, 0-9 y _, empezando por una letra, hasta 40 caracteres.

    p. ej. "plan"

  • typestringobligatorio

    text, number, date, bool, enum o multi_enum.

    p. ej. "enum"

  • namestringopcional

    Nombre visible. Por defecto, la clave.

    p. ej. "Plan"

  • optionsstring[]opcional

    Obligatorio para enum y multi_enum: los valores permitidos.

    p. ej. ["free", "pro", "business"]

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "define_field",
        args: {
          key: "plan",
          name: "Plan",
          type: "enum",
          options: [
            "free",
            "pro",
            "business"
          ]
        }
      }
    ]
  },
  { 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": "define_field",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "key": "plan",
        "name": "Plan",
        "type": "enum",
        "options": [
          "free",
          "pro",
          "business"
        ],
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-01T10:00:00.000Z"
      }
    }
  ]
}

Campos de la respuesta

  • (field)

    El campo tal como quedó guardado: key, name, type, options, created_at, updated_at.

Tipos

  • text

    Hasta 2.000 caracteres. Filtra por igualdad (ignorando mayúsculas y acentos), contains o exists.

  • number

    Enteros o decimales, negativos incluidos. "1234,5" se lee como 1234.5. Rangos y ordenación.

  • date

    YYYY-MM-DD o ISO. Rangos y ordenación.

  • bool

    true o false. "yes", "sim" y "1" se leen como verdadero.

  • enum

    Una de las options. "PRO" se guarda como "pro". Un valor fuera de las opciones hace fallar el elemento.

  • multi_enum

    Cualquier cantidad de options, como lista o como "tech, golf". No se puede usar para ordenar.

Configura todos tus campos de una vez

Cuerpo de la petición

{
  "commands": [
    {
      "command": "define_field",
      "args": {
        "key": "plan",
        "name": "Plan",
        "type": "enum",
        "options": [
          "free",
          "pro",
          "business"
        ]
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "age",
        "name": "Age",
        "type": "number"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "city",
        "name": "City",
        "type": "text"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "birthday",
        "name": "Birthday",
        "type": "date"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "interests",
        "name": "Interests",
        "type": "multi_enum",
        "options": [
          "golf",
          "tech",
          "travel"
        ]
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "vip",
        "name": "VIP",
        "type": "bool"
      }
    }
  ]
}
i

Una cuenta puede tener hasta 100 campos. Pasado ese límite, define_field falla con LIMIT_REACHED.

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…

  • CMDTYPE_LOCKED

    define_field intentó cambiar el tipo de un campo existente. Elimínalo y créalo de nuevo.

  • CMDLIMIT_REACHED

    La cuenta ya tiene 100 campos personalizados.

  • CMDINTERNAL

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