Pular para o conteúdo principal

​
Visão geral

O OneSignal fornece uma experiência de cancelamento de assinatura padrão em conformidade com email que injeta um link em seus templates de email para que os usuários possam cancelar a assinatura com facilidade e seus status de assinatura sejam atualizados em tempo real. Se você deseja controle total sobre branding, cópia e campos (como opt-outs de categoria), você pode substituir o link padrão por sua própria página personalizada e usar a API do OneSignal para cancelar a assinatura ou atualizar as preferências do usuário. Este guia explica como adicionar sua própria página de cancelamento de assinatura personalizada aos emails (removendo o link padrão do OneSignal) e quais de nossas APIs usar para cancelar a assinatura de email do usuário. Se você deseja adicionar mais funcionalidade à sua página de cancelamento de assinatura personalizada (como opt out de categorias específicas de email em vez de todas), isso é detalhado em nosso tutorial Preference Center.
O OneSignal insere automaticamente um link especial no formato [unsubscribe_url] em seus templates de email. Esta URL cancela a assinatura do usuário de todos os emails no OneSignal. Veja Links de cancelamento de assinatura de email para detalhes. Para usar sua própria página, localize e remova o link padrão no seu template.
  • Editor de arrastar e soltar
  • Editor HTML
No editor de arrastar e soltar, o link padrão pode aparecer aninhado assim:
Drag-and-Drop editor unsubscribe link

Link de cancelamento de assinatura do editor de arrastar e soltar

Agora que você removeu nosso link especial, você pode substituí-lo por sua própria URL. Muitas vezes, esses links requerem alguns dados adicionais a serem passados para sua página. Use variáveis Liquid para passar dados do OneSignal para sua página. Parâmetros comuns:
ParâmetroDescrição
subscription.emailEndereço de email do assinante
subscription.external_idID externo do usuário
app.idID do aplicativo OneSignal
message.idID da notificação de email
subscription.languageIdioma preferido (para localização)
subscription.unsubscribe_tokenToken de segurança para verificação da API
URL de exemplo: 
https://examplesite.com/unsubscribe?app_id={{app.id}}&notification_id={{message.id}}&email={{subscription.email}}&language={{subscription.language}}&token={{subscription.unsubscribe_token}}
HTML
  <div style="text-align: center;">
    <a
      href="https://examplesite.com/unsubscribe?app_id={{app.id}}&notification_id={{message.id}}&email={{subscription.email}}&language={{subscription.language}}&token={{subscription.unsubscribe_token}}"
      data-disable-tracking="true"
      style="display: inline; text-decoration: none;"
    >
      Unsubscribe
    </a>
    <p style="display: inline;"> from our emails</p>
  </div>
Add custom unsubscribe link

Adicionar link de cancelamento de assinatura personalizado

​
Desabilitar rastreamento de cliques

Cliques de cancelamento de assinatura geralmente não são usados para métricas de engajamento. Se você deseja desabilitar o rastreamento de links, você pode adicionar o atributo data-disable-tracking="true" ao seu link assim:
HTML
  <a
    href="https://www.examplesite.com/unsubscribe?app_id={{app.id}}&notification_id={{message.id}}&email={{subscription.email}}&language={{subscription.language}}&token={{subscription.unsubscribe_token}}"
    data-disable-tracking="true"
  >
    Unsubscribe
  </a>
Atributos específicos de provedor:
ProvedorAtributo
OneSignaldata-disable-tracking="true"
Mailgundisable-tracking=true
SendGridclicktracking=off
Mandrillmc:disable-tracking

​
Hospedar sua página de cancelamento de assinatura personalizada

Implante uma página web que:
  • Lê parâmetros de consulta do link de cancelamento de assinatura.
  • Exibe opções de opt-out ou preferências amigáveis ao usuário.
  • Envia a solicitação de cancelamento de assinatura ou atualização para o OneSignal via API.
Fornecemos um projeto de exemplo no GitHub funcional que você pode fazer fork e implantar.
Sample unsubscribe page

UI de exemplo da página de cancelamento de assinatura

​
Chamar a API do OneSignal

Dependendo do seu caso de uso, você pode usar as seguintes APIs para cancelar a assinatura ou atualizar as preferências do usuário:
  • Update Subscription by Token
  • Unsubscribe Email with Token
  • Update User
Esta API é mais comumente usada quando você tem o endereço de email do usuário e só quer inscrevê-lo ou cancelar sua assinatura de todos os emails.Parâmetros de consulta obrigatórios:
  • app_id
  • token
Autenticação necessária
  • Chame esta API do seu servidor.
Agora você deve estar equipado com tudo o que precisa saber sobre criar uma página de cancelamento de assinatura personalizada.