Contatos: listas
Remover de listas
Tire até 500 contatos de uma ou mais listas. Eles deixam de ser membros; nada mais muda neles.
https://g.sendcorex.com/v1/contactscommand: remove_from_listsPrecisa do scope contact:update na sua API key.
Quando alguém se descadastra de uma lista, prefira Set List Subscription com subscribed: false: a pessoa continua na lista como descadastrada, e você mantém o registro de que ela saiu.
Argumentos
emailsstring[]opcionalAté 500 emails. Maiúsculas e espaços nas pontas são ignorados, e emails repetidos contam uma vez.
emailstringopcionalUm único email. Use este ou
emails.list_idsstring[]obrigatórioAs listas de que sair.
ex.:
["leads"]list_idstringopcionalUma única lista. Use este ou
list_ids.return_contactsbooleanopcionalAdiciona 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: "remove_from_lists",
args: {
emails: [
"ana@acme.com"
],
list_ids: [
"leads"
]
}
}
]
},
{ 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": "remove_from_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[].idO email que você enviou, como você enviou.
items[].oktruequando este email funcionou. Quandofalse, o item temcodeemessage.items[].data.changedfalsequando o contato não estava em nenhuma dessas listas.items[].data.contactO contato inteiro após a alteração. Só com
return_contacts: true.ok_count / failed_countQuantos emails funcionaram e quantos falharam.
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
NOT_FOUNDO contato, a lista, o campo ou o segmento não existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.