Contatos: listas

Adicionar a listas

Coloque até 500 contatos existentes em uma ou mais listas, inscritos.

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

Precisa do scope contact:update na sua API key.

i

Toda lista precisa existir. Se uma não existir, o comando inteiro falha com NOT_FOUND antes de qualquer contato ser alterado. Contatos que não existem falham no próprio item.

Argumentos

  • emailsstring[]opcional

    Até 500 emails. Maiúsculas e espaços nas pontas são ignorados, e emails repetidos contam uma vez.

  • emailstringopcional

    Um único email. Use este ou emails.

  • list_idsstring[]obrigatório

    As listas em que entrar.

    ex.: ["customers", "newsletter"]

  • list_idstringopcional

    Uma única lista. Use este ou list_ids.

  • return_contactsbooleanopcional

    Adiciona o contato inteiro após a alteração a cada item.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "add_to_lists",
        args: {
          emails: [
            "ana@acme.com"
          ],
          list_ids: [
            "customers",
            "newsletter"
          ]
        }
      }
    ]
  },
  { 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": "add_to_lists",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Campos da resposta

  • items[].id

    O email que você enviou, como você enviou.

  • items[].ok

    true quando este email funcionou. Quando false, o item tem code e message.

  • items[].data.changed

    false quando o contato já estava em todas essas listas.

  • items[].data.contact

    O contato inteiro após a alteração. Só com return_contacts: true.

  • ok_count / failed_count

    Quantos emails funcionaram e quantos falharam.

Contatos novos

Add To Lists só funciona com contatos que existem. Para criar e adicionar em um passo, use Upsert Contacts com list_id.

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.