Contatos: listas

Criar lista

Crie uma lista. Escolha seu próprio id para o seu código poder referenciá-la, ou deixe o servidor gerar um.

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

Precisa do scope contact:create na sua API key.

i

Uma lista agrupa contatos para envio. O contato em si pertence à conta: adicioná-lo a uma lista não o duplica.

Argumentos

  • list_idstringopcional

    Seu próprio id: a-z, 0-9, _ e -, até 40 caracteres. Gerado quando omitido. Um id que já existe falha com ALREADY_EXISTS.

    ex.: "customers"

  • namestringopcional

    Nome de exibição.

    ex.: "Customers"

  • descriptionstringopcional

    Texto livre exibido com a lista.

  • sourcestringopcional

    De onde vieram os contatos, para sua referência.

    ex.: "checkout"

  • customobjectopcional

    Seus próprios dados, até 50 chaves.

    ex.: { "origin": "checkout", "year": 2026 }

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "create_list",
        args: {
          list_id: "customers",
          name: "Customers",
          description: "Everyone who bought at least once",
          source: "checkout",
          custom: {
            origin: "checkout",
            year: 2026
          }
        }
      }
    ]
  },
  { 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": "create_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "list_id": "customers",
        "name": "Customers",
        "description": "Everyone who bought at least once",
        "source": "checkout",
        "status": "ready",
        "custom": {
          "origin": "checkout",
          "year": 2026
        },
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-12T15:22:41.000Z",
        "stats": {
          "total": 0,
          "ok": 0,
          "opened": 0,
          "clicked": 0
        }
      }
    }
  ]
}

Campos da resposta

  • list_id

    O id que você enviou ou o que foi gerado.

  • status

    ready.

  • stats

    Contadores, todos 0 para uma lista nova.

Próximo passo: preenchê-la

Envie list_id com Upsert Contacts para importar direto na lista, ou use Add To Lists para contatos que você já tem.

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…

  • CMDALREADY_EXISTS

    create_list foi chamado com um list_id que já existe.

  • CMDINTERNAL

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