Como criar uma campanha usando a API externa do Xtremepush
Se ainda não fez isso, primeiro revise a visão geral sobre o uso dos métodos de criar e enviar campanhas para enviar mensagens via API.
Para criar um e-mail, você precisará adicionar uma mensagem de e-mail nos parâmetros de solicitação POST ao chamar o método create. Os parâmetros usados no conteúdo das mensagens de e-mail estão listados abaixo:
Paramethers
Parâmetro | Descrição |
|---|---|
Mensagens | Defina para o número 7 para e-mail, ou seja: |
email_type | Defina para 1 para indicar que o e-mail vem da API |
email_subject | Assunto do texto do e-mail |
email_html | O html do seu e-mail |
email_text | O texto da versão em texto simples do seu e-mail |
email_unsubscribe | Escolha sobre usar ou não o cabeçalho de cancelar inscrição. Booleano 0/1. |
email_address_id | O ID do endereço de e-mail de partir que você quer usar |
email_template | ajustado para 1 |
Exemplo
Encontre um exemplo de solicitação POST abaixo para criar uma mensagem de e-mail. O e-mail do canal é ativado com "email":1, o tipo de e-mail 7 é adicionado ao objeto mensagens com parâmetros para o conteúdo do e-mail. O ID do endereço de e-mail pode ser encontrado na tabela que mostra sua lista de e-mails verificados. Esses podem ser encontrados na plataforma indo ao menu de Administração (canto superior direito) > Endereços de e-mail. Neste exemplo "broadcast":1 , é usado para atingir toda a sua base de usuários disponíveis. Condições que miram uma subseção do seu público, além de opções de agendamento e outras podem ser adicionadas conforme descrito na visão geral do método de criação de campanha .
URL = api / external / create / campaign
POST_DATA = {
"apptoken": "YOURAPPTOKEN",
"title": "Email Example via API",
"email": 1,
"broadcast": 1,
"messages": {
"7": {
"email_address_id": xxx,
"email_subject": "Hi {{first_name}}, check out our sample API email test",
"email_unsubscribe": 0,
"email_text": "[Image]\n\nEditor 2.0 now available\n\nThe New Drag and Drop Editor is Here!\n\nOur amazing email editor with built in responsive design has now become even better, giving you full control over rows and columns\n\n[Image]",
"email_type": 1,
\
"email_template": 1,
"email_html": "YOUR FULLY RESPONSIVE EMAIL HTML"
}
}
}Seu HTML pode se parecer com o exemplo linkado abaixo, que gera um e-mail como este:
.png?sv=2026-02-06&spr=https&st=2026-10-03T10%3A00%3A18Z&se=2026-10-03T10%3A11%3A18Z&sr=c&sp=r&sig=KCKptyQgSkaKRvWCvE3sjMIDZQUTqf6CliqAW5LrAH8%3D)
Para ajudar a testar, você pode usar este exemplo de conteúdo de e-mail HTML.