Contactos: campos personalizados

Eliminar campo

Elimina un campo personalizado. Desaparece al instante y sus valores se quitan de todos los contactos en segundo plano.

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

Necesita el scope contact:delete en tu API key.

!

Los valores no se pueden recuperar. Los segmentos y consultas que usan el campo empiezan a fallar con INVALID_ARGS de inmediato.

Argumentos

  • keystringobligatorio

    El campo que se elimina.

    p. ej. "vip"

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "delete_field",
        args: {
          key: "vip"
        }
      }
    ]
  },
  { 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": "delete_field",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "deleted": true,
        "purging": true
      }
    }
  ]
}

Campos de la respuesta

  • deleted

    true. El campo ya no aparece en List Fields.

  • purging

    true mientras se quitan los valores de los contactos.

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…

  • CMDNOT_FOUND

    El contacto, la lista, el campo o el segmento no existe.

  • CMDINTERNAL

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