FlipLink

Уведомления и шаблоны писем

Уведомления и письма

Выбирайте, какие email-уведомления вы получаете по флипбуку, и настраивайте тему и тело писем, отправляемых при событиях нового лида, нового просмотра и новой продажи.

API, используемые в этом обсуждении

Что-то в этом руководстве неточно или устарело?

Что можно сделать

Эти эндпоинты позволяют управлять письмами одного флипбука: какие события уведомляют вас и что в этих письмах написано. С ними вы можете:

  • Настроить, какие уведомления вы получаете по флипбуку (новый лид, новый просмотр, новая продажа).
  • Настроить письмо о новом лиде — тему и тело, отправляемые при событии нового лида.
  • Настроить письмо о новом просмотре — тему и тело, отправляемые при уведомлении о новом просмотре.
  • Настроить письмо о новой продаже — тему и тело, отправляемые при уведомлении о новой продаже.
  • Восстановить любой шаблон к значению по умолчанию, отправив пустые значения.

Перед началом

  • API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY в каждом запросе.
  • {flipbookId} — числовой ID флипбука/документа. Он возвращается из create-by-file / create-by-url (как ID) или из list. Каждый эндпоинт здесь принимает его как параметр пути.
  • Все запросы идут на базовый URL https://go.fliplink.me.

Тело каждого запроса — form-urlencoded (не JSON) — передавайте поля через --data-urlencode.

Настройка уведомлений

Используйте PUT /api/set-notifications/{flipbookId}, чтобы настроить, какие email-уведомления вы получаете по этому флипбуку (новый лид, новый просмотр, новая продажа).

Поля тела (form-urlencoded):

  • NotificationsEmail — адрес назначения, на который отправляются письма-уведомления. Для нового флипбука по умолчанию это email вашего аккаунта; вы можете изменить его на любой адрес или отправить пустым, чтобы очистить.
  • IsSendEmailOnView — булево (true / false, по умолчанию false), которое переключает письмо «просмотрено». Задайте true, чтобы получать письмо, когда кто-то просматривает флипбук. В примере ниже отправляется 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'

Ответ:

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

Задать шаблон письма о новом лиде

Используйте PUT /api/set-email-template-lead/{flipbookId}, чтобы задать письмо, отправляемое при событии нового лида. Отправьте пустые значения, чтобы восстановить шаблон по умолчанию 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='

Ответ:

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

Задать шаблон письма о новом просмотре

Используйте PUT /api/set-email-template-view/{flipbookId}, чтобы задать шаблон письма, отправляемого при уведомлении о новом просмотре. Отправьте пусто, чтобы восстановить шаблон по умолчанию 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='

Ответ:

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

Задать шаблон письма о новой продаже

Используйте PUT /api/set-email-template-sale/{flipbookId}, чтобы задать шаблон письма, отправляемого при уведомлении о новой продаже. Отправьте пусто, чтобы восстановить шаблон по умолчанию 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='

Ответ:

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

Возможные ошибки

  • Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key (или токен Authorization: Bearer) присутствует и указан верно.
  • ID элемента не найден или не принадлежит вашему ключу → HTTP 200 с Message: "Item not found".
  • Неизвестное поле тела запроса или опечатка в нём → HTTP 200 с Message: "Unknown field(s) '…'. Expected: …".

Примечания

  • Шаблоны писем о лиде, просмотре и продаже поставляются со встроенным текстом по умолчанию. Отправка пустых значений восстанавливает шаблон по умолчанию этого события (NEW_LEAD, NEW_VIEW или NEW_SALE соответственно).
  • Токены подстановки используют соглашение ##TOKEN## — например, ##FLIPLINK## подставляет имя флипбука в тему или тело.