Pré-requisito:
- Criando um Remetente de E-mail
A criação do remetente é necessária para realizar os envios. Criaremos o objeto com os seguintes parâmetros e endpoint:
- Campo "name" - identifica o nome do remetente (ex.: João da Silva)
- Campo "email" - designa o remetente que será utilizado nessa mensagem, deve ser um e-mail autenticado e configurado.
POST: /api/v1/campaigns/sender/
Resultado esperado:
Obs.: A ID do Remetente está nos atributos “ID” e “resource_url” (que poderá acessar os detalhes do remetente a partir do endpoint).
- Listando os Remetentes de E-mail existentes:
- Visualizar os Remetentes:
GET: /api/v1/campaigns/sender/
Resultado esperado:
Será exibido um objeto no formato JSON, com 2 (dois) dicionários:
- Meta - visão geral de quantos objetos você possui e o link da próxima página do objeto (atributo "next" do dicionário).
- Objects - detalhe completo do objeto carregado no campo “resource_url”.
- Listando os Remetentes por ID:
GET: /api/v1/campaigns/sender/?id=xxx
- Listando os Remetentes por nome:
GET: /api/v1/campaigns/sender/?name=teste
- Listando os Remetentes por e-mail:
GET: /api/v1/campaigns/email_template/?email=joao@dominio.com.br
- Atualizando um Remetente de E-mail
Para alterar um remetente, utilize o método PATCH com os parâmetros abaixo:
PATCH: /api/v1/campaigns/sender/XXX58/
- Solicitando validação do Remetente de E-mail
GET: /api/v1/campaigns/sender/validate/XXX58/
Resultado esperado:
Obs.: Caso haja algum problema com o cadastro, será exibido um erro do tipo 401 - 403.
IMPORTANTE!
- Se o seu domínio não estiver configurado com nossas informações de DKIM e SPF, será enviado um e-mail solicitando a confirmação através de um link.
- Ao criar o remetente, o sistema automaticamente enviará, por meio de um link, uma mensagem solicitando a confirmação.
- Caso você já tenha configurado os domínios de envio através de autenticação por chave DKIM, SPF e DMARC essa autenticação não será pedida.