Contatos: campos personalizados

Excluir campo

Exclua um campo personalizado. Ele some na hora, e seus valores são removidos de todos os contatos em segundo plano.

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

Precisa do scope contact:delete na sua API key.

!

Os valores não podem ser recuperados. Segmentos e consultas que usam o campo passam a falhar com INVALID_ARGS imediatamente.

Argumentos

  • keystringobrigatório

    O campo a excluir.

    ex.: "vip"

Início 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);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "delete_field",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "deleted": true,
        "purging": true
      }
    }
  ]
}

Campos da resposta

  • deleted

    true. O campo não aparece mais em List Fields.

  • purging

    true enquanto os valores estão sendo removidos dos contatos.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDNOT_FOUND

    O contato, a lista, o campo ou o segmento não existe.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.