Pré-requisito:
- Criando um Modelo de E-mail
Para interagir com o Modelo de E-mail, vamos criar o objeto com os seguintes endpoint e parâmetros:
- Campo "name" – identifica o nome da mensagem, não é exibido ao destinatário.
- Campo "subject" – insere o assunto da mensagem.
- Campo "html_body_description" – insere o conteúdo da mensagem.
- Campos personalizados – utilizam o formato {{nome-da-variavel}}, podem ser incluídos tanto no assunto como no corpo da mensagem
POST: /api/v1/campaigns/email_template/
Resultado esperado:
Obs.: A ID do Modelo de E-mail está nos atributos “ID” e “resource_url” (que poderá acessar os detalhes da lista a partir do endpoint) e será utilizada para relacionar as campanhas.
- Listando os Modelos de E-mail Existentes
GET: /api/v1/campaigns/email_template/
Resultado esperado:
Será exibido um objeto no formato JSON, e terão 2 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”.
- Listrando os Modelos de E-mail
- Por nome:
GET: /api/v1/campaigns/email_template/?name=teste
- Por assunto:
GET: /api/v1/campaigns/email_template/?subject=teste
- Atualizando um modelo de e-mail
PATCH: /api/v1/campaigns/email_template/XXX58/
Resultado esperado:
Obs.: Através de nossa API você poderá criar modelos de e-mail direto de sua aplicação.
⚠️Importante!
- As tags {{alternative_view|safe}} e {{opt_out|safe}} são referentes ao link de visualização da página alternativa e Opt-Out da plataforma, respectivamente, e sempre serão adicionadas automática pelo sistema. Mas pode-se mudar a posição delas no modelo de e-mail.
- O campo “subject” e “html_body_description” são obrigatórios e não podem estar em branco.
- Código-fonte HTML com um link inválido: verifique no seu código qual linha apresenta o erro e faça a correção.