Email - Envio

Endpoint

Método Rota
POST /api/email/message/send

Parâmetros

{
    "to": "no-reply@seacweb.com",
    "cc": "marketing@seacweb.com",
    "bcc": "dev@seacweb.com",
    "subject": "Assunto do Email",
    "html": "html",
    "text": "Email de teste EasyChat",
    "attachments": [
        {
            "content": "base64",
            "filename": "Anexo.pdf"
        }
    ]
}
Campo Obrigatório Descrição
to Sim E-mail ou array de e-mails para que será enviado o e-mail
cc Não E-mail ou array de e-mails para que fique em cópia no e-mail
bcc Não E-mail ou array de e-mails para que fique em cópia oculta no e-mail
subject Sim Assunto do e-mail
html Sim Versão em HTML do e-mail a ser enviado
text Não Versão em texto puro do e-mail a ser enviado (aconselhável por questões de compatibilidade com alguns dispositivos ou clientes de e-mail)
attachments Não Anexos a serem enviados juntamente com o e-mail. Pode ser enviado um único arquivo binário ou array (com mesmo nome) ou um array de objetos contendo o conteúdo do anexo em Base64 (content) e o nome do arquivo (filename).

Sucesso

{success} Caso a requisição seja bem sucedida, a resposta terá a seguinte estrutura:

{
    "status": "success",
    "message": "Message successfully sent."
}
Campo Descrição
status Em caso de sucesso, irá sempre retornar success
message Mensagem de confirmação de que a requisição foi bem sucedida

Erro

{danger} Caso apresente alguma falha na requisição, a resposta terá a seguinte estrutura:

{
    "status": "error",
    "message": "Error message goes here."
}

Possíveis respostas de erro com respectivos códigos:

Código Erro
403 Não autenticado
404 Não encontrado, verifique se está utilizando o método e a rota corretos
422 Dados inválidos (uma tag errors acompanhará a resposta, relacionando os erros encontrados)
499 Saldo insuficiente para enviar mensagem
500 Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte

Demo