Marketo MA (не рекомендуется) [DEPRECATED]
Marketo Marketing Automation. Этот API предоставляет доступ к объектам Marketo, таким как кампании, программы, потенциальные клиенты, списки (статические и интеллектуальные), а также к ресурсам файловой системы, таким как файлы и папки.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Стандарт | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Стандарт | Все регионы Power Apps , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Стандарт | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Отношения разработчиков Marketo |
| URL | http://developers.marketo.com |
| Адрес электронной почты | developerfeedback@marketo.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft Inc. |
| Веб-сайт | https://www.marketo.com/ |
| Политика конфиденциальности | https://documents.marketo.com/legal/privacy/ |
| Условия использования | https://go.microsoft.com/fwlink/?linkid=2237005 |
| Категории | Маркетинг; Продажи и CRM |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| MunchkinID | струна | Ваш Marketo MunchkinID (см. страницу администрирования) | True |
| Идентификатор клиента | струна | Идентификатор клиента | True |
| Секрет клиента | securestring | Секрет клиента | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Get Campaign By Id (не рекомендуется) [DEPRECATED] |
Возвращает запись кампании по идентификатору. (не рекомендуется) Необходимые разрешения: Read-Only кампании, Read-Write кампании |
| Push Lead to Marketo (не рекомендуется) [DEPRECATED] |
Upserts a lead и создает действие Push Lead to Marketo. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Unapprove Program (не рекомендуется) [DEPRECATED] |
Не одобряет целевую программу. Допустимо только для утвержденных программ электронной почты. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Добавление в список (не рекомендуется) [DEPRECATED] |
Добавляет заданный набор записей пользователей в целевой статический список. (не рекомендуется) Существует ограничение в 300 идентификаторов свинца на запрос. Необходимые разрешения: Read-Write свинца |
| Задание потенциальных пользователей в очереди (не рекомендуется) [DEPRECATED] |
Задание экспорта в очередь. Это приведет к тому, что задание экспорта будет помещено в очередь и запустит задание, когда вычислительные ресурсы становятся доступными. Задание экспорта должно находиться в состоянии "Создано". Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Задание участника программы экспорта (не рекомендуется) [DEPRECATED] |
Задание экспорта в очередь. Это приведет к тому, что задание экспорта будет помещено в очередь и запустит задание, когда вычислительные ресурсы становятся доступными. Задание экспорта должно находиться в состоянии "Создано". (deprecated) |
| Импорт потенциальных клиентов (не рекомендуется) [DEPRECATED] |
Импортирует файл, содержащий записи данных, в целевой экземпляр. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Импорт элементов программы (не рекомендуется) [DEPRECATED] |
Импортирует файл, содержащий записи данных, в целевой экземпляр. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Кампания запросов (не рекомендуется) [DEPRECATED] |
Передает набор потенциальных клиентов в кампанию триггера для выполнения через поток кампании. (не рекомендуется) У указанной кампании должна быть запрошена кампания: триггер API веб-службы и должен быть активным. Мои маркеры, локальные в родительской программе кампании, можно переопределить для запуска, чтобы настроить содержимое. Для каждого вызова разрешено не более 100 потенциальных клиентов. Необходимые разрешения: выполнение кампании |
| Клонирование программы (не рекомендуется) [DEPRECATED] |
Клонирует целевую программу. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Клонировать смарт-список (не рекомендуется) [DEPRECATED] |
Клонирует назначенный смарт-список. Необходимые разрешения: Read-Write ресурс (не рекомендуется) |
| Обновление метаданных папки (не рекомендуется) [DEPRECATED] |
Обновляет метаданные для данной папки. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Обновление метаданных программы (не рекомендуется) [DEPRECATED] |
Обновляет метаданные целевой программы. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Обновление метаданных статического списка (не рекомендуется) [DEPRECATED] |
Обновляет метаданные статического ресурса списка. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Обновление поля потенциальных пользователей (не рекомендуется) [DEPRECATED] |
Обновите метаданные для поля свинца в целевом экземпляре. (не рекомендуется) Ознакомьтесь с правилами обновления. Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write |
| Обновление содержимого файла (не рекомендуется) [DEPRECATED] |
Заменяет текущее содержимое файла включенными полезными данными. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Обновление тега программы (не рекомендуется) [DEPRECATED] |
Обновление тега программы. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Описание свинца (не рекомендуется) [DEPRECATED] |
Возвращает метаданные о объектах свинца в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Описание Свинца2 (не рекомендуется) [DEPRECATED] |
Возвращает список полей, доступных для поиска, на объектах свинца в целевом экземпляре. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Описание участника программы (не рекомендуется) [DEPRECATED] |
Возвращает метаданные о объектах-членах программы в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Описание участника программы (не рекомендуется) [DEPRECATED] |
Возвращает метаданные о объектах-членах программы в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. Необходимые разрешения: Read-Only свинца, Read-Write свинца (не рекомендуется) |
| Отмена задания потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED] |
Отмена задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Отмена задания участника программы экспорта (не рекомендуется) [DEPRECATED] |
Отмена задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Планирование кампании (не рекомендуется) [DEPRECATED] |
Удаленно планирует выполнение пакетной кампании в определенное время. (не рекомендуется) Мои маркеры, локальные в родительской программе кампании, можно переопределить для запуска, чтобы настроить содержимое. При использовании параметра cloneToProgramName, описанного ниже, эта конечная точка ограничена 20 вызовами в день. Необходимые разрешения: выполнение кампании |
| Получение заданий потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED] |
Возвращает список заданий экспорта, созданных за последние 7 дней. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Получение заданий участников программы экспорта (не рекомендуется) [DEPRECATED] |
Возвращает список заданий экспорта, созданных за последние 7 дней. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Получение кампаний (не рекомендуется) [DEPRECATED] |
Возвращает список записей кампании. (не рекомендуется) Необходимые разрешения: кампании Read-Only, кампании Read-Write |
| Получение ошибок импорта потенциальных пользователей (не рекомендуется) [DEPRECATED] |
Возвращает список сбоев для пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Получение папки по идентификатору (не рекомендуется) [DEPRECATED] |
Возвращает запись папки с указанным идентификатором. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение папки по имени (не рекомендуется) [DEPRECATED] |
Возвращает запись папки для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение папок (не рекомендуется) [DEPRECATED] |
Извлекает дочерние папки из указанной корневой папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение поля свинца по имени (не рекомендуется) [DEPRECATED] |
Извлекает метаданные для одного поля свинца. (не рекомендуется) Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write |
| Получение поля участника программы по имени (не рекомендуется) [DEPRECATED] |
Извлекает метаданные для одного поля члена программы. (не рекомендуется) Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write |
| Получение потенциальных клиентов по идентификатору программы (не рекомендуется) [DEPRECATED] |
Извлекает список потенциальных клиентов, являющихся членами указанной программы. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Получение потенциальных клиентов по идентификатору списка (не рекомендуется) [DEPRECATED] |
Извлекает записи пользователя, которые являются членами заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Получение потенциальных клиентов по идентификатору списка (не рекомендуется) [DEPRECATED] |
Извлекает записи пользователя, которые являются членами заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Получение потенциальных клиентов по типу фильтра (не рекомендуется) [DEPRECATED] |
Возвращает список до 300 потенциальных клиентов на основе списка значений в определенном поле. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Получение потенциальных пользователей по идентификатору (не рекомендуется) [DEPRECATED] |
Извлекает одну запись свинца с помощью идентификатора Marketo. (не рекомендуется) Обязательные разрешения: Read-Only свинца, Read-Write свинца |
| Получение предупреждений о потенциальных клиентах импорта (не рекомендуется) [DEPRECATED] |
Возвращает список предупреждений для задания пакетной службы импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Получение предупреждений участников программы импорта (не рекомендуется) [DEPRECATED] |
Возвращает список предупреждений для задания пакетной службы импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Получение программ (не рекомендуется) [DEPRECATED] |
Извлекает список доступных программ из целевого экземпляра. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение программ по тегу (не рекомендуется) [DEPRECATED] |
Извлекает список программ, соответствующих типу тега и значениям тегов. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение программы по идентификатору (не рекомендуется) [DEPRECATED] |
Извлекает запись программы для заданного идентификатора. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение программы по имени (не рекомендуется) [DEPRECATED] |
Извлекает запись программы для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение сбоев элементов программы импорта (не рекомендуется) [DEPRECATED] |
Возвращает список сбоев для пакетного задания импорта. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Получение смарт-списка по идентификатору (не рекомендуется) [DEPRECATED] |
Извлекает запись смарт-списка по идентификатору. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется) |
| Получение смарт-списка по идентификатору программы (не рекомендуется) [DEPRECATED] |
Извлекает запись смарт-списка по идентификатору программы электронной почты. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется) |
| Получение смарт-списка по имени (не рекомендуется) [DEPRECATED] |
Извлекает запись смарт-списка по имени. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется) |
| Получение смарт-списков (не рекомендуется) [DEPRECATED] |
Извлекает список созданных пользователем записей Smart List. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется) |
| Получение содержимого папки (не рекомендуется) [DEPRECATED] |
Возвращает записи для содержимого заданной папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение состояния задания потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED] |
Возвращает состояние задания экспорта. (не рекомендуется) Состояние задания доступно в течение 30 дней после достижения состояния "Завершено" или "Сбой". Необходимые разрешения: Read-Only свинца |
| Получение состояния задания участника программы экспорта (не рекомендуется) [DEPRECATED] |
Возвращает состояние задания экспорта. Состояние задания доступно в течение 30 дней после достижения состояния "Завершено" или "Сбой". Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Получение состояния потенциальных пользователей импорта (не рекомендуется) [DEPRECATED] |
Возвращает состояние пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Получение состояния члена программы импорта (не рекомендуется) [DEPRECATED] |
Возвращает состояние пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется) |
| Получение списка по идентификатору (не рекомендуется) [DEPRECATED] |
Возвращает запись списка по идентификатору. (не рекомендуется) Обязательные разрешения: Read-Only свинца, Read-Write свинца |
| Получение списков (не рекомендуется) [DEPRECATED] |
Возвращает набор статических записей списка на основе заданных параметров фильтра. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца |
| Получение статических списков (не рекомендуется) [DEPRECATED] |
Извлекает список записей статического списка. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется) |
| Получение статического списка по идентификатору (не рекомендуется) [DEPRECATED] |
Извлекает запись статического списка по идентификатору. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется) |
| Получение статического списка по имени (не рекомендуется) [DEPRECATED] |
Извлекает запись статического списка по имени. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется) |
| Получение участников программы (не рекомендуется) [DEPRECATED] |
Возвращает список до 300 членов программы в списке значений в определенном поле. Если указать тип фильтра, который является настраиваемым полем, тип данных настраиваемого поля должен быть строковым или целым числом. Если указать тип фильтра, отличный от "leadId", можно обрабатывать не более 100 000 записей участников программы. Необходимые разрешения: Read-Only свинца, Read-Write свинца (не рекомендуется) |
| Получение файла по идентификатору (не рекомендуется) [DEPRECATED] |
Возвращает запись файла для заданного идентификатора. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение файла по имени (не рекомендуется) [DEPRECATED] |
Возвращает записи файлов для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Получение файла потенциальных пользователей экспорта (не рекомендуется) [DEPRECATED] |
Возвращает содержимое файла задания экспорта. (не рекомендуется) Задание экспорта должно находиться в состоянии "Завершено". Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца |
| Получение файла участника программы экспорта (не рекомендуется) [DEPRECATED] |
Возвращает содержимое файла задания экспорта. (не рекомендуется) Задание экспорта должно находиться в состоянии "Завершено". Используйте конечную точку состояния задания участника программы экспорта, чтобы получить состояние задания экспорта. Необходимые разрешения: Read-Only свинца |
| Получение файлов (не рекомендуется) [DEPRECATED] |
Возвращает файлы из указанной папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется) |
| Синхронизация данных участника программы (не рекомендуется) [DEPRECATED] |
Изменяет данные члена программы списка потенциальных клиентов в целевой программе. (не рекомендуется) Только существующие члены программы могут изменить свои данные с помощью этого API. Необходимые разрешения: Read-Write свинца |
| Синхронизация потенциальных клиентов (не рекомендуется) [DEPRECATED] |
Синхронизирует список потенциальных клиентов с целевым экземпляром. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Создание задания потенциальных пользователей экспорта (не рекомендуется) [DEPRECATED] |
Создайте задание экспорта для условий поиска, определенных с помощью параметра filter. Запрос возвращает идентификатор exportId, который передается в качестве параметра в последующих вызовах конечных точек массового экспорта потенциальных клиентов. Используйте конечную точку задания экспорта enqueue для очереди задания экспорта для обработки. Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется) |
| Создание задания участника программы экспорта (не рекомендуется) [DEPRECATED] |
Создайте задание экспорта для условий поиска, определенных с помощью параметра filter. Запрос возвращает идентификатор exportId, который передается в качестве параметра в последующих вызовах конечных точек участников программы массового экспорта. (deprecated) |
| Создание папки (не рекомендуется) [DEPRECATED] |
Создает новую папку. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Создание программы (не рекомендуется) [DEPRECATED] |
Создает новую программу. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Создание статического списка (не рекомендуется) [DEPRECATED] |
Создает статический список. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Создание файла (не рекомендуется) [DEPRECATED] |
Создает новый файл из включенных полезных данных. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Состояние участника программы синхронизации (не рекомендуется) [DEPRECATED] |
Изменяет состояние участника программы списка потенциальных клиентов в целевой программе. (не рекомендуется) Если член не является частью программы, член добавляется в программу. Необходимые разрешения: Read-Write свинца |
| Удаление из списка (не рекомендуется) [DEPRECATED] |
Удаляет заданный набор записей пользователей из целевого статического списка. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Удаление папки (не рекомендуется) [DEPRECATED] |
Удаляет указанную папку. Удаление завершится ошибкой, если папка содержит содержимое. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Удаление потенциальных клиентов (не рекомендуется) [DEPRECATED] |
Удалите список потенциальных клиентов из конечного экземпляра. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Удаление программы (не рекомендуется) [DEPRECATED] |
Удаляет целевую программу. Программа не может содержать ресурсы, которые используются за пределами программы. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Удаление смарт-списка (не рекомендуется) [DEPRECATED] |
Удаляет назначенный смарт-список. Необходимые разрешения: Read-Write ресурс (не рекомендуется) |
| Удаление статического списка (не рекомендуется) [DEPRECATED] |
Удаляет указанный статический список. Необходимые разрешения: Read-Write ресурс (не рекомендуется) |
| Удаление тега программы (не рекомендуется) [DEPRECATED] |
Удаление тега программы, не требующегося. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Удаление участников программы (не рекомендуется) [DEPRECATED] |
Удалите список членов из конечного экземпляра. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
| Удостоверение (не рекомендуется) [DEPRECATED] |
Получение маркера доступа из Marketo. Вызовы этой конечной точки не учитываются в отношении ограничения вызовов API (не рекомендуется). |
| Удостоверение (не рекомендуется) [DEPRECATED] |
Получение маркера доступа из Marketo. Вызовы этой конечной точки не учитываются в отношении ограничения вызовов API (не рекомендуется). |
| Утверждение программы (не рекомендуется) [DEPRECATED] |
Утверждает целевую программу. Допустимо только для неподтвержденных программ электронной почты. Необходимые разрешения: Read-Write активы (не рекомендуется) |
| Член списка (не рекомендуется) [DEPRECATED] |
Проверяет, являются ли потенциальные участники заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Write свинца |
Get Campaign By Id (не рекомендуется) [DEPRECATED]
Возвращает запись кампании по идентификатору. (не рекомендуется) Необходимые разрешения: Read-Only кампании, Read-Write кампании
Примечание. Эта конечная точка была заменена. Вместо этого используйте конечную точку Get Smart Campaign by Id .
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
Возвращаемое значение
- Тело
- ResponseOfCampaign
Push Lead to Marketo (не рекомендуется) [DEPRECATED]
Upserts a lead и создает действие Push Lead to Marketo. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор целого числа записи свинца |
|
|
код
|
code | True | string |
Целый код причины |
|
сообщение
|
message | True | string |
Сообщение, описывающее причину состояния операции |
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
|
|
lookupField
|
lookupField | string | ||
|
partitionName
|
partitionName | string | ||
|
programName
|
programName | string | ||
|
programStatus
|
programStatus | string | ||
|
причина
|
reason | string | ||
|
source
|
source | string |
Возвращаемое значение
Unapprove Program (не рекомендуется) [DEPRECATED]
Не одобряет целевую программу. Допустимо только для утвержденных программ электронной почты. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Добавление в список (не рекомендуется) [DEPRECATED]
Добавляет заданный набор записей пользователей в целевой статический список. (не рекомендуется) Существует ограничение в 300 идентификаторов свинца на запрос. Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор целевого списка
|
listId | True | integer |
Идентификатор целевого списка |
|
id
|
id | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
Разделенный запятыми список идентификаторов свинца для добавления в список
|
id | array |
Разделенный запятыми список идентификаторов свинца для добавления в список |
Возвращаемое значение
Задание потенциальных пользователей в очереди (не рекомендуется) [DEPRECATED]
Задание экспорта в очередь. Это приведет к тому, что задание экспорта будет помещено в очередь и запустит задание, когда вычислительные ресурсы становятся доступными. Задание экспорта должно находиться в состоянии "Создано". Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Задание участника программы экспорта (не рекомендуется) [DEPRECATED]
Задание экспорта в очередь. Это приведет к тому, что задание экспорта будет помещено в очередь и запустит задание, когда вычислительные ресурсы становятся доступными. Задание экспорта должно находиться в состоянии "Создано". (deprecated)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Импорт потенциальных клиентов (не рекомендуется) [DEPRECATED]
Импортирует файл, содержащий записи данных, в целевой экземпляр. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Импорт формата файла.
|
format | True | string |
Импорт формата файла. |
|
Поле для дедупликации. Настраиваемые поля (строка, электронная почта, целое число)
|
lookupField | string |
Поле для дедупликации. Настраиваемые поля (string, email, integer) и следующие типы полей поддерживаются: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. По умолчанию используется электронная почта. |
|
|
Имя секции свинца для импорта.
|
partitionName | string |
Имя секции свинца для импорта. |
|
|
Идентификатор статического списка для импорта.
|
listId | integer |
Идентификатор статического списка для импорта. |
|
|
Файл, содержащий записи данных для импорта.
|
file | True | file |
Файл, содержащий записи данных для импорта. |
Возвращаемое значение
Импорт элементов программы (не рекомендуется) [DEPRECATED]
Импортирует файл, содержащий записи данных, в целевой экземпляр. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы для добавления участников.
|
programId | True | string |
Идентификатор программы для добавления участников. |
|
Состояние участника программы для добавляемых участников.
|
programMemberStatus | True | string |
Состояние участника программы для добавляемых участников. |
|
Импорт формата файла.
|
format | True | string |
Импорт формата файла. |
|
Файл, содержащий записи данных для импорта.
|
file | True | file |
Файл, содержащий записи данных для импорта. |
Возвращаемое значение
Кампания запросов (не рекомендуется) [DEPRECATED]
Передает набор потенциальных клиентов в кампанию триггера для выполнения через поток кампании. (не рекомендуется) У указанной кампании должна быть запрошена кампания: триггер API веб-службы и должен быть активным. Мои маркеры, локальные в родительской программе кампании, можно переопределить для запуска, чтобы настроить содержимое. Для каждого вызова разрешено не более 100 потенциальных клиентов. Необходимые разрешения: выполнение кампании
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании для активации
|
campaignId | True | integer |
Идентификатор кампании для активации |
|
id
|
id | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
имя
|
name | True | string |
Имя маркера. Должен быть отформатирован как {{my.name}" |
|
value
|
value | True | string |
Значение маркера |
Возвращаемое значение
- Тело
- ResponseOfCampaign
Клонирование программы (не рекомендуется) [DEPRECATED]
Клонирует целевую программу. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
|
описание
|
description | string | ||
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
|
имя
|
name | True | string |
Имя программы. Макс. 255 символов |
Возвращаемое значение
Клонировать смарт-список (не рекомендуется) [DEPRECATED]
Клонирует назначенный смарт-список. Необходимые разрешения: Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор смарт-списка для клонирования
|
id | True | integer |
Идентификатор смарт-списка для клонирования |
|
имя
|
name | True | string |
Имя клонированного смарт-списка |
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
|
описание
|
description | string |
Описание клонированного смарт-списка |
Возвращаемое значение
Обновление метаданных папки (не рекомендуется) [DEPRECATED]
Обновляет метаданные для данной папки. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор папки для обновления
|
id | True | integer |
Идентификатор папки для обновления |
|
описание
|
description | string |
Описание ресурса |
|
|
isArchive
|
isArchive | boolean |
Является ли папка архивирована или нет. Переключение этого значения изменит состояние архивации папки |
|
|
имя
|
name | string |
Имя папки |
|
|
type
|
type | True | string |
Тип папки. "Папка" или "Программа" |
Возвращаемое значение
Обновление метаданных программы (не рекомендуется) [DEPRECATED]
Обновляет метаданные целевой программы. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
|
стоимость
|
cost | True | integer |
Сумма стоимости |
|
заметка
|
note | string |
Заметки о стоимости |
|
|
startDate
|
startDate | True | date-time |
Дата начала стоимости периода |
|
costsDestructiveUpdate
|
costsDestructiveUpdate | boolean |
Задайте значение true, чтобы уничтожить существующие затраты и заменить их указанными затратами |
|
|
описание
|
description | string |
Обновленное описание программы |
|
|
Дата окончания
|
endDate | string |
Дата окончания программы. Применимо к программам типа событий, электронной почты и вебинара |
|
|
имя
|
name | string |
Имя программы |
|
|
startDate
|
startDate | string |
Дата начала программы. Применимо к программам типа событий, электронной почты и вебинара |
|
|
tagType
|
tagType | string |
Тип тега программы |
|
|
значение тэга
|
tagValue | string |
Значение тега |
Возвращаемое значение
Обновление метаданных статического списка (не рекомендуется) [DEPRECATED]
Обновляет метаданные статического ресурса списка. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для обновления
|
id | True | integer |
Идентификатор статического списка для обновления |
|
описание
|
description | string |
Описание статического списка |
|
|
имя
|
name | string |
Имя статического списка |
Возвращаемое значение
Обновление поля потенциальных пользователей (не рекомендуется) [DEPRECATED]
Обновите метаданные для поля свинца в целевом экземпляре. (не рекомендуется) Ознакомьтесь с правилами обновления. Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя API поля свинца
|
fieldApiName | True | string |
Имя API поля свинца |
|
отображаемое имя
|
displayName | string |
Отображаемое имя пользовательского интерфейса поля |
|
|
описание
|
description | string |
Описание поля |
|
|
isHidden
|
isHidden | boolean |
Если задано значение true, поле скрыто. Значение по умолчанию — false. |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Если задано значение true, поле закодировано как HTML в сообщении электронной почты. Значение по умолчанию — true |
|
|
isSensitive
|
isSensitive | boolean |
Если задано значение true, поле помечается как конфиденциальное. Значение по умолчанию — false. |
Возвращаемое значение
Обновление содержимого файла (не рекомендуется) [DEPRECATED]
Заменяет текущее содержимое файла включенными полезными данными. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
id | True | integer |
Идентификатор файла в базе данных |
|
file
|
file | True | string |
Многопартийный файл. Содержимое файла. |
|
id
|
id | True | integer |
Идентификатор файла |
Возвращаемое значение
Обновление тега программы (не рекомендуется) [DEPRECATED]
Обновление тега программы. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
|
Тип тега программы
|
tagType | True | string |
Тип тега программы |
|
Значение тега программы
|
tagValue | True | string |
Значение тега программы |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Описание свинца (не рекомендуется) [DEPRECATED]
Возвращает метаданные о объектах свинца в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Примечание. Эта конечная точка была заменена. Вместо этого используйте конечную точку Lead2 .
Возвращаемое значение
Описание Свинца2 (не рекомендуется) [DEPRECATED]
Возвращает список полей, доступных для поиска, на объектах свинца в целевом экземпляре. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Возвращаемое значение
Описание участника программы (не рекомендуется) [DEPRECATED]
Возвращает метаданные о объектах-членах программы в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. Необходимые разрешения: Read-Only свинца, Read-Write свинца
Примечание. Эта конечная точка была заменена. Вместо этого используйте конечную точку участника программы. (deprecated)
Возвращаемое значение
Описание участника программы (не рекомендуется) [DEPRECATED]
Возвращает метаданные о объектах-членах программы в целевом экземпляре, включая список всех полей, доступных для взаимодействия через API. Необходимые разрешения: Read-Only свинца, Read-Write свинца (не рекомендуется)
Возвращаемое значение
Отмена задания потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED]
Отмена задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Отмена задания участника программы экспорта (не рекомендуется) [DEPRECATED]
Отмена задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Планирование кампании (не рекомендуется) [DEPRECATED]
Удаленно планирует выполнение пакетной кампании в определенное время. (не рекомендуется) Мои маркеры, локальные в родительской программе кампании, можно переопределить для запуска, чтобы настроить содержимое. При использовании параметра cloneToProgramName, описанного ниже, эта конечная точка ограничена 20 вызовами в день. Необходимые разрешения: выполнение кампании
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетной кампании для планирования.
|
campaignId | True | integer |
Идентификатор пакетной кампании для планирования. |
|
cloneToProgramName
|
cloneToProgramName | string |
Имя результирующей программы. При установке этот атрибут приведет к созданию кампании, родительской программы и всех его ресурсов с соответствующим новым именем. Родительская программа будет клонирована и будет запланирована только что созданная кампания. Результирующая программа создается под родительским элементом. Программы с фрагментами, push-уведомлениями, сообщениями в приложении, статическими списками, отчетами и социальными ресурсами не могут быть клонированы таким образом. |
|
|
runAt
|
runAt | date-time |
Дата и время выполнения кампании. Если не задано, кампания будет выполняться пять минут после вызова. |
|
|
имя
|
name | True | string |
Имя маркера. Должен быть отформатирован как {{my.name}" |
|
value
|
value | True | string |
Значение маркера |
Возвращаемое значение
- Тело
- ResponseOfCampaign
Получение заданий потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED]
Возвращает список заданий экспорта, созданных за последние 7 дней. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Разделенный запятыми список состояний для фильтрации.
|
status | array |
Разделенный запятыми список состояний для фильтрации. |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Следующий маркер страницы
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
Получение заданий участников программы экспорта (не рекомендуется) [DEPRECATED]
Возвращает список заданий экспорта, созданных за последние 7 дней. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Разделенный запятыми список состояний для фильтрации.
|
status | array |
Разделенный запятыми список состояний для фильтрации. |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Возвращается этой конечной точкой, если результирующий набор больше размера пакета.
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
Получение кампаний (не рекомендуется) [DEPRECATED]
Возвращает список записей кампании. (не рекомендуется) Необходимые разрешения: кампании Read-Only, кампании Read-Write
Примечание. Эта конечная точка была заменена. Вместо этого используйте конечную точку Смарт-кампаний .
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Разделенный запятыми список идентификаторов кампании для возврата записей
|
id | array |
Разделенный запятыми список идентификаторов кампании для возврата записей |
|
|
Разделенный запятыми список имен для фильтрации
|
name | array |
Разделенный запятыми список имен для фильтрации |
|
|
Разделенный запятыми список имен программ для фильтрации.
|
programName | array |
Разделенный запятыми список имен программ для фильтрации. Если задано, отфильтруется только по кампаниям, которые являются дочерними элементами назначенных программ. |
|
|
Разделенный запятыми список имен рабочих областей для фильтрации.
|
workspaceName | array |
Разделенный запятыми список имен рабочих областей для фильтрации. Если задано, будут возвращены только кампании в заданных рабочих областях. |
|
|
Максимальное количество возвращаемых записей. Максимальное значение и значение по умолчанию — 300.
|
batchSize | integer |
Максимальное количество возвращаемых записей. Максимальное значение и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
|
|
Значение "Запрашиваемый триггер" и источник — API веб-службы
|
isTriggerable | boolean |
Задайте значение true, чтобы вернуть активные кампании с запрошенным триггером кампании и источником является API веб-службы |
Возвращаемое значение
- Тело
- ResponseOfCampaign
Получение ошибок импорта потенциальных пользователей (не рекомендуется) [DEPRECATED]
Возвращает список сбоев для пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
- response
- object
Получение папки по идентификатору (не рекомендуется) [DEPRECATED]
Возвращает запись папки с указанным идентификатором. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор папки, извлекаемой
|
id | True | integer |
Идентификатор папки, извлекаемой |
|
Тип папки (программа или папка)
|
type | True | string |
Тип папки. "Папка" или "Программа" |
Возвращаемое значение
Получение папки по имени (не рекомендуется) [DEPRECATED]
Возвращает запись папки для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя папки
|
name | True | string |
Имя папки. Неприменимо для программ |
|
Тип папки (программа или папка)
|
type | string |
Тип папки. "Папка" или "Программа" |
|
|
Ссылка на родительскую папку
|
root | string |
Ссылка на родительскую папку |
|
|
Имя рабочей области
|
workSpace | string |
Имя рабочей области |
Возвращаемое значение
Получение папок (не рекомендуется) [DEPRECATED]
Извлекает дочерние папки из указанной корневой папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ссылка на родительскую папку
|
root | string |
Ссылка на родительскую папку |
|
|
Максимальная глубина папки для обхода по умолчанию 2
|
maxDepth | integer |
Максимальная глубина папки для обхода по умолчанию 2 |
|
|
Максимальное количество возвращаемых папок. По умолчанию 20, максимум 200
|
maxReturn | integer |
Максимальное количество возвращаемых папок. По умолчанию 20, максимум 200 |
|
|
Целочисленный смещение для разбиения по страницам. Значение по умолчанию 0
|
offset | integer |
Целочисленный смещение для разбиения по страницам. Значение по умолчанию 0 |
|
|
Имя рабочей области
|
workSpace | string |
Имя рабочей области |
Возвращаемое значение
Получение поля свинца по имени (не рекомендуется) [DEPRECATED]
Извлекает метаданные для одного поля свинца. (не рекомендуется) Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя API поля свинца
|
fieldApiName | True | string |
Имя API поля свинца |
Возвращаемое значение
- Тело
- ResponseOfLeadField
Получение поля участника программы по имени (не рекомендуется) [DEPRECATED]
Извлекает метаданные для одного поля члена программы. (не рекомендуется) Необходимые разрешения: Read-Write стандартное поле схемы, настраиваемое поле схемы Read-Write
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя API поля участника программы
|
fieldApiName | True | string |
Имя API поля участника программы |
Возвращаемое значение
- Тело
- ResponseOfLeadField
Получение потенциальных клиентов по идентификатору программы (не рекомендуется) [DEPRECATED]
Извлекает список потенциальных клиентов, являющихся членами указанной программы. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы, извлекаемой из
|
programId | True | integer |
Идентификатор программы, извлекаемой из |
|
Список полей, разделенных запятыми для каждой записи
|
fields | array |
Список полей, разделенных запятыми для каждой записи |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
- Тело
- ResponseOfLead
Получение потенциальных клиентов по идентификатору списка (не рекомендуется) [DEPRECATED]
Извлекает записи пользователя, которые являются членами заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для получения записей из
|
listId | True | integer |
Идентификатор статического списка для получения записей из |
|
Разделенный запятыми список полей свинца, возвращаемых для каждой записи.
|
fields | array |
Разделенный запятыми список полей свинца, возвращаемых для каждой записи. Если параметр unset вернет сообщение электронной почты, обновлено, создано, lastName, firstName и id |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
- Тело
- ResponseOfLead
Получение потенциальных клиентов по идентификатору списка (не рекомендуется) [DEPRECATED]
Извлекает записи пользователя, которые являются членами заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для получения записей из
|
listId | True | integer |
Идентификатор статического списка для получения записей из |
|
Разделенный запятыми список полей свинца, возвращаемых для каждой записи.
|
fields | array |
Разделенный запятыми список полей свинца, возвращаемых для каждой записи. Если параметр unset вернет сообщение электронной почты, обновлено, создано, lastName, firstName и id |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
Получение потенциальных клиентов по типу фильтра (не рекомендуется) [DEPRECATED]
Возвращает список до 300 потенциальных клиентов на основе списка значений в определенном поле. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поле свинца для фильтрации.
|
filterType | True | string |
Поле свинца для фильтрации. Любое настраиваемое поле (только для строк, электронной почты или целочисленных типов) и любое из следующих полей: файлы cookie, email, facebookId, id, leadPartitionId, linkedInId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. |
|
Разделенный запятыми список значений для фильтрации в указанных полях.
|
filterValues | True | array |
Разделенный запятыми список значений для фильтрации в указанных полях. |
|
Разделенный запятыми список полей свинца, возвращаемых для каждой записи.
|
fields | array |
Разделенный запятыми список полей свинца, возвращаемых для каждой записи. |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
- Тело
- ResponseOfLead
Получение потенциальных пользователей по идентификатору (не рекомендуется) [DEPRECATED]
Извлекает одну запись свинца с помощью идентификатора Marketo. (не рекомендуется) Обязательные разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор свинца Marketo
|
leadId | True | integer |
Идентификатор свинца Marketo |
|
Разделенный запятыми список имен полей.
|
fields | array |
Разделенный запятыми список имен полей. Если опущено, будут возвращены следующие поля по умолчанию: email, updatedAt, createdAt, lastName, firstName и id. |
Возвращаемое значение
- Тело
- ResponseOfLead
Получение предупреждений о потенциальных клиентах импорта (не рекомендуется) [DEPRECATED]
Возвращает список предупреждений для задания пакетной службы импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
- response
- object
Получение предупреждений участников программы импорта (не рекомендуется) [DEPRECATED]
Возвращает список предупреждений для задания пакетной службы импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
- response
- object
Получение программ (не рекомендуется) [DEPRECATED]
Извлекает список доступных программ из целевого экземпляра. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20
|
maxReturn | integer |
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20 |
|
|
Смещение целых чисел для разбиения по страницам
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
|
|
Необязательный фильтр. Требуется filterValues
|
filterType | string |
Необязательный фильтр. Требуется filterValues |
|
|
Исключите программы до этой даты. См. описание типа поля Datetime.
|
earliestUpdatedAt | string |
Исключите программы до этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
|
|
Исключите программы после этой даты. См. описание типа поля Datetime.
|
latestUpdatedAt | string |
Исключите программы после этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
Возвращаемое значение
Получение программ по тегу (не рекомендуется) [DEPRECATED]
Извлекает список программ, соответствующих типу тега и значениям тегов. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип тега программы
|
tagType | True | string |
Тип тега программы |
|
Значение тега
|
tagValue | True | string |
Значение тега |
|
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20
|
maxReturn | integer |
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20 |
|
|
Смещение целых чисел для разбиения по страницам
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
Возвращаемое значение
Получение программы по идентификатору (не рекомендуется) [DEPRECATED]
Извлекает запись программы для заданного идентификатора. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
Возвращаемое значение
Получение программы по имени (не рекомендуется) [DEPRECATED]
Извлекает запись программы для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя программы
|
name | True | string |
Имя программы |
|
Задайте значение true для заполнения тегов программы
|
includeTags | boolean |
Задайте значение true для заполнения тегов программы |
|
|
Задайте значение true для заполнения затрат на программу
|
includeCosts | boolean |
Задайте значение true для заполнения затрат на программу |
Возвращаемое значение
Получение сбоев элементов программы импорта (не рекомендуется) [DEPRECATED]
Возвращает список сбоев для пакетного задания импорта. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
- response
- object
Получение смарт-списка по идентификатору (не рекомендуется) [DEPRECATED]
Извлекает запись смарт-списка по идентификатору. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор интеллектуального списка для получения
|
id | True | integer |
Идентификатор интеллектуального списка для получения |
|
Задайте значение true для заполнения правил смарт-списка. Значение false по умолчанию
|
includeRules | boolean |
Задайте значение true для заполнения правил смарт-списка. Значение false по умолчанию |
Возвращаемое значение
Получение смарт-списка по идентификатору программы (не рекомендуется) [DEPRECATED]
Извлекает запись смарт-списка по идентификатору программы электронной почты. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы электронной почты, содержащей смарт-список для получения
|
programId | True | integer |
Идентификатор программы электронной почты, содержащей смарт-список для получения |
|
Задайте значение true для заполнения правил смарт-списка. Значение false по умолчанию
|
includeRules | boolean |
Задайте значение true для заполнения правил смарт-списка. Значение false по умолчанию |
Возвращаемое значение
Получение смарт-списка по имени (не рекомендуется) [DEPRECATED]
Извлекает запись смарт-списка по имени. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя интеллектуального списка для получения
|
name | True | string |
Имя интеллектуального списка для получения |
Возвращаемое значение
Получение смарт-списков (не рекомендуется) [DEPRECATED]
Извлекает список созданных пользователем записей Smart List. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Представление JSON родительской папки
|
folder | string |
Представление JSON родительской папки с элементами "id" и "type", которые могут быть "Папка" или "Программа" |
|
|
Смещение целых чисел для разбиения по страницам
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
|
|
Максимальное количество возвращаемых смарт-списков. Максимальное значение 200, значение по умолчанию — 20.
|
maxReturn | integer |
Максимальное количество возвращаемых смарт-списков. Максимальное значение 200, значение по умолчанию — 20. |
|
|
Исключите смарт-списки до этой даты. См. описание типа поля Datetime.
|
earliestUpdatedAt | string |
Исключите смарт-списки до этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
|
|
Исключите смарт-списки после этой даты. См. описание типа поля Datetime.
|
latestUpdatedAt | string |
Исключите смарт-списки после этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
Возвращаемое значение
Получение содержимого папки (не рекомендуется) [DEPRECATED]
Возвращает записи для содержимого заданной папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор папки, извлекаемой
|
id | True | integer |
Идентификатор папки, извлекаемой |
|
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20
|
maxReturn | integer |
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20 |
|
|
Смещение целых чисел для разбиения по страницам
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
|
|
Тип папки. "Папка" или "Программа". Значение по умолчанию — "Папка"
|
type | True | string |
Тип папки. "Папка" или "Программа". Значение по умолчанию — "Папка" |
Возвращаемое значение
Получение состояния задания потенциальных потенциальных пользователей (не рекомендуется) [DEPRECATED]
Возвращает состояние задания экспорта. (не рекомендуется) Состояние задания доступно в течение 30 дней после достижения состояния "Завершено" или "Сбой". Необходимые разрешения: Read-Only свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Получение состояния задания участника программы экспорта (не рекомендуется) [DEPRECATED]
Возвращает состояние задания экспорта. Состояние задания доступно в течение 30 дней после достижения состояния "Завершено" или "Сбой". Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
Возвращаемое значение
Получение состояния потенциальных пользователей импорта (не рекомендуется) [DEPRECATED]
Возвращает состояние пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
Получение состояния члена программы импорта (не рекомендуется) [DEPRECATED]
Возвращает состояние пакетного задания импорта. Необходимые разрешения: Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания пакетной службы импорта.
|
batchId | True | integer |
Идентификатор задания пакетной службы импорта. |
Возвращаемое значение
Получение списка по идентификатору (не рекомендуется) [DEPRECATED]
Возвращает запись списка по идентификатору. (не рекомендуется) Обязательные разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для получения записей из
|
listId | True | integer |
Идентификатор статического списка для получения записей из |
Возвращаемое значение
- Тело
- ResponseOfStaticList
Получение списков (не рекомендуется) [DEPRECATED]
Возвращает набор статических записей списка на основе заданных параметров фильтра. (не рекомендуется) Необходимые разрешения: Read-Only свинца, Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Разделенный запятыми список статических идентификаторов списков для возврата
|
id | array |
Разделенный запятыми список статических идентификаторов списков для возврата |
|
|
Разделенный запятыми список статических имен списков для возврата
|
name | array |
Разделенный запятыми список статических имен списков для возврата |
|
|
Разделенный запятыми список имен программ.
|
programName | array |
Разделенный запятыми список имен программ. Если набор вернет все статические списки, которые являются дочерними элементами заданных программ |
|
|
Разделенный запятыми список имен рабочих областей.
|
workspaceName | array |
Разделенный запятыми список имен рабочих областей. Если набор вернет все статические списки, которые являются дочерними элементами заданных рабочих областей |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер будет возвращен этой конечной точкой. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам".
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
- Тело
- ResponseOfStaticList
Получение статических списков (не рекомендуется) [DEPRECATED]
Извлекает список записей статического списка. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Представление JSON родительской папки
|
folder | string |
Представление JSON родительской папки с элементами "id" и "type", которые могут быть "Папка" или "Программа" |
|
|
Смещение целых чисел для разбиения по страницам
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
|
|
Максимальное количество возвращаемых статических списков. Максимальное значение 200, значение по умолчанию — 20.
|
maxReturn | integer |
Максимальное количество возвращаемых статических списков. Максимальное значение 200, значение по умолчанию — 20. |
|
|
Исключите статические списки до этой даты. См. описание типа поля Datetime.
|
earliestUpdatedAt | string |
Исключите статические списки до этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
|
|
Исключите статические списки после этой даты. См. описание типа поля Datetime.
|
latestUpdatedAt | string |
Исключите статические списки после этой даты. Должна быть допустима строка ISO-8601. См. описание типа поля Datetime . |
Возвращаемое значение
Получение статического списка по идентификатору (не рекомендуется) [DEPRECATED]
Извлекает запись статического списка по идентификатору. Необходимые разрешения: Read-Asset или Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для получения
|
id | True | integer |
Идентификатор статического списка для получения |
Возвращаемое значение
Получение статического списка по имени (не рекомендуется) [DEPRECATED]
Извлекает запись статического списка по имени. Необходимые разрешения: Read-Asset или ресурс Read-Write (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя статического списка для получения
|
name | True | string |
Имя статического списка для получения |
Возвращаемое значение
Получение участников программы (не рекомендуется) [DEPRECATED]
Возвращает список до 300 членов программы в списке значений в определенном поле. Если указать тип фильтра, который является настраиваемым полем, тип данных настраиваемого поля должен быть строковым или целым числом. Если указать тип фильтра, отличный от "leadId", можно обрабатывать не более 100 000 записей участников программы. Необходимые разрешения: Read-Only свинца, Read-Write свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор целевой программы.
|
programId | True | integer |
Идентификатор целевой программы. |
|
Поле члена программы для фильтрации.
|
filterType | True | string |
Поле члена программы для фильтрации. Любое настраиваемое поле (только строковые или целые типы), "обновлено" или любое поле, доступное для поиска. Поля, доступные для поиска, можно получить с помощью конечной точки "Описание участника программы ". |
|
Разделенный запятыми список значений для фильтрации в указанных полях.
|
filterValues | True | array |
Разделенный запятыми список значений для фильтрации в указанных полях. |
|
При использовании filterType=updatedAt начало фильтра диапазона дат
|
startAt | string |
При использовании filterType=updatedAt начало фильтра диапазона дат (iso 8601-format) |
|
|
При использовании filterType=updatedAt конец фильтра диапазона дат
|
endAt | string |
При использовании filterType=updatedAt конец фильтра диапазона дат (iso 8601-format) |
|
|
Разделенный запятыми список полей свинца, возвращаемых для каждой записи.
|
fields | array |
Разделенный запятыми список полей свинца, возвращаемых для каждой записи. |
|
|
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300.
|
batchSize | integer |
Возвращаемый размер пакета. Максимальное и значение по умолчанию — 300. |
|
|
Маркер возвращается, если результирующий набор больше размера пакета.
|
nextPageToken | string |
Маркер возвращается этой конечной точкой, если результирующий набор больше размера пакета и может передаваться в последующий вызов с помощью этого параметра. Дополнительные сведения см. в разделе "Маркеры разбиения по страницам". |
Возвращаемое значение
Получение файла по идентификатору (не рекомендуется) [DEPRECATED]
Возвращает запись файла для заданного идентификатора. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
id | True | integer |
Идентификатор файла в базе данных |
Возвращаемое значение
Получение файла по имени (не рекомендуется) [DEPRECATED]
Возвращает записи файлов для заданного имени. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя файла
|
name | True | string |
Имя файла |
Возвращаемое значение
Получение файла потенциальных пользователей экспорта (не рекомендуется) [DEPRECATED]
Возвращает содержимое файла задания экспорта. (не рекомендуется) Задание экспорта должно находиться в состоянии "Завершено". Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца
Формат файла указывается путем вызова конечной точки задания создания потенциальных потенциальных объектов. Ниже приведен пример формата файла по умолчанию ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
|
Поддержка частичного извлечения извлеченных данных
|
Range | string |
Для поддержки частичного извлечения извлеченных данных можно указать заголовок HTTP "Range" типа "байт". Дополнительные сведения см. в статье RFC 2616 "Запросы на получение диапазона". Если заголовок не задан, будет возвращено все содержимое. |
Возвращаемое значение
- response
- object
Получение файла участника программы экспорта (не рекомендуется) [DEPRECATED]
Возвращает содержимое файла задания экспорта. (не рекомендуется) Задание экспорта должно находиться в состоянии "Завершено". Используйте конечную точку состояния задания участника программы экспорта, чтобы получить состояние задания экспорта. Необходимые разрешения: Read-Only свинца
Формат файла задается путем вызова конечной точки задания создания участника программы экспорта. Ниже приведен пример формата файла по умолчанию ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакетного задания экспорта.
|
exportId | True | string |
Идентификатор пакетного задания экспорта. |
|
Для поддержки частичного извлечения извлеченных данных.
|
Range | string |
Для поддержки частичного извлечения извлеченных данных можно указать заголовок HTTP "Range" типа "байт". Дополнительные сведения см. в статье RFC 2616 "Запросы на получение диапазона". Если заголовок не задан, будет возвращено все содержимое. |
Возвращаемое значение
- response
- object
Получение файлов (не рекомендуется) [DEPRECATED]
Возвращает файлы из указанной папки. Необходимые разрешения: Read-Only активы, Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
|
maxReturn
|
maxReturn | integer |
Максимальное количество возвращаемых каналов. Максимальное значение 200, по умолчанию 20 |
|
|
offset
|
offset | integer |
Смещение целых чисел для разбиения по страницам |
|
|
Папка, в которой нужно поместить файл
|
folder | string |
Представление JSON родительской папки с элементами "id" и "type", которые могут быть "Папка" или "Программа" |
Возвращаемое значение
Синхронизация данных участника программы (не рекомендуется) [DEPRECATED]
Изменяет данные члена программы списка потенциальных клиентов в целевой программе. (не рекомендуется) Только существующие члены программы могут изменить свои данные с помощью этого API. Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор целевой программы.
|
programId | True | integer |
Идентификатор целевой программы. |
|
leadId
|
leadId | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
{fieldApiName}
|
{fieldApiName} | True | string |
Имя поля для обновления. Должен быть обновлен, как описано в конечной точке участника программы описания . |
|
{fieldApiName2}
|
{fieldApiName2} | string |
Имя API другого поля для обновления (и т. д.). Должен быть обновлен, как описано в конечной точке участника программы описания . |
Возвращаемое значение
Синхронизация потенциальных клиентов (не рекомендуется) [DEPRECATED]
Синхронизирует список потенциальных клиентов с целевым экземпляром. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
действие
|
action | string |
Тип операции синхронизации для выполнения. Значение по умолчанию для созданияOrUpdate при отмене набора |
|
|
asyncProcessing
|
asyncProcessing | boolean |
Если задано значение true, вызов возвращается немедленно. |
|
|
id
|
id | integer |
Уникальный идентификатор целого числа записи свинца |
|
|
acquiredBy
|
acquiredBy | boolean |
Получение свинца родительской программой |
|
|
isExhausted
|
isExhausted | boolean |
Исчерпан ли в данный момент свинца в потоке, если применимо |
|
|
членствоdate
|
membershipDate | True | string |
Дата, когда ведущий впервые стал членом программы |
|
nurtureCadence
|
nurtureCadence | string |
Каденция родительского потока, если применимо |
|
|
progressionStatus
|
progressionStatus | True | string |
Состояние программы свинца в родительской программе |
|
reachedSuccess
|
reachedSuccess | boolean |
Указывает, находится ли руководитель в состоянии успешности в родительской программе |
|
|
поток
|
stream | string |
Потоковая передача, в которую входит ведущий, если родительская программа является программой взаимодействия |
|
|
код
|
code | True | string |
Целый код причины |
|
сообщение
|
message | True | string |
Сообщение, описывающее причину состояния операции |
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
|
|
lookupField
|
lookupField | string |
Поле для дедупликации. Поле должно присутствовать в каждой записи свинца входных данных. По умолчанию используется сообщение электронной почты, если не задано |
|
|
partitionName
|
partitionName | string |
Имя секции для работы, если применимо. При взаимодействии с экземпляром, где включены секции, следует задать каждый раз, когда это возможно. |
Возвращаемое значение
- Тело
- ResponseOfLead
Создание задания потенциальных пользователей экспорта (не рекомендуется) [DEPRECATED]
Создайте задание экспорта для условий поиска, определенных с помощью параметра filter. Запрос возвращает идентификатор exportId, который передается в качестве параметра в последующих вызовах конечных точек массового экспорта потенциальных клиентов. Используйте конечную точку задания экспорта enqueue для очереди задания экспорта для обработки. Используйте конечную точку состояния задания экспорта для получения состояния задания экспорта. Необходимые разрешения: Read-Only свинца (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
имя
|
name | True | string |
Имя REST API для поля заголовка |
|
value
|
value | True | string |
Значение поля заголовка |
|
столбцов
|
fields | True | array of string |
Разделенный запятыми список полей для включения в файл |
|
endAt
|
endAt | string |
Фильтр диапазона дат (формат ISO 8601) |
|
|
startAt
|
startAt | string |
Начало фильтра диапазона дат (формат ISO-8601) |
|
|
smartListId
|
smartListId | True | integer |
Идентификатор смарт-списка для получения потенциальных клиентов |
|
smartListName
|
smartListName | True | string |
Имя интеллектуального списка для получения потенциальных клиентов |
|
staticListId
|
staticListId | True | integer |
Идентификатор статического списка для получения потенциальных клиентов |
|
staticListName
|
staticListName | True | string |
Имя статического списка для получения потенциальных клиентов |
|
format
|
format | string |
Формат файла для создания("CSV", "TSV", "SSV"). Значение по умолчанию — CSV |
Возвращаемое значение
Создание задания участника программы экспорта (не рекомендуется) [DEPRECATED]
Создайте задание экспорта для условий поиска, определенных с помощью параметра filter. Запрос возвращает идентификатор exportId, который передается в качестве параметра в последующих вызовах конечных точек участников программы массового экспорта. (deprecated)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
имя
|
name | True | string |
Имя REST API для поля заголовка |
|
value
|
value | True | string |
Значение поля заголовка |
|
столбцов
|
fields | True | array of string |
Разделенный запятыми список полей для включения в файл |
|
programId
|
programId | True | integer |
Идентификатор программы, из которого извлекаются элементы. Невозможно использовать в сочетании с фильтром programIds |
|
programIds
|
programIds | True | array of integer |
Массив идентификаторов программы, из которого извлекаются элементы. Невозможно использовать в сочетании с фильтром programId |
|
isExhausted
|
isExhausted | boolean |
Фильтрация записей членства в программе для пользователей, у которых исчерпано содержимое |
|
|
nurtureCadence
|
nurtureCadence | string |
Фильтрация записей членства в программе для заданной каденции |
|
|
statusNames
|
statusNames | array of string |
Массив имен состояний участника программы. Может быть задано значение по умолчанию и (или) определяемое пользователем. Несколько имен состояний — ORed вместе. |
|
|
endAt
|
endAt | string |
Фильтр диапазона дат (формат ISO 8601) |
|
|
startAt
|
startAt | string |
Начало фильтра диапазона дат (формат ISO-8601) |
|
|
format
|
format | string |
Формат файла для создания("CSV", "TSV", "SSV"). Значение по умолчанию — CSV |
Возвращаемое значение
Создание папки (не рекомендуется) [DEPRECATED]
Создает новую папку. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
описание
|
description | string |
Описание ресурса |
|
|
имя
|
name | True | string |
Имя папки |
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
Возвращаемое значение
Создание программы (не рекомендуется) [DEPRECATED]
Создает новую программу. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
канал
|
channel | True | string |
Канал программы |
|
стоимость
|
cost | True | integer |
Сумма стоимости |
|
заметка
|
note | string |
Заметки о стоимости |
|
|
startDate
|
startDate | True | date-time |
Дата начала стоимости периода |
|
описание
|
description | string | ||
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
|
имя
|
name | True | string |
Имя программы |
|
tagType
|
tagType | string |
Тип тега программы |
|
|
значение тэга
|
tagValue | string |
Значение тега |
|
|
type
|
type | True | string |
Тип программы |
Возвращаемое значение
Создание статического списка (не рекомендуется) [DEPRECATED]
Создает статический список. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
описание
|
description | string |
Описание статического списка |
|
|
имя
|
name | True | string |
Имя статического списка |
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
Возвращаемое значение
Создание файла (не рекомендуется) [DEPRECATED]
Создает новый файл из включенных полезных данных. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
описание
|
description | string |
Описание ресурса |
|
|
file
|
file | True | string |
Многопартийный файл. Содержимое файла. |
|
id
|
id | True | integer |
Идентификатор папки |
|
type
|
type | True | string |
Тип папки |
|
insertOnly
|
insertOnly | boolean |
Сбой вызовов, если уже существует существующий файл с тем же именем. |
|
|
имя
|
name | True | string |
Имя файла |
Возвращаемое значение
Состояние участника программы синхронизации (не рекомендуется) [DEPRECATED]
Изменяет состояние участника программы списка потенциальных клиентов в целевой программе. (не рекомендуется) Если член не является частью программы, член добавляется в программу. Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор целевой программы.
|
programId | True | integer |
Идентификатор целевой программы. |
|
statusName
|
statusName | True | string |
Состояние участника программы |
|
leadId
|
leadId | True | integer |
Уникальный идентификатор целого числа записи свинца |
Возвращаемое значение
Удаление из списка (не рекомендуется) [DEPRECATED]
Удаляет заданный набор записей пользователей из целевого статического списка. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для удаления потенциальных клиентов
|
listId | True | integer |
Идентификатор статического списка для удаления потенциальных клиентов |
|
id
|
id | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
id
|
id | True | array |
id |
Возвращаемое значение
Удаление папки (не рекомендуется) [DEPRECATED]
Удаляет указанную папку. Удаление завершится ошибкой, если папка содержит содержимое. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор папки для удаления
|
id | True | integer |
Идентификатор папки для удаления |
|
тип папки
|
type | True | string |
type |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Удаление потенциальных клиентов (не рекомендуется) [DEPRECATED]
Удалите список потенциальных клиентов из конечного экземпляра. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
Параметр можно указать, если текст запроса пуст.
|
id | array |
Параметр можно указать, если текст запроса пуст. Можно указать несколько идентификаторов свинца. например, id=1,2,3,2342 |
Возвращаемое значение
- Тело
- ResponseOfLead
Удаление программы (не рекомендуется) [DEPRECATED]
Удаляет целевую программу. Программа не может содержать ресурсы, которые используются за пределами программы. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Удаление смарт-списка (не рекомендуется) [DEPRECATED]
Удаляет назначенный смарт-список. Необходимые разрешения: Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор интеллектуального списка для удаления
|
id | True | integer |
Идентификатор интеллектуального списка для удаления |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Удаление статического списка (не рекомендуется) [DEPRECATED]
Удаляет указанный статический список. Необходимые разрешения: Read-Write ресурс (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для удаления
|
id | True | integer |
Идентификатор статического списка для удаления |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Удаление тега программы (не рекомендуется) [DEPRECATED]
Удаление тега программы, не требующегося. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
|
Тип тега программы
|
tagType | True | string |
Тип тега программы |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Удаление участников программы (не рекомендуется) [DEPRECATED]
Удалите список членов из конечного экземпляра. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор целевой программы.
|
programId | True | integer |
Идентификатор целевой программы. |
|
leadId
|
leadId | True | integer |
Уникальный идентификатор целого числа записи свинца |
Возвращаемое значение
Удостоверение (не рекомендуется) [DEPRECATED]
Получение маркера доступа из Marketo. Вызовы этой конечной точки не учитываются в отношении ограничения вызовов API (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор клиента для REST API Marketo
|
client_id | True | string |
Идентификатор клиента из меню "Запуск интеграции > администрирования>". |
|
Секрет клиента для REST API Marketo
|
client_secret | True | string |
Меню "Секрет клиента" из меню "Запуск интеграции администрирования >> ". |
|
Тип гранта. Наши учетные данные клиента
|
grant_type | True | string |
Тип предоставления. |
Возвращаемое значение
- Тело
- ResponseOfIdentity
Удостоверение (не рекомендуется) [DEPRECATED]
Получение маркера доступа из Marketo. Вызовы этой конечной точки не учитываются в отношении ограничения вызовов API (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор клиента для REST API Marketo
|
client_id | True | string |
Идентификатор клиента из меню "Запуск интеграции > администрирования>". |
|
Секрет клиента для REST API Marketo
|
client_secret | True | string |
Меню "Секрет клиента" из меню "Запуск интеграции администрирования >> ". |
|
Тип гранта. Наши учетные данные клиента
|
grant_type | True | string |
Тип предоставления. |
Возвращаемое значение
- Тело
- ResponseOfIdentity
Утверждение программы (не рекомендуется) [DEPRECATED]
Утверждает целевую программу. Допустимо только для неподтвержденных программ электронной почты. Необходимые разрешения: Read-Write активы (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор программы
|
id | True | integer |
id |
Возвращаемое значение
- Тело
- ResponseOfIdResponse
Член списка (не рекомендуется) [DEPRECATED]
Проверяет, являются ли потенциальные участники заданного статического списка. (не рекомендуется) Необходимые разрешения: Read-Write свинца
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор статического списка для проверки
|
listId | True | integer |
Идентификатор статического списка для проверки |
|
id
|
id | True | integer |
Уникальный идентификатор целого числа записи свинца |
|
Разделенный запятыми список идентификаторов свинца для проверки
|
id | array |
Разделенный запятыми список идентификаторов свинца для проверки |
Возвращаемое значение
Определения
ResponseOfIdentity
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
access_token
|
access_token | string |
Маркер, который передается с последующими вызовами для проверки подлинности в целевом экземпляре |
|
scope
|
scope | string |
Пользователь, принадлежащий ТОЛЬКО API пользовательской службы, которая использовалась для проверки подлинности |
|
expires_in
|
expires_in | integer |
Оставшаяся продолжительность существования текущего маркера в секундах |
|
token_type
|
token_type | string |
Метод проверки подлинности OAuth |
ResponseOfStaticList
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of StaticList |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
Свинец
Запись свинца. Всегда содержит идентификатор, но может содержать любое количество других полей в зависимости от полей, доступных в целевом экземпляре.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор целого числа записи свинца |
|
членство
|
membership | ProgramMembership | |
|
причина
|
reason | Reason | |
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
LeadField
Запись поля свинца
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
отображаемое имя
|
displayName | string |
Отображаемое имя пользовательского интерфейса поля |
|
имя
|
name | string |
Имя API поля |
|
описание
|
description | string |
Описание поля |
|
тип данных
|
dataType | string |
Тип данных поля |
|
length
|
length | integer |
Максимальная длина поля. Применимо только к тексту, строке и текстовой области. |
|
isHidden
|
isHidden | boolean |
Если задано значение true, поле скрыто |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Если задано значение true, поле закодировано как HTML в сообщении электронной почты |
|
isSensitive
|
isSensitive | boolean |
Если задано значение true, поле помечается как конфиденциальное |
|
isCustom
|
isCustom | boolean |
Если задано значение true, поле настраивается |
|
isApiCreated
|
isApiCreated | boolean |
Если задано значение true, поле было создано с помощью REST API |
LeadFieldStatus
Состояние обновления поля свинца
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя API поля |
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
ListOperationOutputData
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор целого числа записи свинца |
|
Причин
|
reasons | array of Reason |
Список причин, по которым операция не завершилась успешно. Причины присутствуют только в ответах API и не должны быть отправлены |
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
LeadAttribute
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
тип данных
|
dataType | string |
Тип данных поля |
|
отображаемое имя
|
displayName | string |
Отображаемое имя пользовательского интерфейса поля |
|
id
|
id | integer |
Уникальный идентификатор целого числа поля |
|
length
|
length | integer |
Максимальная длина поля. Применимо только к тексту, строке и текстовой области. |
|
отдых
|
rest | LeadMapAttribute | |
|
мыло
|
soap | LeadMapAttribute |
LeadAttribute2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
"Ведущий API" |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Список полей, доступных для поиска |
|
столбцов
|
fields | array of LeadAttribute2Fields |
Описание полей, доступных для поиска |
LeadAttribute2SearchableFields
Список полей, доступных для поиска
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
string |
Поле с возможностью поиска |
LeadAttribute2Fields
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя поля REST API |
|
отображаемое имя
|
displayName | string |
Отображаемое имя поля (понятное имя) |
|
тип данных
|
dataType | string |
Тип данных поля |
|
length
|
length | integer |
Длина поля |
|
updateable
|
updateable | boolean |
Доступно ли обновление поля |
|
crmManaged
|
crmManaged | boolean |
Управляется ли поле CRM |
LeadAttribute2Fields2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя поля REST API |
|
отображаемое имя
|
displayName | string |
Отображаемое имя поля (понятное имя) |
|
тип данных
|
dataType | string |
Тип данных поля |
|
length
|
length | integer |
Длина поля |
|
updateable
|
updateable | boolean |
Доступно ли обновление поля |
|
crmManaged
|
crmManaged | boolean |
Управляется ли поле CRM |
ProgramMemberAttribute
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
"Член программы API" |
|
столбцов
|
fields | array of LeadAttribute2Fields |
Описание полей, доступных для поиска |
ProgramMemberAttribute2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
"Член программы API" |
|
описание
|
description | string |
"Карта участников программы API" |
|
createdAt
|
createdAt | string |
Дата и время создания |
|
обновлено
|
updatedAt | string |
Дата и время обновления |
|
dedupeFields
|
dedupeFields | array of string |
Список полей dedupe |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Список полей, доступных для поиска |
|
столбцов
|
fields | array of LeadAttribute2Fields2 |
Описание полей, доступных для поиска |
ResponseOfImportLeadResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ImportLeadResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ImportProgramMemberResponse
Ответ, содержащий сведения о состоянии импорта
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
batchId
|
batchId | integer |
Уникальный идентификатор целого числа задания импорта |
|
importId
|
importId | string |
Уникальный идентификатор целого числа задания импорта |
|
статус
|
status | string |
Состояние задания импорта |
ResponseOfImportProgramMemberResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ImportProgramMemberResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfCampaign
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of Campaign |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfListOperationOutputData
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ListOperationOutputData |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
кампания
Запись кампании Marketo Smart
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
активный
|
active | boolean |
Активна ли кампания. Применимо только к запускам кампаний |
|
createdAt
|
createdAt | string |
Дата и время создания кампании |
|
описание
|
description | string |
Описание интеллектуальной кампании |
|
id
|
id | integer |
Уникальный целочисленный идентификатор интеллектуальной кампании |
|
имя
|
name | string |
Имя интеллектуальной кампании |
|
programId
|
programId | integer |
Идентификатор родительской программы, если применимо |
|
programName
|
programName | string |
Имя родительской программы, если применимо |
|
type
|
type | string |
Тип интеллектуальной кампании |
|
обновлено
|
updatedAt | string |
Дата и время последнего обновления кампании |
|
имя рабочей области
|
workspaceName | string |
Имя родительской рабочей области, если применимо |
ResponseOfLead
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of Lead |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfLeadByListId
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of Lead |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfLeadField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of LeadField |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfUpdateLeadField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of LeadFieldStatus |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfPushLeadToMarketo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of Lead |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfLeadAttribute
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of LeadAttribute |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfLeadAttribute2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of LeadAttribute2 |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfProgramMemberAttributes
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMemberAttribute |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfProgramMemberAttributes2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMemberAttribute2 |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
Предупреждение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | integer |
Целый код предупреждения |
|
сообщение
|
message | string |
Сообщение, описывающее предупреждение |
ResponseOfExportResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ExportResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfExportResponseWithToken
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ExportResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfProgramMember
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMember |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ProgramMember
Запись участника программы. Всегда содержит идентификатор свинца, но может иметь любое количество других полей в зависимости от полей, доступных в целевом экземпляре.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
последовательный
|
seq | integer |
Целое число, указывающее последовательность записи в ответе. Это значение сопоставляется с порядком записей, включенных в входные данные запроса. Сек должен быть только частью ответов и не должен быть отправлен. |
|
leadId
|
leadId | integer |
Уникальный идентификатор целого числа записи свинца |
|
reachedSuccess
|
reachedSuccess | boolean |
Логическое значение, указывающее, достигнут ли член программы успешного выполнения программы |
|
programId
|
programId | integer |
Уникальный целочисленный идентификатор программы |
|
acquiredBy
|
acquiredBy | boolean |
Логическое значение, указывающее, был ли участник программы приобретен программой |
|
членствоdate
|
membershipDate | string |
Дата, когда ведущий впервые стал членом программы |
ResponseOfProgramMemberStatus
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMemberStatusResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfProgramMemberData
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMemberStatusResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ResponseOfProgramMemberDelete
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error |
Массив ошибок, которые произошли, если запрос был неудачным |
|
moreResult
|
moreResult | boolean |
Логическое значение, указывающее, есть ли дополнительные результаты на последующих страницах |
|
nextPageToken
|
nextPageToken | string |
Маркер разбиения на страницы, заданный, если результирующий набор превысил допустимый размер пакета |
|
requestId
|
requestId | string |
Идентификатор выполненного запроса |
|
результат
|
result | array of ProgramMemberDeleteResponse |
Массив результатов для отдельных записей в операции может быть пустым. |
|
success
|
success | boolean |
Успешно ли выполнен запрос |
|
Предупреждения
|
warnings | array of Warning |
Массив предупреждений, заданных для операции |
ImportLeadResponse
Ответ, содержащий сведения о состоянии импорта
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
batchId
|
batchId | integer |
Уникальный целочисленный идентификатор пакета импорта |
|
importId
|
importId | string | |
|
сообщение
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
Число обработанных до сих пор строк |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
Число строк завершилось сбоем до сих пор |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
Число строк с предупреждением до сих пор |
|
статус
|
status | string |
Состояние пакета |
ProgramMembership
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
acquiredBy
|
acquiredBy | boolean |
Получение свинца родительской программой |
|
isExhausted
|
isExhausted | boolean |
Исчерпан ли в данный момент свинца в потоке, если применимо |
|
членствоdate
|
membershipDate | string |
Дата, когда ведущий впервые стал членом программы |
|
nurtureCadence
|
nurtureCadence | string |
Каденция родительского потока, если применимо |
|
progressionStatus
|
progressionStatus | string |
Состояние программы свинца в родительской программе |
|
reachedSuccess
|
reachedSuccess | boolean |
Указывает, находится ли руководитель в состоянии успешности в родительской программе |
|
поток
|
stream | string |
Потоковая передача, в которую входит ведущий, если родительская программа является программой взаимодействия |
ExportResponse
Ответ, содержащий сведения о состоянии задания экспорта
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Дата создания запроса на экспорт |
|
errorMsg
|
errorMsg | string |
Сообщение об ошибке в случае состояния "Сбой" |
|
exportId
|
exportId | string |
Уникальный идентификатор задания экспорта |
|
размер файла
|
fileSize | integer |
Размер экспортированного файла в байтах. Это значение будет иметь значение только в том случае, если состояние "Завершено", в противном случае значение NULL |
|
fileChecksum
|
fileChecksum | string |
Хэш SHA-256 экспортированного файла. Это значение будет иметь значение только в том случае, если состояние "Завершено", в противном случае значение NULL |
|
Завершено
|
finishedAt | date-time |
Время завершения задания экспорта. Это значение будет иметь значение только в том случае, если состояние "Завершено" или "Сбой", в противном случае значение NULL |
|
format
|
format | string |
Формат файла, указанного в запросе (CSV, TSV, SSV) |
|
numberOfRecords
|
numberOfRecords | integer |
Количество записей в файле экспорта. Это значение будет иметь значение только в том случае, если состояние "Завершено", в противном случае значение NULL |
|
queuedAt
|
queuedAt | date-time |
Время экспорта очереди. Это значение будет иметь значение при достижении состояния "Queued", прежде чем это значение NULL |
|
startedAt
|
startedAt | date-time |
Время начала задания экспорта. Это значение будет иметь значение при достижении состояния "Обработка", прежде чем это значение NULL |
|
статус
|
status | string |
Состояние задания экспорта ("Создано","Очередь","Обработка","Отмена","Завершено","Сбой") |
Причина
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Целый код причины |
|
сообщение
|
message | string |
Сообщение, описывающее причину состояния операции |
LeadMapAttribute
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя атрибута |
|
Только для чтения
|
readOnly | boolean |
Является ли атрибут только чтением |
Ошибка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Код ошибки. Полный список кодов ошибок см. здесь |
|
сообщение
|
message | string |
Сообщение, описывающее причину ошибки |
ProgramMemberStatusResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
|
Причин
|
reasons | array of Reason |
Список причин, по которым операция не завершилась успешно. Причины присутствуют только в ответах API и не должны быть отправлены |
|
leadId
|
leadId | integer |
Идентификатор свинца, связанного с участником программы |
|
последовательный
|
seq | integer |
Целое число, указывающее последовательность записи в ответе. Это значение сопоставляется с порядком записей, включенных в входные данные запроса. Сек должен быть только частью ответов и не должен быть отправлен. |
ProgramMemberDeleteResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | string |
Состояние операции, выполняемой в записи |
|
Причин
|
reasons | array of Reason |
Список причин, по которым операция не завершилась успешно. Причины присутствуют только в ответах API и не должны быть отправлены |
|
leadId
|
leadId | integer |
Идентификатор свинца, связанного с участником программы |
|
последовательный
|
seq | integer |
Целое число, указывающее последовательность записи в ответе. Это значение сопоставляется с порядком записей, включенных в входные данные запроса. Сек должен быть только частью ответов и не должен быть отправлен. |
StaticList
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
createdAt
|
createdAt | string |
Дата и время создания списка |
|
описание
|
description | string |
Описание статического списка |
|
id
|
id | integer |
Уникальный идентификатор целого числа статического списка |
|
имя
|
name | string |
Имя статического списка |
|
programName
|
programName | string |
Имя программы |
|
обновлено
|
updatedAt | string |
Дата и время последнего обновления списка |
|
имя рабочей области
|
workspaceName | string |
Имя родительской рабочей области, если применимо |
ОбзорAllPrograms
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
канал
|
channel | string |
Канал программы |
|
createdAt
|
createdAt | date-time |
Дата создания ресурса |
|
описание
|
description | string |
Описание ресурса |
|
folder
|
folder | Folder |
Представление JSON папки |
|
id
|
id | integer |
Идентификатор ресурса |
|
имя
|
name | string |
Имя ресурса |
|
sfdcId
|
sfdcId | string |
Идентификатор SFDC программы, если связан с кампанией SFDC |
|
sfdcName
|
sfdcName | string |
Имя связанной кампании SFDC, если применимо |
|
статус
|
status | string |
Состояние программы. Допустимы только для типов программ электронной почты и взаимодействия. |
|
type
|
type | string |
Тип программы |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления ресурса |
|
URL-адрес
|
url | string |
URL-адрес ресурса в пользовательском интерфейсе Marketo |
|
workspace
|
workspace | string |
Имя рабочей области |
FolderContentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
type
|
type | string |
FileFolder
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
имя
|
name | string | |
|
type
|
type | string |
ResponseOfProgramResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of ProgramResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
ResponseOfSmartListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of SmartListResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of SmartListResponseWithRules | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
SmartListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор смарт-списка |
|
имя
|
name | string |
Имя смарт-списка |
|
описание
|
description | string |
Описание интеллектуального списка |
|
createdAt
|
createdAt | date-time |
Дата создания смарт-списка |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления смарт-списка |
|
URL-адрес
|
url | string |
URL-адрес смарт-списка в пользовательском интерфейсе Marketo |
|
folder
|
folder | Folder |
Представление JSON папки |
|
workspace
|
workspace | string |
Имя рабочей области |
SmartListResponseWithRules
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор смарт-списка |
|
имя
|
name | string |
Имя смарт-списка |
|
описание
|
description | string |
Описание интеллектуального списка |
|
createdAt
|
createdAt | date-time |
Дата создания смарт-списка |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления смарт-списка |
|
URL-адрес
|
url | string |
URL-адрес смарт-списка в пользовательском интерфейсе Marketo |
|
folder
|
folder | Folder |
Представление JSON папки |
|
workspace
|
workspace | string |
Имя рабочей области |
|
правила
|
rules | SmartListRules |
Представление json правил смарт-списка |
ResponseOfStaticListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of StaticListResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
StaticListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор статического списка |
|
имя
|
name | string |
Имя статического списка |
|
описание
|
description | string |
Описание статического списка |
|
createdAt
|
createdAt | date-time |
Дата и время создания статического списка |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления статического списка |
|
URL-адрес
|
url | string |
URL-адрес статического списка в пользовательском интерфейсе Marketo |
|
folder
|
folder | Folder |
Представление JSON папки |
|
workspace
|
workspace | string |
Имя рабочей области |
|
computedUrl
|
computedUrl | string |
ProgramResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
канал
|
channel | string |
Канал программы |
|
costs
|
costs | array of Costs |
Списки связанных затрат на период |
|
createdAt
|
createdAt | date-time |
Дата создания ресурса |
|
описание
|
description | string |
Описание ресурса |
|
Дата окончания
|
endDate | date-time |
Дата окончания программы. Применимо к программам типа событий, электронной почты и вебинара |
|
folder
|
folder | ProgramFolder | |
|
id
|
id | integer |
Идентификатор ресурса |
|
имя
|
name | string |
Имя ресурса |
|
sfdcId
|
sfdcId | string |
Идентификатор SFDC программы, если связан с кампанией SFDC |
|
sfdcName
|
sfdcName | string |
Имя связанной кампании SFDC, если применимо |
|
startDate
|
startDate | date-time |
Дата начала программы. Применимо к программам типа событий, электронной почты и вебинара |
|
статус
|
status | string |
Состояние программы. Допустимы только для типов программ электронной почты и взаимодействия. |
|
tags
|
tags | array of Tags |
Список связанных тегов программы |
|
type
|
type | string |
Тип программы |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления ресурса |
|
URL-адрес
|
url | string |
URL-адрес ресурса в пользовательском интерфейсе Marketo |
|
workspace
|
workspace | string |
Имя рабочей области |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart
|
headStart | boolean |
Включена ли функция "Head Start" для программы |
FileResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Datetime при создании файла |
|
описание
|
description | string |
Описание файла |
|
folder
|
folder | FileFolder | |
|
id
|
id | integer |
Идентификатор файла |
|
тип MIME
|
mimeType | string |
Тип MIME файла |
|
имя
|
name | string |
Имя файла |
|
size
|
size | integer |
Размер файла в байтах |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления файла |
|
URL-адрес
|
url | string |
Общедоступный URL-адрес файла |
ResponseOfFileResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of FileResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
FolderResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
createdAt
|
createdAt | date-time |
Дата создания папки |
|
описание
|
description | string |
Описание папки |
|
folderId
|
folderId | Folder |
Представление JSON папки |
|
folderType
|
folderType | string |
Тип папки |
|
id
|
id | integer |
Идентификатор папки |
|
isArchive
|
isArchive | boolean |
Состояние архивации папки |
|
isSystem
|
isSystem | boolean |
Указывает, является ли папка управляемой системой |
|
имя
|
name | string |
Имя папки. Неприменимо для программ |
|
parent
|
parent | Folder |
Представление JSON папки |
|
путь
|
path | string |
Путь к папке |
|
обновлено
|
updatedAt | date-time |
Дата и время последнего обновления папки |
|
URL-адрес
|
url | string |
URL-адрес папки |
|
workspace
|
workspace | string |
Имя рабочей области |
ResponseOfIdResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of IdResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
Метки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
tagType
|
tagType | string |
Имя тега |
|
значение тэга
|
tagValue | string |
Значение тега |
ResponseOfBrowseAllPrograms
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of BrowseAllPrograms | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
ResponseOfFolderResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of FolderResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
ResponseOfFolderContentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
результат
|
result | array of FolderContentResponse | |
|
success
|
success | boolean | |
|
Предупреждения
|
warnings | array of string |
IdResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор ресурса |
Затраты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
стоимость
|
cost | integer |
Сумма стоимости |
|
заметка
|
note | string |
Заметки о стоимости |
|
startDate
|
startDate | date-time |
Дата начала стоимости периода |
ProgramFolder
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string |
Тип папки программы |
|
value
|
value | integer |
Идентификатор папки программы |
|
folderName
|
folderName | string |
Имя папки программы |
Folder
Представление JSON папки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор папки |
|
type
|
type | string |
Тип папки |
SmartListRules
Представление json правил смарт-списка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
Тип сопоставления фильтра смарт-списков (логика правила) |
|
триггеры
|
triggers | array of string |
Список триггеров интеллектуального списка |
|
filters
|
filters | array of SmartListFilters |
Список фильтров смарт-списков |
SmartListFilters
Представление JSON фильтров смарт-списка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор фильтра |
|
имя
|
name | string |
Имя фильтра |
|
ruleTypeId
|
ruleTypeId | integer |
Идентификатор типа правила |
|
ruleType
|
ruleType | string |
Имя типа правила |
|
operator
|
operator | string |
Имя оператора |
|
условия
|
conditions | array of SmartListConditions |
Список условий смарт-списка |
SmartListConditions
Представление json условий смарт-списка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
Идентификатор атрибута действия |
|
activityAttributeName
|
activityAttributeName | string |
Имя атрибута действия |
|
operator
|
operator | string |
Значение оператора |
|
values
|
values | array of string |
Список значений |
|
isPrimary
|
isPrimary | boolean |
Указывает, является ли условие основным или нет (первое условие интеллектуального списка) |
объект
Это тип object.