Skip to main content

Что это

Email API отправляет одно письмо одному или нескольким получателям. Используйте его для транзакционных уведомлений, обновлений аккаунта, квитанций и персонализированных сообщений.

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

  • Сохраните ваш API-ключ YCloud в YCLOUD_API_KEY.
  • Зарегистрируйте и активируйте домен отправителя в вашем аккаунте YCloud.
  • Используйте адрес отправителя с активированного домена.
  • Подготовьте HTML- или текстовый контент не более 150 КБ.

Как это работает

Отправьте письмо запросом POST /emails. Ответ подтверждает, что YCloud принял письмо, и возвращает его id. Доставка происходит отдельно для каждого адреса в to, cc и bcc. Подпишитесь на email.delivery.updated, чтобы получать состояния на уровне получателей, такие как sent, delivered, undelivered и failed.

Запрос

POST /emails

Поля запроса

Пример запроса

Ответ

Успешный ответ возвращает созданный объект email. Приём не означает, что каждый получатель получил письмо.

Пример ответа

Поля ответа

Персонализация контента

Размещайте переменные между символами # в контенте. Указывайте один объект переменных для каждого адреса в to.

Статус доставки

Подпишитесь на email.delivery.updated. Каждое событие идентифицирует письмо и конкретный recipientAddress, так как получатели могут иметь разные финальные состояния. Сообщения text/plain не генерируют события отслеживания кликов или открытий.

Ограничения и устранение неполадок

  • Домен отправителя должен быть активирован до отправки.
  • to поддерживает не более 100 адресов.
  • subject поддерживает не более 255 символов.
  • content поддерживает не более 150 КБ.
  • После успешного ответа API у получателя всё ещё может произойти событие undelivered или failed.
  • При расследовании доставки используйте id письма, адрес получателя и externalId.