API футера и прехедера письма: ссылка отписки, варианты, логотип

Ресурс footer: футер внизу каждого письма и прехедер над письмом. Те же настройки, что в кабинете на странице «Футер». Они действуют на все письма аккаунта: рассылки, серии, сценарии и цепочки. Свой футер макета (поле footer макета) главнее футера аккаунта.

Ссылка для отписки нужна хотя бы в одном месте: в футере, в прехедере или в самом макете. Выключены и футер, и прехедер: рассылка запустится, только если ссылка есть в макете. Где она будет, показывает unsubscribe_in.
Имя и адрес отправителя в футере берутся из основного адреса отправителя, в серии из адреса серии.
Пока настройки не сохранены (saved = 0), письма идут с прежним футером аккаунта.
Ресурс открывается аккаунтам постепенно. До открытия ответ с ошибкой 22101.

Поле	Значение
`footer.enabled`	`1` добавлять футер в конец письма, `0` не добавлять.
`footer.style`	Вариант: `classic`, `divider`, `card`, `band`, `minimal`, `columns`, `outline`, `signature`, `brand_light`, `brand_mint`, `brand_dark` (три последних с логотипом Estismail) или `custom` (свой HTML из `footer.custom_html`).
`footer.align`	`center` или `left`.
`footer.size`	Размер текста: `11`, `12` или `13`.
`footer.tone`	Цвет текста: `light`, `mid` или `dark`.
`footer.rows`	Что показать, у каждого `1` или `0`: `name` имя отправителя, `email` адрес отправителя, `site` сайт, `address` почтовый адрес, `reason` почему пришло письмо, `date` дата подписки, `ip` IP при подписке, `web` ссылка «Открыть в браузере», `year` год и ©. Ссылка «Отписаться» есть всегда.
`footer.site`	Сайт, например `example.com`, до 200 знаков.
`footer.address`	Почтовый адрес, до 300 знаков.
`footer.custom_html`	Свой HTML футера для `style` = `custom`. Обязательна ссылка отписки `{uns_url}`.
`preheader.enabled`	`1` добавлять прехедер в начало письма, `0` не добавлять.
`preheader.style`	Вариант: `right`, `left`, `center`, `split`, `bar` или `brand` (с логотипом Estismail).
`preheader.web_version`	`1` показать ссылку «Открыть в браузере».
`preheader.text`	Строка предпросмотра, до 150 знаков. Провайдеры показывают её в списке писем рядом с темой.
`unsubscribe_in`	Только в ответе: где в письме будет ссылка отписки: `footer`, `preheader`, `both` или `template` (только в макете).
`saved`	Только в ответе: `1` настройки сохранены, `0` ещё нет, показаны настройки по умолчанию.

GET`/mailer/footer.json`

Настройки футера и прехедера

curl https://v1.estismail.com/mailer/footer.json \
  -H "X-Estis-Auth: ВАШ_КЛЮЧ"

<?php
$ch = curl_init('https://v1.estismail.com/mailer/footer.json');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['X-Estis-Auth: ВАШ_КЛЮЧ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), "\n", $response;

import requests

r = requests.get(
    "https://v1.estismail.com/mailer/footer.json",
    headers={"X-Estis-Auth": "ВАШ_КЛЮЧ"},
)
print(r.status_code, r.text)

const res = await fetch("https://v1.estismail.com/mailer/footer.json", {
  headers: { "X-Estis-Auth": "ВАШ_КЛЮЧ" },
});
console.log(res.status, await res.text());

Ответ 200

{
  "saved": 1,
  "footer": {
    "enabled": 1,
    "style": "card",
    "align": "center",
    "size": 12,
    "tone": "mid",
    "rows": {
      "name": 1,
      "email": 1,
      "site": 1,
      "address": 0,
      "reason": 1,
      "date": 0,
      "ip": 0,
      "web": 1,
      "year": 1
    },
    "site": "example.com",
    "address": "",
    "custom_html": ""
  },
  "preheader": {
    "enabled": 1,
    "style": "right",
    "web_version": 1,
    "text": ""
  },
  "unsubscribe_in": "both"
}

PUT`/mailer/footer.json`

Изменить футер и прехедер

Передайте footer и (или) preheader: JSON-объект только с теми полями, которые меняете. Остальное остаётся как было. Неизвестное поле или значение: ошибка, ничего не записано.

curl -X PUT https://v1.estismail.com/mailer/footer.json \
  -H "X-Estis-Auth: ВАШ_КЛЮЧ" \
  -d footer='{"enabled":1,"style":"card","rows":{"site":1},"site":"example.com"}' \
  -d preheader='{"enabled":1,"style":"right"}'

<?php
$ch = curl_init('https://v1.estismail.com/mailer/footer.json');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => http_build_query([
        'footer' => '{"enabled":1,"style":"card","rows":{"site":1},"site":"example.com"}',
        'preheader' => '{"enabled":1,"style":"right"}',
    ]),
    CURLOPT_HTTPHEADER => ['X-Estis-Auth: ВАШ_КЛЮЧ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), "\n", $response;

import requests

r = requests.put(
    "https://v1.estismail.com/mailer/footer.json",
    headers={"X-Estis-Auth": "ВАШ_КЛЮЧ"},
    data={
        "footer": '{"enabled":1,"style":"card","rows":{"site":1},"site":"example.com"}',
        "preheader": '{"enabled":1,"style":"right"}',
    },
)
print(r.status_code, r.text)

const res = await fetch("https://v1.estismail.com/mailer/footer.json", {
  method: "PUT",
  headers: { "X-Estis-Auth": "ВАШ_КЛЮЧ" },
  body: new URLSearchParams({
    footer: '{"enabled":1,"style":"card","rows":{"site":1},"site":"example.com"}',
    preheader: '{"enabled":1,"style":"right"}',
  }),
});
console.log(res.status, await res.text());

Ответ 204, без тела

Вопросы по API: support@estismail.com

Футер и прехедер

GET/mailer/footer.json

PUT/mailer/footer.json

GET`/mailer/footer.json`

PUT`/mailer/footer.json`