Contatos: tags, status e campos
Definir status
Altere o status global de até 500 contatos: descadastre, bloqueie ou recadastre em todas as listas de uma vez.
https://g.sendcorex.com/v1/contactscommand: set_statusPrecisa do scope contact:update na sua API key.
O status é global. Um contato que não está subscribed não recebe envios em nenhuma lista, mesmo que ainda esteja inscrito nela. Para sair de uma única lista, use Set List Subscription.
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.statusstringobrigatóriosubscribed,unsubscribed,bounced,complainedoublocked.ex.:
"unsubscribed"reasonstringopcionalPor que o status mudou. Fica salvo em
status_reason.ex.:
"asked by email"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: "set_status",
args: {
emails: [
"bob@gmail.com"
],
status: "unsubscribed",
reason: "asked by email"
}
}
]
},
{ 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": "set_status",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "bob@gmail.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.changedfalsesignifica que o contato já estava assim, então nada foi gravado.items[].data.contactO contato inteiro após a alteração. Só com
return_contacts: true.ok_count / failed_countQuantos emails funcionaram e quantos falharam.
Status
subscribedPode receber emails das listas em que está inscrito.
unsubscribedPediu para não receber mais emails.
bouncedO endereço não aceita emails.
complainedMarcou um dos seus emails como spam.
blockedBloqueado por você. Use para endereços que você nunca quer contatar.
Voltar para subscribed alguém que se descadastrou ou reclamou só deve acontecer quando a pessoa pediu.
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.