SendGrid

Письма, контакты, списки и шаблоны SendGrid

SendGrid — облачная доставка почты: транзакционные письма, маркетинговые контакты, списки и шаблоны.

С SendGrid в Pailot вы можете:

Отправлять письма (текст/HTML, вложения, динамический шаблон)
Добавлять, искать и удалять контакты; вести списки
Создавать шаблоны и версии шаблонов

Нужен ключ API (Application Programming Interface — программный интерфейс) SendGrid. Адрес отправителя должен быть подтверждён в SendGrid. Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.

Инструменты

`sendgrid_send_mail`

Отправить письмо через API SendGrid.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`from`	string	Да	Адрес отправителя (должен быть подтверждён в SendGrid)
`fromName`	string	Нет	Имя отправителя
`to`	string	Да	Адрес получателя
`toName`	string	Нет	Имя получателя
`subject`	string	Нет	Тема (нужна, если не задана в шаблоне)
`content`	string	Нет	Тело письма (нужно, если не задано в шаблоне)
`contentType`	string	Нет	Тип: text/plain или text/html
`cc`	string	Нет	Адрес копии
`bcc`	string	Нет	Адрес скрытой копии
`replyTo`	string	Нет	Адрес для ответа
`replyToName`	string	Нет	Имя для ответа
`attachments`	file[]	Нет	Вложения
`templateId`	string	Нет	ID шаблона SendGrid
`dynamicTemplateData`	json	Нет	JSON с данными динамического шаблона

Выход

Параметр	Тип	Описание
`success`	boolean	Письмо успешно отправлено
`messageId`	string	ID письма в SendGrid
`to`	string	Адрес получателя
`subject`	string	Тема

`sendgrid_add_contact`

Добавить контакт в SendGrid.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`email`	string	Да	Email контакта
`firstName`	string	Нет	Имя
`lastName`	string	Нет	Фамилия
`customFields`	json	Нет	JSON пользовательских полей (ID полей вроде e1_T, e2_N, e3_D, не имена)
`listIds`	string	Нет	ID списков через запятую

Выход

Параметр	Тип	Описание
`jobId`	string	ID задания асинхронного создания контакта
`email`	string	Email контакта
`firstName`	string	Имя
`lastName`	string	Фамилия
`message`	string	Статус

`sendgrid_get_contact`

Получить контакт по ID.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`contactId`	string	Да	ID контакта

Выход

Параметр	Тип	Описание
`id`	string	ID контакта
`email`	string	Адрес почты
`firstName`	string	Имя
`lastName`	string	Фамилия
`createdAt`	string	Время создания
`updatedAt`	string	Время обновления
`listIds`	json	ID списков, в которых состоит контакт
`customFields`	json	Значения пользовательских полей

`sendgrid_search_contacts`

Найти контакты по запросу.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`query`	string	Да	Поисковый запрос (например "email LIKE '%example.com%' AND CONTAINS(list_ids, 'list-id')")

Выход

Параметр	Тип	Описание
`contacts`	json	Найденные контакты
`contactCount`	number	Число найденных контактов

`sendgrid_delete_contacts`

Удалить один или несколько контактов.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`contactIds`	string	Да	ID контактов через запятую

Выход

Параметр	Тип	Описание
`jobId`	string	ID задания на удаление

`sendgrid_create_list`

Создать список контактов.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`name`	string	Да	Имя списка

Выход

Параметр	Тип	Описание
`id`	string	ID списка
`name`	string	Имя списка
`contactCount`	number	Число контактов в списке

`sendgrid_get_list`

Получить список по ID.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`listId`	string	Да	ID списка

Выход

Параметр	Тип	Описание
`id`	string	ID списка
`name`	string	Имя списка
`contactCount`	number	Число контактов в списке

`sendgrid_list_all_lists`

Все списки контактов.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`pageSize`	number	Нет	Число списков на страницу (по умолчанию 100)

Выход

Параметр	Тип	Описание
`lists`	json	Массив списков

`sendgrid_delete_list`

Удалить список контактов.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`listId`	string	Да	ID списка

Выход

Параметр	Тип	Описание
`message`	string	Сообщение об успехе

`sendgrid_add_contacts_to_list`

Добавить или обновить контакты и привязать их к списку (PUT /v3/marketing/contacts).

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`listId`	string	Да	ID списка
`contacts`	json	Да	JSON-массив контактов. У каждого минимум: email (или phone_number_id/external_id/anonymous_id). Пример: [{"email": "user@example.com", "first_name": "John"}]

Выход

Параметр	Тип	Описание
`jobId`	string	ID асинхронного задания
`message`	string	Статус

`sendgrid_remove_contacts_from_list`

Убрать контакты из списка.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`listId`	string	Да	ID списка
`contactIds`	string	Да	ID контактов через запятую

Выход

Параметр	Тип	Описание
`jobId`	string	ID задания

`sendgrid_create_template`

Создать шаблон письма.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`name`	string	Да	Имя шаблона
`generation`	string	Нет	Тип: legacy или dynamic (по умолчанию dynamic)

Выход

Параметр	Тип	Описание
`id`	string	ID шаблона
`name`	string	Имя шаблона
`generation`	string	Тип поколения шаблона
`updatedAt`	string	Время обновления
`versions`	json	Версии шаблона

`sendgrid_get_template`

Получить шаблон по ID.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`templateId`	string	Да	ID шаблона

Выход

Параметр	Тип	Описание
`id`	string	ID шаблона
`name`	string	Имя шаблона
`generation`	string	Тип поколения шаблона
`updatedAt`	string	Время обновления
`versions`	json	Версии шаблона

`sendgrid_list_templates`

Все шаблоны писем.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`generations`	string	Нет	Фильтр: legacy, dynamic или both
`pageSize`	number	Нет	Число шаблонов на страницу (по умолчанию 20)

Выход

Параметр	Тип	Описание
`templates`	json	Массив шаблонов

`sendgrid_delete_template`

Удалить шаблон письма.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`templateId`	string	Да	ID шаблона

Выход

Параметр	Тип	Описание
`success`	boolean	Операция успешна
`message`	string	Статус
`messageId`	string	ID письма (send_mail)
`to`	string	Адрес получателя (send_mail)
`subject`	string	Тема (send_mail, create_template_version)
`id`	string	ID ресурса
`jobId`	string	ID асинхронного задания
`email`	string	Email контакта
`firstName`	string	Имя контакта
`lastName`	string	Фамилия контакта
`createdAt`	string	Время создания
`updatedAt`	string	Время обновления
`listIds`	json	ID списков контакта
`customFields`	json	Пользовательские поля
`contacts`	json	Массив контактов
`contactCount`	number	Число контактов
`lists`	json	Массив списков
`name`	string	Имя ресурса
`templates`	json	Массив шаблонов
`generation`	string	Тип поколения шаблона
`versions`	json	Версии шаблона
`templateId`	string	ID шаблона
`active`	boolean	Версия шаблона активна
`htmlContent`	string	HTML-содержимое
`plainContent`	string	Текстовое содержимое

`sendgrid_create_template_version`

Создать версию шаблона письма.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API SendGrid
`templateId`	string	Да	ID шаблона
`name`	string	Да	Имя версии
`subject`	string	Да	Тема письма
`htmlContent`	string	Нет	HTML шаблона
`plainContent`	string	Нет	Текстовая версия шаблона
`active`	boolean	Нет	Сделать версию активной (по умолчанию true)

Выход

Параметр	Тип	Описание
`id`	string	ID версии
`templateId`	string	ID шаблона
`name`	string	Имя версии
`subject`	string	Тема
`active`	boolean	Версия активна
`htmlContent`	string	HTML-содержимое
`plainContent`	string	Текстовое содержимое
`updatedAt`	string	Время обновления

На этой странице

На этой странице

Получить доступ

Копилот собирает процесс. Менеджер запускает сам. Можно поставить в контур компании.

Получить доступ