Contactos: campos personalizados

Listar campos

Todos los campos personalizados de la cuenta, con su tipo y opciones, ordenados por clave.

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

Necesita el scope contact:read en tu API key.

Argumentos

Este endpoint no recibe argumentos.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_fields"
      }
    ]
  },
  { 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": "list_fields",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "fields": [
          {
            "key": "age",
            "name": "Age",
            "type": "number",
            "options": null,
            "created_at": "2026-10-01T10:00:00.000Z",
            "updated_at": "2026-10-01T10:00:00.000Z"
          },
          {
            "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"
          }
        ],
        "limit": 100
      }
    }
  ]
}

Campos de la respuesta

  • fields[].key

    La clave usada en fields, en where y en sort (fields.<key>).

  • fields[].name

    Nombre visible.

  • fields[].type

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

  • fields[].options

    Los valores permitidos de los campos enum y multi_enum.

  • limit

    Cuántos campos puede tener la cuenta (100).

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.

  • CMDINTERNAL

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