Pular para o conteúdo principal
POST
Enviar um e-mail registrado

Corpo

userSecurityToken
string
obrigatório

Seu token de segurança.

name
string
obrigatório

Nome do destinatário.

email
string<email>
obrigatório
subject
string
obrigatório
msg
string

Corpo em HTML. Obrigatório se não houver anexo.

attachment
file

Máx. 10 MB. Tipos comuns de documento/imagem permitidos (PDF, Office, imagens, texto, ZIP). PDFs com senha são rejeitados. Exige multipart/form-data.

name_sender
string

Usa os dados do seu perfil quando omitido.

reply_to
string<email>

Usa o endereço de resposta padrão do seu perfil e, na falta dele, o e-mail da conta. Endereços inválidos são rejeitados com 400.

tag
string

Etiqueta opcional para organizar seus pedidos. Gravada normalizada: minúsculas, sem acento, e tudo que não for a-z ou 0-9 vira hífen ("Cobrança Março" → "cobranca-marco"). Use o valor gravado para filtrar as listas de pedidos.

test
string
padrão:0

Modo de validação. Aceita 1/true/yes/on para validar sem criar o pedido (o preço calculado é devolvido) e 0/false/no/off para enviar de verdade. QUALQUER outro valor é recusado com 400 — antes ele caía num pedido real e cobrável.

paymentMethod
enum<string>
padrão:escrybe_credits

invoice exige um plano que permita faturamento.

Opções disponíveis:
escrybe_credits,
invoice,
team
team_member_id
integer

Obrigatório quando paymentMethod=team. NÃO é o id do time: é o id da SUA participação naquele time (team_members.id), diferente para cada membro. Obtenha em GET /api/v2/teams ou no painel (Times → "ID para a API"). O dono do time também tem o seu. Um valor que não seja uma participação sua responde 403.

Resposta

E-mail aceito

Mesmo envelope padrão dos endpoints de cartas.

status
integer
Exemplo:

200

status_message
string
data
object