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.
https://g.sendcorex.com/v1/contactscommand: create_listPrecisa do scope contact:create na sua API key.
Uma lista agrupa contatos para envio. O contato em si pertence à conta: adicioná-lo a uma lista não o duplica.
Argumentos
list_idstringopcionalSeu próprio id:
a-z,0-9,_e-, até 40 caracteres. Gerado quando omitido. Um id que já existe falha comALREADY_EXISTS.ex.:
"customers"namestringopcionalNome de exibição.
ex.:
"Customers"descriptionstringopcionalTexto livre exibido com a lista.
sourcestringopcionalDe onde vieram os contatos, para sua referência.
ex.:
"checkout"customobjectopcionalSeus 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_idO id que você enviou ou o que foi gerado.
statusready.statsContadores, todos
0para 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.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INVALID_ARGSUm argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…
- CMD
ALREADY_EXISTScreate_list foi chamado com um list_id que já existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.