Receber e-mails: Rascunhos
Salvar rascunho
Salve um e-mail em Rascunhos sem enviá-lo. Ele abre no webmail como qualquer outro rascunho, e você pode enviá-lo depois com send_draft.
https://g.sendcorex.com/v1command: save_draftUm rascunho pode estar incompleto: todos os campos são opcionais. O que você envia é verificado (um to que não é e-mail falha), o que você deixa de fora, não.
Para editar um rascunho, envie o draft_id dele. Os campos que você deixar de fora são mantidos (corpo, destinatários, assunto, anexos, follow-up). Cada salvamento retorna um NOVO draft_id e o antigo para de funcionar, então guarde sempre o último.
Se track_opens ou track_clicks for omitido, o rascunho mantém a escolha que já tinha. O send_draft e o envio agendado usam essa escolha.
Destinatários que recusaram o rastreamento na página de preferências nunca são rastreados, mesmo com true.
Argumentos
draft_idstringopcionalEdita este rascunho em vez de criar um novo.
modestringopcionalnew(padrão),replyouforward. Na edição, o rascunho mantém o modo.idstringopcionalA mensagem original, para
replyeforward. O assunto padrão é Re: / Fwd: original.tostring | string[]opcionalDestinatário, ou uma lista de até 30 para
new(planos pagos). Ignorado emreply: vai para o remetente do original.ccstring[]opcionalCópias visíveis.
bccstring[]opcionalCópias ocultas.
subjectstringopcionalAssunto.
htmlstringopcionalCorpo HTML. Ou
text, outemplate_id.textstringopcionalCorpo em texto simples, transformado em HTML simples.
template_idstringopcionalPreenche o corpo (e o assunto) a partir de um template.
variablesobjectopcionalValores para as variáveis do template, como
{ "first_name": "Ana" }.followup_after_hoursnumber | nullopcionalLembra você se ninguém responder em tantas horas após o envio (até 8760).
nullremove o lembrete.attachmentsobject[]opcionalArquivos a anexar:
[{ file_name, content, content_type }],contentem base64. São adicionados aos arquivos que o rascunho já tem.compose_uidstringopcionalArquivos enviados antes com
upload_attachmentou Upload de arquivo grande.attachment_idsstring[]opcionalQuais dos arquivos enviados usar. Sem ele, todos.
track_opensbooleanopcionalRastreia quando cada destinatário abre o e-mail (pixel invisível). Padrão
true.track_clicksbooleanopcionalRastreia cliques nos links (cada link passa por um redirecionamento). Padrão
true.unsubscribebooleanopcionalAdiciona um link de descadastro. Coloque
[unsubscribe]no corpo (nohrefde um link ou como texto) onde o link deve ficar; sem ele, uma linha padrão é adicionada no fim. Padrãofalse.audiencestringopcionalEnvia para um público em vez de endereços:
subscribed,opened,clicked,both,seg:<segment_id>oumsg:<message_uid>:opened|clicked|not_opened. Otofica opcional. Até 5.000 pessoas. O link de descadastro é ligado e o email sai como marketing. Planos pagos.
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "save_draft",
args: {
to: "ana@client.com",
subject: "Proposal",
html: "<p>Hi Ana, here is the proposal.</p>"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);
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": "save_draft",
"id": "0",
"type": "SUCCESS",
"data": {
"draft_id": "Vj0xRFJBRlQx",
"thread_id": "thr_9a1c4e72"
}
}
]
}Campos da resposta
draft_idO rascunho. Use-o para editar, ler, enviar ou excluir. Muda a cada salvamento.
thread_idA conversa à qual o rascunho pertence.
Editar um rascunho
Aqui só o assunto muda. O corpo, os destinatários e os anexos ficam como estavam.
Body da requisição
{
"commands": [
{
"command": "save_draft",
"args": {
"draft_id": "Vj0xRFJBRlQx",
"subject": "Proposal (v2)"
}
}
]
}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
TOKEN_EXPIREDO access token expirou. Chame Refresh Token e repita a requisição.
- 401
INVALID_TOKENO token está malformado, é desconhecido ou foi revogado.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.
- CMD
INVALID_AUDIENCEO público não é válido: grupo desconhecido, segmento de outra caixa ou mensagem que esta caixa não enviou.
- CMD
INVALID_ARGSUm argumento obrigatório está ausente ou é inválido.
- CMD
PAID_PLAN_REQUIREDMais de um endereço em `to` exige um plano pago.
- CMD
TOO_MANY_RECIPIENTS`to` tem mais de 30 endereços.
- CMD
DRAFT_NOT_FOUNDO rascunho não existe mais: foi enviado, excluído ou salvo de novo (cada salvamento retorna um novo draft_id).
- CMD
MISSING_TARGETReply e forward precisam do e-mail original, e ele ainda precisa existir.
- CMD
INVALID_RECIPIENTO destinatário está ausente ou não é um e-mail válido.
- CMD
INVALID_CCADDRESSUm dos endereços cc não é um e-mail válido.
- CMD
INVALID_BCCADDRESSUm dos endereços bcc não é um e-mail válido.
- CMD
RECIPIENT_LIMIT_EXCEEDEDto, cc e bcc juntos têm mais de 50 endereços.
- CMD
INVALID_ATTACHMENTO conteúdo de um anexo não é base64 válido.
- CMD
FILE_BLOCKEDUm arquivo foi bloqueado pela verificação de segurança.
- CMD
ATTACHMENTS_TOO_LARGEOs anexos do e-mail somam mais de 25 MB, ou a caixa de correio já tem 500 MB de uploads aguardando envio.
- CMD
ATTACHMENT_MISSINGUm anexo enviado não existe mais (uploads não enviados em 48 horas, e não usados por um rascunho ou e-mail agendado, são excluídos). Envie-o de novo.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.