Notificações e modelos de e-mail

O que você pode fazer

Estes endpoints permitem controlar o lado de e-mail de um único flipbook: quais eventos notificam você e o que esses e-mails dizem. Com eles você pode:

• Configurar quais notificações você recebe de um flipbook (novo lead, nova visualização, nova venda).
• Personalizar o e-mail de Novo Lead — o assunto e o corpo enviados em um evento de novo lead.
• Personalizar o e-mail de Nova Visualização — o assunto e o corpo enviados em uma notificação de nova visualização.
• Personalizar o e-mail de Nova Venda — o assunto e o corpo enviados em uma notificação de nova venda.
• Restaurar qualquer modelo ao padrão enviando valores vazios.

Antes de começar

• Uma chave de API — enviada como cabeçalho X-Api-Key ou como Authorization: Bearer YOUR_API_KEY em toda requisição.
• O {flipbookId} — o ID numérico do flipbook/documento. Ele é retornado por create-by-file / create-by-url (como ID) ou por list. Todo endpoint aqui o recebe como parâmetro de caminho.
• Todas as requisições vão para a URL base https://go.fliplink.me.

Cada corpo de requisição é form-urlencoded (não JSON) — envie os campos com --data-urlencode.

Configure as notificações

Use PUT /api/set-notifications/{flipbookId} para configurar quais notificações por e-mail você recebe deste flipbook (novo lead, nova visualização, nova venda).

Campos do corpo (form-urlencoded):

• NotificationsEmail — o endereço de destino para o qual os e-mails de notificação são enviados. Em um flipbook novo, o padrão é o e-mail da sua conta; você pode trocá-lo por qualquer endereço, ou enviá-lo vazio para limpá-lo.
• IsSendEmailOnView — um boolean (true / false, padrão false) que ativa o e-mail de "visualizado". Defina como true para receber um e-mail quando alguém visualizar o flipbook. O exemplo abaixo envia true.

curl -X PUT 'https://go.fliplink.me/api/set-notifications/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=you@example.com' \
  --data-urlencode 'IsSendEmailOnView=true'

Resposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Defina o modelo de e-mail de Novo Lead

Use PUT /api/set-email-template-lead/{flipbookId} para definir o e-mail enviado em um evento de novo lead. Envie valores vazios para restaurar o modelo padrão NEW_LEAD.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=' \
  --data-urlencode 'EmailLeadBody='

Resposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Defina o modelo de e-mail de Nova Visualização

Use PUT /api/set-email-template-view/{flipbookId} para definir o modelo de e-mail enviado em uma notificação de nova visualização. Envie vazio para restaurar o modelo padrão NEW_VIEW.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=' \
  --data-urlencode 'EmailViewBody='

Resposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Defina o modelo de e-mail de Nova Venda

Use PUT /api/set-email-template-sale/{flipbookId} para definir o modelo de e-mail enviado em uma notificação de nova venda. Envie vazio para restaurar o modelo padrão NEW_SALE.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=' \
  --data-urlencode 'EmailSaleBody='

Resposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Erros possíveis

• Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key (ou o token Authorization: Bearer) está presente e correto.
• ID do item não encontrado ou não pertencente à sua chave → HTTP 200 com Message: "Item not found".
• Campo do corpo desconhecido ou digitado errado → HTTP 200 com Message: "Unknown field(s) '…'. Expected: …".

Notas

• Os modelos de e-mail de lead, visualização e venda vêm cada um com um texto padrão embutido. Enviar valores vazios restaura o modelo padrão daquele evento (NEW_LEAD, NEW_VIEW ou NEW_SALE, respectivamente).
• Os tokens de mesclagem usam a convenção ##TOKEN## — por exemplo, ##FLIPLINK## insere o nome do flipbook no assunto ou no corpo.