HubSpot Engagements версии 2 (независимый издатель) (предварительная версия)
HubSpot Engagements используется для хранения записей CRM up-to-date в любых взаимодействиях, которые происходят за пределами HubSpot. Отчеты о действиях в CRM также отключают эти данные.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Трой Тейлор |
| URL | https://www.hitachisolutions.com |
| Адрес электронной почты | ttaylor@hitachisolutions.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Трой Тейлор |
| Веб-сайт | https://www.hubspot.com/products/crm |
| Политика конфиденциальности | https://legal.hubspot.com/privacy-policy |
| Категории | Продажи и CRM; Коммуникация |
HubSpot Engagements версии 2
HubSpot Engagements используется для хранения записей CRM up-to-date в любых взаимодействиях, которые происходят за пределами HubSpot. Отчеты о действиях в CRM также отключают эти данные.
Издатель: Трой Тейлор, Решения Похасти
Предпосылки
У вас должна быть учетная запись с HubSpot и быть суперадминистратором.
Получение учетных данных
После входа в учетную запись перейдите к разделу "Параметры" —> настройка> учетной записи — интеграции —> частные приложения. Вам потребуется создать частное приложение и назначить его только области, для которые будут использоваться действия. После создания частного приложения у вас будет маркер доступа в разделе проверки подлинности частного приложения.
Поддерживаемые операции
Создание пакета вызовов
Создает пакет вызовов.
Получение пакета вызовов
Извлекает пакет вызовов по внутреннему идентификатору или уникальным значениям свойств.
Обновление пакета вызовов
Обновляет пакет вызовов.
Архивный пакет вызовов
Архивирует пакет вызовов по идентификатору.
Перечисление вызовов
Извлекает страницу вызовов. Управление возвращаемым параметром properties запроса.
Создание вызова
Создает вызов с заданными свойствами и возвращает копию объекта, включая идентификатор.
Чтение объекта
Извлекает объект, определенный по callId.
callId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архивация объекта
Перемещает объект, callId определенный в корзину.
Обновление объекта
Выполняет частичное обновление объекта, определяемого callId.
callId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Слияние двух вызовов
Объединяет два вызова с одинаковым типом.
Удаление вызова — GDPR
Окончательно удаляет вызов и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Вызовы поиска
Извлекает список вызовов.
Создание пакета сообщений электронной почты
Создает пакет сообщений электронной почты.
Получение пакета сообщений электронной почты
Извлекает пакет сообщений электронной почты по внутреннему идентификатору или уникальным значениям свойств.
Архивный пакет сообщений электронной почты
Архивирует пакет сообщений электронной почты по идентификатору.
Обновление пакета сообщений электронной почты
Обновляет пакет сообщений электронной почты.
Перечисление сообщений электронной почты
Извлекает страницу сообщений электронной почты. Управление возвращаемым параметром properties запроса.
Создание сообщения электронной почты
Создает сообщение электронной почты с заданными свойствами и возвращает копию объекта, включая идентификатор.
Получение электронной почты
Извлекает объект, определенный по emailId.
emailId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архив электронной почты
Перемещает объект, emailId определенный в корзину.
Обновление электронной почты
Выполняет частичное обновление объекта, определяемого emailId.
emailId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Слияние двух сообщений электронной почты
Объединяет два сообщения электронной почты с одинаковым типом.
Удаление сообщения электронной почты — GDPR
Окончательно удаляет сообщение электронной почты и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Поиск по электронной почте
Получение списка сообщений электронной почты.
Обновление пакета собраний
Обновляет пакет собраний.
Архивный пакет собраний
Архивирует пакет собраний по идентификатору.
Получение пакета собраний
Извлекает пакет собраний по внутреннему идентификатору или уникальным значениям свойств.
Создание пакета собраний
Создает пакет собраний.
Получение собрания
Извлекает объект, определенный по meetingId.
meetingId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архивирование собрания
Перемещает объект, meetingId определенный в корзину.
Обновление собрания
Выполняет частичное обновление объекта, определяемого meetingId.
meetingId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Вывод списка собраний
Извлекает страницу собраний. Управление возвращаемым параметром properties запроса.
Создание собрания
Создает собрание с заданными свойствами и возвращает копию объекта, включая идентификатор.
Объединение двух собраний
Объединяет два собрания с одинаковым типом.
Удаление собрания — GDPR
Окончательно удаляет собрание и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Поиск собраний
Получение списка собраний.
Получение пакета заметок
Извлекает пакет заметок по внутреннему идентификатору или уникальным значениям свойств.
Архивный пакет заметок
Архивирует пакет заметок по идентификатору.
Обновление пакета заметок
Обновляет пакет заметок.
Создание пакета заметок
Создает пакет заметок.
Список заметок
Извлекает страницу заметок. Управление возвращаемым параметром properties запроса.
Создание заметки
Создает заметку с заданными свойствами и возвращает копию объекта, включая идентификатор.
Получение заметки
Извлекает объект, определенный по noteId.
noteId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архивная заметка
Перемещает объект, noteId определенный в корзину.
Примечание об обновлении
Выполняет частичное обновление объекта, определяемого noteId.
noteId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Объединение двух заметок
Объединяет две заметки с одинаковым типом.
Удаление заметки — GDPR
Окончательно удаляет заметку и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Поиск заметок
Извлекает список заметок.
Получение пакета почтовой почты
Извлекает пакет почтовой почты по внутреннему идентификатору или уникальным значениям свойств.
Архивный пакет почтовой почты
Архивирует пакет почтовой почты по идентификатору.
Создание пакета почтовой почты
Создает пакет почтовой почты.
Обновление пакета почтовой почты
Обновляет пакет почтовой почты.
Перечисление почтовой почты
Извлекает страницу почтовой почты. Управление возвращаемым параметром properties запроса.
Создание почтовой почты
Создает почтовую почту с заданными свойствами и возвращает копию объекта, включая идентификатор.
Получение почтовой почты
Извлекает объект, определенный по postalMailId.
postalMailId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архив почты
Перемещает объект, postalMailId определенный в корзину.
Обновление почтовой почты
Выполняет частичное обновление объекта, определяемого postalMailId.
postalMailId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Слияние двух почтовых сообщений
Объединяет две почтовые почты с одинаковым типом.
Удаление почтовой почты — GDPR
Окончательно удаляет почтовое письмо и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Поиск почтовой почты
Получение списка почтовой почты.
Архивный пакет задач
Архивирует пакет задач по идентификатору.
Создание пакета задач
Создает пакет задач.
Обновление пакета задач
Обновляет пакет задач.
Получение пакета задач
Извлекает пакет задач по внутреннему идентификатору или уникальным значениям свойств.
Вывод задачи
Извлекает объект, определенный по taskId.
taskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архивная задача
Перемещает объект, taskId определенный в корзину.
Обновление задачи
Выполняет частичное обновление объекта, определяемого taskId.
taskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Перечисление задач
Извлекает страницу задач. Управление возвращаемым параметром properties запроса.
Создание задачи
Создает задачу с заданными свойствами и возвращает копию объекта, включая идентификатор. Представлена документация и примеры для создания стандартных задач.
Объединение двух задач
Объединяет две задачи с одинаковым типом.
Удаление задачи — GDPR
Окончательно удаляет задачу и все связанное содержимое для выполнения GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Задачи поиска
Получение списка задач.
Обновление пакета коммуникаций
Обновляет пакет обмена данными.
Архивный пакет коммуникаций
Архивирует пакет сообщений по идентификатору.
Создание пакета коммуникаций
Создает пакет обмена данными.
Получение пакета коммуникаций
Извлекает пакет обмена данными по внутреннему идентификатору или уникальным значениям свойств.
Вывод списка сообщений
Извлекает страницу обмена данными. Управление возвращаемым параметром properties запроса.
Создание связи
Создает связь с заданными свойствами и возвращает копию объекта, включая идентификатор.
Получение связи
Извлекает объект, определенный по communicationId.
communicationId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Архивирование обмена данными
Перемещает объект, communicationId определенный в корзину.
Обновление связи
Выполняет частичное обновление объекта, определяемого communicationId.
communicationId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Объединение двух коммуникаций
Объединяет два соединения с одинаковым типом.
Удаление связи — GDPR
Окончательно удаляет связь и все связанное содержимое, чтобы следовать GDPR. Используйте необязательный набор свойств idProperty , чтобы email определить контакт по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Поиск коммуникаций
Получение списка сообщений.
Известные проблемы и ограничения
В настоящее время нет известных проблем.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Маркер доступа (в форме носителя YOUR_ACCESS_TOKEN) | securestring | Маркер доступа (в форме "Носитель YOUR_ACCESS_TOKEN") для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Архив почты |
Перемещает объект, идентифицированный "mailMailId" в корзину. |
| Архив электронной почты |
Перемещает объект, определенный "emailId" в корзину. |
| Архивация объекта |
Перемещает объект, определяемый "callId" в корзину. |
| Архивирование обмена данными |
Перемещает объект, определенный параметром CommunicationId, в корзину. |
| Архивирование собрания |
Перемещает объект, определенный идентификатором meetingId, в корзину. |
| Архивная задача |
Перемещает объект, определенный идентификатором taskId, в корзину. |
| Архивная заметка |
Перемещает объект, определенный параметром NoteId, в корзину. |
| Архивный пакет вызовов |
Архивирует пакет вызовов по идентификатору. |
| Архивный пакет задач |
Архивирует пакет задач по идентификатору. |
| Архивный пакет заметок |
Архивирует пакет заметок по идентификатору. |
| Архивный пакет коммуникаций |
Архивирует пакет сообщений по идентификатору. |
| Архивный пакет почтовой почты |
Архивирует пакет почтовой почты по идентификатору. |
| Архивный пакет собраний |
Архивирует пакет собраний по идентификатору. |
| Архивный пакет сообщений электронной почты |
Архивирует пакет сообщений электронной почты по идентификатору. |
| Вывод задачи |
Извлекает объект, определенный идентификатором taskId. TaskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Вывод списка собраний |
Извлекает страницу собраний. Управление возвращаемым параметром |
| Вывод списка сообщений |
Извлекает страницу обмена данными. Управление возвращаемым параметром |
| Вызовы поиска |
Извлекает список вызовов. |
| Задачи поиска |
Получение списка задач. |
| Обновление задачи |
Выполняет частичное обновление объекта, определяемого идентификатором taskId. TaskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Обновление объекта |
Выполняет частичное обновление объекта, определяемого "callId". CallId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Обновление пакета вызовов |
Обновляет пакет вызовов. |
| Обновление пакета задач |
Обновляет пакет задач. |
| Обновление пакета заметок |
Обновляет пакет заметок. |
| Обновление пакета коммуникаций |
Обновляет пакет обмена данными. |
| Обновление пакета почтовой почты |
Обновляет пакет почтовой почты. |
| Обновление пакета собраний |
Обновляет пакет собраний. |
| Обновление пакета сообщений электронной почты |
Обновляет пакет сообщений электронной почты. |
| Обновление почтовой почты |
Выполняет частичное обновление объекта, определяемого "mailMailId". "mailMailId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Обновление связи |
Выполняет частичное обновление объекта, определяемого "communicationId". CommunicationId относится к внутреннему идентификатору объекта по умолчанию или при необходимости любому уникальному значению свойства, заданному параметром |
| Обновление собрания |
Выполняет частичное обновление объекта, определяемого "meetingId". "meetingId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Обновление электронной почты |
Выполняет частичное обновление объекта, определяемого "emailId". EmailId обозначает внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром |
| Объединение двух задач |
Объединяет две задачи с одинаковым типом. |
| Объединение двух заметок |
Объединяет две заметки с одинаковым типом. |
| Объединение двух коммуникаций |
Объединяет два соединения с одинаковым типом. |
| Объединение двух собраний |
Объединяет два собрания с одинаковым типом. |
| Перечисление вызовов |
Извлекает страницу вызовов. Управление возвращаемым параметром |
| Перечисление задач |
Извлекает страницу задач. Управление возвращаемым параметром |
| Перечисление почтовой почты |
Извлекает страницу почтовой почты. Управление возвращаемым параметром |
| Перечисление сообщений электронной почты |
Извлекает страницу сообщений электронной почты. Управление возвращаемым параметром |
| Поиск заметок |
Извлекает список заметок. |
| Поиск коммуникаций |
Получение списка сообщений. |
| Поиск по электронной почте |
Получение списка сообщений электронной почты. |
| Поиск почтовой почты |
Получение списка почтовой почты. |
| Поиск собраний |
Получение списка собраний. |
| Получение заметки |
Извлекает объект, определяемый атрибутом NoteId. NoteId — это внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром |
| Получение пакета вызовов |
Извлекает пакет вызовов по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета задач |
Извлекает пакет задач по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета заметок |
Извлекает пакет заметок по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета коммуникаций |
Извлекает пакет обмена данными по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета почтовой почты |
Извлекает пакет почтовой почты по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета собраний |
Извлекает пакет собраний по внутреннему идентификатору или уникальным значениям свойств. |
| Получение пакета сообщений электронной почты |
Извлекает пакет сообщений электронной почты по внутреннему идентификатору или уникальным значениям свойств. |
| Получение почтовой почты |
Извлекает объект, определенный с помощью mailMailId. "mailMailId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Получение связи |
Извлекает объект, определяемый идентификатором communicationId. CommunicationId относится к внутреннему идентификатору объекта по умолчанию или при необходимости любому уникальному значению свойства, заданному параметром |
| Получение собрания |
Извлекает объект, определяемый идентификатором meetingId. "meetingId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
| Получение электронной почты |
Извлекает объект, определяемый "emailId". EmailId обозначает внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром |
| Примечание об обновлении |
Выполняет частичное обновление объекта, определяемого атрибутом NoteId. NoteId — это внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром |
| Слияние двух вызовов |
Объединяет два вызова с одинаковым типом. |
| Слияние двух почтовых сообщений |
Объединяет две почтовые почты с одинаковым типом. |
| Слияние двух сообщений электронной почты |
Объединяет два сообщения электронной почты с одинаковым типом. |
| Создание вызова |
Создает вызов с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Создание задачи |
Создает задачу с заданными свойствами и возвращает копию объекта, включая идентификатор. Представлена документация и примеры для создания стандартных задач. |
| Создание заметки |
Создает заметку с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Создание пакета вызовов |
Создает пакет вызовов. |
| Создание пакета задач |
Создает пакет задач. |
| Создание пакета заметок |
Создает пакет заметок. |
| Создание пакета коммуникаций |
Создает пакет обмена данными. |
| Создание пакета почтовой почты |
Создает пакет почтовой почты. |
| Создание пакета собраний |
Создает пакет собраний. |
| Создание пакета сообщений электронной почты |
Создает пакет сообщений электронной почты. |
| Создание почтовой почты |
Создает почтовую почту с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Создание связи |
Создает связь с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Создание собрания |
Создает собрание с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Создание сообщения электронной почты |
Создает сообщение электронной почты с заданными свойствами и возвращает копию объекта, включая идентификатор. |
| Список заметок |
Извлекает страницу заметок. Управление возвращаемым параметром |
| Удаление вызова — GDPR |
Окончательно удаляет вызов и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление задачи — GDPR |
Окончательно удаляет задачу и все связанное содержимое для выполнения GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление заметки — GDPR |
Окончательно удаляет заметку и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление почтовой почты — GDPR |
Окончательно удаляет почтовое письмо и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление связи — GDPR |
Окончательно удаляет связь и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление собрания — GDPR |
Окончательно удаляет собрание и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Удаление сообщения электронной почты — GDPR |
Окончательно удаляет сообщение электронной почты и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем. |
| Чтение объекта |
Извлекает объект, определяемый "callId". CallId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром |
Архив почты
Перемещает объект, идентифицированный "mailMailId" в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Почтовый идентификатор почты
|
postalMailId | True | string |
Идентификатор почтовой почты. |
Возвращаемое значение
- response
- string
Архив электронной почты
Перемещает объект, определенный "emailId" в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код электронной почты
|
emailId | True | string |
Идентификатор электронной почты. |
Возвращаемое значение
- response
- string
Архивация объекта
Перемещает объект, определяемый "callId" в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор звонка
|
callId | True | string |
Идентификатор вызова. |
Возвращаемое значение
- response
- string
Архивирование обмена данными
Перемещает объект, определенный параметром CommunicationId, в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор связи
|
communicationId | True | string |
Идентификатор связи. |
Возвращаемое значение
- response
- string
Архивирование собрания
Перемещает объект, определенный идентификатором meetingId, в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор собрания
|
meetingId | True | string |
Идентификатор собрания. |
Возвращаемое значение
- response
- string
Архивная задача
Перемещает объект, определенный идентификатором taskId, в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи. |
Возвращаемое значение
- response
- string
Архивная заметка
Перемещает объект, определенный параметром NoteId, в корзину.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заметки
|
noteId | True | string |
Идентификатор заметки. |
Возвращаемое значение
- response
- string
Архивный пакет вызовов
Архивирует пакет вызовов по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет задач
Архивирует пакет задач по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет заметок
Архивирует пакет заметок по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет коммуникаций
Архивирует пакет сообщений по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет почтовой почты
Архивирует пакет почтовой почты по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет собраний
Архивирует пакет собраний по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Архивный пакет сообщений электронной почты
Архивирует пакет сообщений электронной почты по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
- response
- string
Вывод задачи
Извлекает объект, определенный идентификатором taskId. TaskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Вывод списка собраний
Извлекает страницу собраний. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Вывод списка сообщений
Извлекает страницу обмена данными. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Вызовы поиска
Извлекает список вызовов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Задачи поиска
Получение списка задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Обновление задачи
Выполняет частичное обновление объекта, определяемого идентификатором taskId. TaskId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Обновление объекта
Выполняет частичное обновление объекта, определяемого "callId". CallId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор звонка
|
callId | True | string |
Идентификатор вызова. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Обновление пакета вызовов
Обновляет пакет вызовов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета задач
Обновляет пакет задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета заметок
Обновляет пакет заметок.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета коммуникаций
Обновляет пакет обмена данными.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета почтовой почты
Обновляет пакет почтовой почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета собраний
Обновляет пакет собраний.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление пакета сообщений электронной почты
Обновляет пакет сообщений электронной почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Обновление почтовой почты
Выполняет частичное обновление объекта, определяемого "mailMailId". "mailMailId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Почтовый идентификатор почты
|
postalMailId | True | string |
Идентификатор почтовой почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Обновление связи
Выполняет частичное обновление объекта, определяемого "communicationId". CommunicationId относится к внутреннему идентификатору объекта по умолчанию или при необходимости любому уникальному значению свойства, заданному параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор связи
|
communicationId | True | string |
Идентификатор связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Обновление собрания
Выполняет частичное обновление объекта, определяемого "meetingId". "meetingId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор собрания
|
meetingId | True | string |
Идентификатор собрания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Обновление электронной почты
Выполняет частичное обновление объекта, определяемого "emailId". EmailId обозначает внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Код электронной почты
|
emailId | True | string |
Идентификатор электронной почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Объединение двух задач
Объединяет две задачи с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Объединение двух заметок
Объединяет две заметки с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Объединение двух коммуникаций
Объединяет два соединения с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Объединение двух собраний
Объединяет два собрания с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Перечисление вызовов
Извлекает страницу вызовов. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Перечисление задач
Извлекает страницу задач. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Перечисление почтовой почты
Извлекает страницу почтовой почты. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Перечисление сообщений электронной почты
Извлекает страницу сообщений электронной почты. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Поиск заметок
Извлекает список заметок.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Поиск коммуникаций
Получение списка сообщений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Поиск по электронной почте
Получение списка сообщений электронной почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Поиск почтовой почты
Получение списка почтовой почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Поиск собраний
Получение списка собраний.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
После
|
after | string |
После. |
|
|
Operator
|
operator | string |
Оператор. |
|
|
Название свойства
|
propertyName | string |
Имя свойства. |
|
|
Ценность
|
value | string |
Значение. |
|
|
Высокое значение
|
highValue | string |
Высокое значение. |
|
|
Ценности
|
values | array of string |
Значения. |
|
|
Лимит
|
limit | string |
Предел. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Сортов
|
sorts | array of string |
Сортировки. |
|
|
Query
|
query | string |
Запрос. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Total
|
total | integer |
Общее число. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Получение заметки
Извлекает объект, определяемый атрибутом NoteId. NoteId — это внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор заметки
|
noteId | True | string |
Идентификатор заметки. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Получение пакета вызовов
Извлекает пакет вызовов по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета задач
Извлекает пакет задач по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета заметок
Извлекает пакет заметок по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета коммуникаций
Извлекает пакет обмена данными по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета почтовой почты
Извлекает пакет почтовой почты по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета собраний
Извлекает пакет собраний по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение пакета сообщений электронной почты
Извлекает пакет сообщений электронной почты по внутреннему идентификатору или уникальным значениям свойств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Свойства
|
properties | array of string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | array of string |
Свойства с журналом. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Получение почтовой почты
Извлекает объект, определенный с помощью mailMailId. "mailMailId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Почтовый идентификатор почты
|
postalMailId | True | string |
Идентификатор почтовой почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Получение связи
Извлекает объект, определяемый идентификатором communicationId. CommunicationId относится к внутреннему идентификатору объекта по умолчанию или при необходимости любому уникальному значению свойства, заданному параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор связи
|
communicationId | True | string |
Идентификатор связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Получение собрания
Извлекает объект, определяемый идентификатором meetingId. "meetingId" ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор собрания
|
meetingId | True | string |
Идентификатор собрания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Получение электронной почты
Извлекает объект, определяемый "emailId". EmailId обозначает внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Код электронной почты
|
emailId | True | string |
Идентификатор электронной почты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Примечание об обновлении
Выполняет частичное обновление объекта, определяемого атрибутом NoteId. NoteId — это внутренний идентификатор объекта по умолчанию или любое уникальное значение свойства, указанное параметром idProperty запроса. Предоставленные значения свойств будут перезаписаны. Доступные только для чтения и несуществующие свойства будут игнорироваться. Значения свойств можно очистить, передав пустую строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор заметки
|
noteId | True | string |
Идентификатор заметки. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Слияние двух вызовов
Объединяет два вызова с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Слияние двух почтовых сообщений
Объединяет две почтовые почты с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Слияние двух сообщений электронной почты
Объединяет два сообщения электронной почты с одинаковым типом.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта для слияния
|
objectIdToMerge | string |
Идентификатор объекта для слияния. |
|
|
Идентификатор первичного объекта
|
primaryObjectId | string |
Идентификатор первичного объекта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание вызова
Создает вызов с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание задачи
Создает задачу с заданными свойствами и возвращает копию объекта, включая идентификатор. Представлена документация и примеры для создания стандартных задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание заметки
Создает заметку с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание пакета вызовов
Создает пакет вызовов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета задач
Создает пакет задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета заметок
Создает пакет заметок.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета коммуникаций
Создает пакет обмена данными.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета почтовой почты
Создает пакет почтовой почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета собраний
Создает пакет собраний.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание пакета сообщений электронной почты
Создает пакет сообщений электронной почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Завершено в
|
completedAt | string |
По завершении. |
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
Начало работы
|
startedAt | string |
При запуске. |
|
Состояние
|
status | string |
Состояние. |
|
Запрошено по адресу
|
requestedAt | string |
При запросе. |
Создание почтовой почты
Создает почтовую почту с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание связи
Создает связь с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание собрания
Создает собрание с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Создание сообщения электронной почты
Создает сообщение электронной почты с заданными свойствами и возвращает копию объекта, включая идентификатор.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
|
Категория ассоциаций
|
associationCategory | string |
Категория ассоциаций. |
|
|
Идентификатор типа связи
|
associationTypeId | string |
Идентификатор типа связи. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Список заметок
Извлекает страницу заметок. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Предел. |
|
|
После
|
after | string |
После. |
|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Создано в
|
results.createdAt | string |
При создании. |
|
Идентификатор
|
results.id | string |
Идентификатор. |
|
Обновлено в
|
results.updatedAt | string |
При обновлении по адресу. |
|
Archived
|
results.archived | boolean |
Архивировано ли. |
|
Архивировано в
|
results.archivedAt | string |
При архиве. |
|
После
|
paging.next.after | string |
После. |
|
Link
|
paging.next.link | string |
Ссылка. |
Удаление вызова — GDPR
Окончательно удаляет вызов и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление задачи — GDPR
Окончательно удаляет задачу и все связанное содержимое для выполнения GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление заметки — GDPR
Окончательно удаляет заметку и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление почтовой почты — GDPR
Окончательно удаляет почтовое письмо и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление связи — GDPR
Окончательно удаляет связь и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление собрания — GDPR
Окончательно удаляет собрание и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Удаление сообщения электронной почты — GDPR
Окончательно удаляет сообщение электронной почты и все связанное содержимое, чтобы следовать GDPR. Используйте необязательное свойство idProperty, для идентификации контакта по адресу электронной почты. Если адрес электронной почты не найден, адрес электронной почты будет добавлен в блок-список и не будет использоваться в будущем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код объекта
|
objectId | string |
Идентификатор объекта. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
Возвращаемое значение
- response
- string
Чтение объекта
Извлекает объект, определяемый "callId". CallId ссылается на внутренний идентификатор объекта по умолчанию или при необходимости любое уникальное значение свойства, указанное параметром idProperty запроса. Управление возвращаемым параметром properties запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Свойства
|
properties | string |
Свойства. |
|
|
Свойства с журналом
|
propertiesWithHistory | string |
Свойства с журналом. |
|
|
Associations
|
associations | string |
Ассоциации. |
|
|
Archived
|
archived | boolean |
Архивировано ли. |
|
|
Свойство ID
|
idProperty | string |
Свойство идентификатора. |
|
|
Идентификатор звонка
|
callId | True | string |
Идентификатор вызова. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | string |
При создании. |
|
Идентификатор
|
id | string |
Идентификатор. |
|
Обновлено в
|
updatedAt | string |
При обновлении по адресу. |
|
Archived
|
archived | boolean |
Архивировано ли. |
|
Архивировано в
|
archivedAt | string |
При архиве. |
Определения
струна
Это базовый тип данных string.