Документация для разработчиков

Документация API версии 1.1

« Назад на Обзор Документации

campaigns.update

campaigns.update (int campaign_id, serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string analytics_medium, string analytics_source, string analytics_content, string analytics_term, string html, string cloud, string plain_text, string amp, string status, serialized array esegment, int limit, int wait_time, string allow_time_zone, string allow_best_time, string stat_domain)

Обновляем параметры рассылки.

Категория метода
Campaigns
Параметры
campaign_id int id обновляемой кампании
list_id serialized array опционально - индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Массив можно передавать в сериализованном виде или в формате json.
name string опционально - название рассылки
subject string опционально - заголовок письма [должно соответствовать содержанию письма и не отталкивать]
from_name string опционально - от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании]
from_email string опционально - обратный адрес [ответы ваших подписчиков будут приходить на этот адрес]
personalizeToEmail string опционально - {on/off} - включить/выключить персонализацию в поле "Кому:" [default: off]
to_email string опционально - персонализация в поле "Кому:" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens string опционально - {Y,N} - следить за открыванием [default: Y]
track_clicks string опционально - {Y,N} - отслеживать клики [default: Y]
plain_clicks string опционально - {Y,N} - отслеживать клики в текстовой версии [default: N]
no_images_add string опционально - {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены
analytics string опционально - {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N]
analytics_tag string опционально - текстовый тег utm_campaign, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011
analytics_medium string опционально - utm_medium для отображения кликов в Google Analytics™
analytics_source string опционально - utm_source для отображения кликов в Google Analytics™
analytics_content string опционально - utm_content для отображения кликов в Google Analytics™
analytics_term string опционально - utm_term для отображения кликов в Google Analytics™
html string опционально - код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона
cloud string опционально - если параметр задан, то картинки из html-шаблона автоматически загружаются в наше облачное хранилище для возможного дальнейшего использования.
plain_text string опционально - текстовая версия письма
amp string опционально - код AMP-версии письма.
status string опционально - [DRAFT, SCHEDULE, MODERATING] - перевод в статус SCHEDULE или MODERATING возможен только если рассылка удовлетворяет ряду условий:
  • заданы $subject, $from_name, $from_email
  • задана $html или $plain_text версия письма
  • есть ссылка на отписку для подписчиков вида отписаться для html-версии и %ОТПИСАТЬСЯ% для plain-text версии


if (status=SCHEDULE) : delivery_time в формате mysql: YYYY-MM-DD HH:MM:SS
esegment serialized array опционально - сегменты баз для рассылки. Структура массива: id базы => массив сегмента. Структура массивов сегмента: [match] = {any|all} - должны выполняться все или любые из условия. [c] - массив условий. Содержит поля: [field] - тип поля (email, merge_{1..10}), [op] - условие {is, is not, contains, notcontain, starts, ends, greater, less}, [value] - значение поля. Например: array['match']='any';array['c'][0]['field']='email';array['c'][0]['op']='is';array['c'][0]['value']='support@dashamail.ru'; Массив можно передавать в сериализованном виде или в формате json.
limit int опционально - установить лимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период.
wait_time int опционально - временной период в секундах для ожидания перед отправкой следующей части отправкой частями. Например, 3600 – плавная отправка limit писем раз в час.
allow_time_zone string опционально - {Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке [default: N]
allow_best_time string опционально - {Y,N} - оптимизировать время получения письма, функция "лучшее время доставки" [default: N]
stat_domain string опционально - Домен статистики, который необходимо использовать в рассылке
Возвращаемые значения (значения data)
Если значение msg[err_code] равно 0, то операция прошла успешно