Contatos: listas
Excluir lista
Exclua uma lista. Ela some na hora; os membros são retirados dela em segundo plano. Os contatos em si são mantidos.
https://g.sendcorex.com/v1/contactscommand: delete_listPrecisa do scope contact:delete na sua API key.
Só a participação é removida. Os contatos, suas tags, campos e outras listas continuam. Para excluir as pessoas também, consulte-as primeiro e use Delete Contacts.
Argumentos
list_idstringobrigatórioA lista a excluir.
ex.:
"old-leads"
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "delete_list",
args: {
list_id: "old-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": "delete_list",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true,
"purging": true
}
}
]
}Campos da resposta
deletedtrue. A lista não aparece mais em List Lists nem em Get List.purgingtrueenquanto os membros estão sendo retirados da lista em segundo plano.
O que acontece em segundo plano
Listas grandes são limpas em lotes. Até terminar, list_lists com include_deleting: true ainda mostra a lista com status: "deleting".
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.