Softone Web CRM (предварительная версия)

Повышение продаж и укрепление отношений с клиентами на основе ИИ SOFTONE WEB CRM. Работайте в любом месте с 100% веб-и облачной платформы, автоматизируйте повторяющиеся задачи и ускоряйте процессы для экономии времени и усилий.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга 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)
Контакт
Имя Автоматизация продаж с помощью SOFTONE WEB CRM
URL https://webcrm.softone.gr
Адрес электронной почты support@shopranos.eu
Метаданные соединителя
Publisher Softone Technologies
Веб-сайт https://webcrm.softone.gr
Privacy Policy (Политика конфиденциальности) https://webcrm.softone.gr/privacy-policy
Категории Продажи и CRM

Соединитель Softone Web CRM Power Automate

Добро пожаловать в Соединитель Softone Web CRM Power Automate! Этот соединитель легко интегрирует систему ERP вашей компании с операциями Sales CRM, позволяя автоматизировать критически важные задачи и оптимизировать рабочие процессы.

Издатель: Softone Technologies S.A.

Предпосылки

Допустимая подписка Softone Web CRM.

Получение учетных данных

Чтобы получить доступ к данным вашей компании с помощью соединителя Softone Web CRM, выполните следующие действия.

  1. Посетите страницу входа Softone Web CRM в crm.shopranos.eu.
  2. После входа перейдите в меню и выберите "Ключи API пользователя".
  3. Создайте новый ключ API из указанных параметров.
  4. Используйте этот только что созданный ключ API в соединителе Softone Web CRM для получения доступа к данным вашей компании.

Начало работы с соединителем

Чтобы приступить к работе с соединителем Softone Web CRM Power Automate, выполните следующие действия.

  1. Установка. Установите соединитель в среде Power Automate.

  2. Конфигурация. Введите ключ API для подключения к Softone Web CRM.

  3. Использование. Простое автоматизация задач и рабочих процессов.

Распространенные ошибки и средства устранения неполадок

Ошибка 1. Недопустимый ключ API

Симптом. При настройке соединителя вы получите сообщение об ошибке, указывающее, что ключ API недопустим. Исправление: дважды проверьте, что вы создали действительный ключ API в учетной записи Softone Web CRM. Убедитесь, что в ключе API отсутствуют начальные или конечные пробелы при вводе в конфигурацию соединителя.

Ошибка 2. Не удается подключиться

Симптом. При настройке соединителя не удается установить подключение к Softone Web CRM. Исправление. Убедитесь, что соединитель правильно настроен с помощью ключа API. Убедитесь, что softone Web CRM (crm.shopranos.eu) доступен и не испытывает простоя. Проверьте параметры сети, чтобы убедиться, что нет ограничений, предотвращающих подключение соединителя к внешним службам.

Ошибка 3. Отсутствующие разрешения

Симптом. При попытке выполнить определенные действия с помощью соединителя возникают ошибки, связанные с разрешениями. Исправление. Убедитесь, что созданный ключ API имеет необходимые разрешения для доступа к определенным ресурсам или выполнения действий, которые вы пытаетесь автоматизировать. Ознакомьтесь с документацией Softone Web CRM, чтобы понять необходимые разрешения для различных операций.

Ошибка 4. Проблемы с установкой соединителя

Симптом. Во время установки соединителя в среде Power Automate возникают трудности. Исправление. Убедитесь, что вы следуйте инструкциям по установке соединителя Softone Web CRM тщательно. Проверьте среду Power Automate для любых ограничений или политик, которые могут повлиять на процесс установки. Если проблема сохранится, обратитесь в службу поддержки Power Automate.

Ошибка 5. Непредвиденное поведение

Симптом: соединитель не работает должным образом или возникают необъяснимые ошибки во время выполнения рабочего процесса. Исправление. Проверьте конфигурацию рабочего процесса и убедитесь, что входные и выходные данные правильно сопоставлены. Проверьте наличие изменений или обновлений в документации по API Softone Web CRM или соединителю, которые могут повлиять на рабочий процесс. Если проблема сохранится, обратитесь в службу поддержки Softone Web CRM, отправив сообщение электронной почты support@shopranos.eu.

Ошибка 6. Низкая производительность

Симптом: соединитель или рабочие процессы испытывают низкую производительность. Исправление. Проверьте сетевое подключение и убедитесь, что учетная запись Softone Web CRM не испытывает проблем с производительностью. Кроме того, ознакомьтесь с проектом рабочего процесса, чтобы оптимизировать его для повышения эффективности. Если проблема сохранится, обратитесь к поддержке Softone Web CRM. Эти распространенные ошибки и соответствующие средства защиты должны помочь пользователям устранять и устранять проблемы при использовании соединителя Power Automate Для Softone Web CRM. Если вы столкнулись с другими конкретными ошибками или проблемами, не стесняйтесь обращаться к поддержке Softone Web CRM для персонализированной помощи.

Часто задаваемые вопросы

Как получить поддержку, если возникли проблемы или возникли вопросы?

Ответ. Если у вас возникли проблемы или возникли вопросы, обратитесь к нашей группе support@shopranos.euподдержки. Мы здесь, чтобы помочь вам сделать большую часть Softone Web CRM для упрощения бизнес-процессов и повышения эффективности.

Каковы основные преимущества использования Softone Web CRM?

Softone Web CRM предлагает несколько ключевых преимуществ, в том числе:

Простая интеграция: просто подключите систему ERP к Sales CRM, повышая поток данных и эффективность работы. Event-Driven автоматизация: реагирование на критические события, например создание задачи или потенциальных пользователей. Активируйте мгновенные уведомления и автоматизируйте процессы утверждения с легкостью. Интеграция Microsoft Power Automate: используйте возможности Microsoft Power Automate для разблокировки широкого спектра возможностей автоматизации. Отправка важных сообщений, рабочих процессов утверждения диска и упрощение сложных процессов.

Инструкции по развертыванию

Так как Softone Web CRM работает как платформа как услуга (PaaS), процесс развертывания вручную не требуется. Платформа обрабатывает все аспекты развертывания и управления инфраструктурой, позволяя пользователям сосредоточиться непосредственно на использовании своих служб и функций для своих приложений.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Обновление вызова по идентификатору

Используйте это действие для изменения сведений о существующем вызове, таких как тема, участники, запланированное время или состояние.
Можно обновить только вызовы, доступные текущему пользователю.
Обновление свинца по идентификатору

Обновляет сведения о существующем потенциальных клиентах, таких как сведения о компании, контактные данные, состояние или источник. Можно обновить только потенциальных клиентов, доступных пользователю.
Обновление существующего контакта

Обновляет сведения о указанном контакте в данной компании.
Разрешения пользователей и контекст компании проверяются во время этой операции.
Обновление существующего события по идентификатору

Используйте это действие для изменения сведений о существующем событии, таких как название, описание, участники или запланированное время.
Можно обновить только события, доступные текущему пользователю.
Обновление существующей возможности по идентификатору

Применяет изменения к полям указанной возможности, например имя, этап, сумма или ссылка учетной записи.
Доступен только в том случае, если у пользователя есть разрешения на запись.
Обновление существующей задачи по идентификатору

Используйте это действие для изменения сведений о существующей задаче, таких как тема, описание, дата выполнения, приоритет или назначенный пользователь.
Можно обновить только задачи, доступные текущему пользователю.
Обновление существующей заметки по идентификатору

Используйте это действие для изменения сведений о существующей заметке, например содержимого или связанных ссылок.
Можно обновить только заметки, доступные текущему пользователю.
Обновление существующей учетной записи

Обновляет сведения об указанной учетной записи в данной компании.
Разрешения пользователей и контекст компании проверяются во время этой операции.
Только авторизованные пользователи с допустимыми данными могут выполнять обновление.
Получение возможности по идентификатору

Возвращает полные сведения об указанной возможности, включая владельца и связанную учетную запись.
Доступ ограничен на основе разрешений пользователей.
Получение всех возможностей с разбивкой на страницы

Выводит список возможностей, доступных пользователю на основе области (Me, Team или All).
Поддерживает фильтрацию, поиск и разбиение на страницы.
Полезно для панелей мониторинга, отчетов и интеграции, требующих пакетного доступа.
Получение всех вызовов

Выводит список всех действий вызова, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как назначенный пользователь, состояние или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько вызовов.
Получение всех задач, доступных пользователю

Выводит список всех задач, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как назначенный пользователь, состояние или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько задач.
Получение всех заметок, доступных пользователю

Перечисляет все заметки, доступные текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как создатель, связанная сущность или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько заметок.
Получение всех контактов для компании

Возвращает список всех контактов, принадлежащих указанной компании.
Пользователь, выполняя запрос, должен иметь соответствующие разрешения, как определено заголовками. Фильтры можно применять с помощью параметров запроса.
Получение всех потенциальных клиентов с разбивкой на страницы

Выводит список всех потенциальных клиентов, доступных текущему пользователю. Поддерживает разбиение на страницы и фильтрацию с помощью параметров запроса.
Полезно для панелей мониторинга, отчетов или интеграции, требующих пакетной обработки потенциальных клиентов.
Получение всех событий, доступных пользователю

Выводит список всех событий, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как диапазон дат, назначенный пользователь или состояние.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько событий.
Получение всех учетных записей для компании

Возвращает список всех учетных записей, принадлежащих указанной компании.
Пользователь, выполняя запрос, должен иметь соответствующие разрешения, определенные в заголовках запроса.
Фильтры можно применять с помощью параметров строки запроса.
Получение задачи вызова по идентификатору

Возвращает подробные сведения для указанного вызова, включая тему, участников, запланированное время и состояние.
Используйте это действие для просмотра или ссылки на конкретный вызов в службе автоматизации.
Получение задачи по идентификатору

Возвращает подробные сведения для указанной задачи, включая тему, описание, дату выполнения, приоритет и назначенного пользователя.
Используйте это действие для просмотра или ссылки на определенную задачу в службе автоматизации.
Получение заметки по идентификатору

Возвращает подробные сведения для указанной заметки, включая содержимое, создателя и связанную сущность.
Используйте это действие для просмотра или ссылки на конкретную заметку в службе автоматизации.
Получение команды по уникальному идентификатору

Возвращает полные сведения указанной команды.
Получение контакта по идентификатору

Возвращает сведения для указанного контакта, предоставляя данные и сведения для конкретной компании.
Доступ определяется контекстом компании, предоставленным в заголовке x-companyid запроса.
Получение пользователя backoffice по идентификатору

Возвращает полные сведения о указанном пользователе, включая сведения о роли в данной компании.
Доступ определяется контекстом компании, предоставленным в заголовке запроса.
Получение свинца по идентификатору

Возвращает подробные сведения для указанного свинца, включая сведения о компании, контактные данные, источник и состояние. Используйте это действие для просмотра или обновления определенного свинца.
Получение события по идентификатору

Возвращает подробные сведения для указанного события, включая название, участников, запланированное время и состояние.
Используйте это действие для просмотра или ссылки на определенное событие в службе автоматизации.
Получение учетной записи по идентификатору

Возвращает сведения об указанной учетной записи, включая данные, относящиеся к компании.
Доступ определяется контекстом компании, предоставленным в заголовке x-companyid запроса.
Создание задачи

Используйте это действие для добавления новой задачи в систему.
Укажите такие сведения, как тема, описание, дата выполнения, приоритет и назначенный пользователь.
Созданная задача может быть получена, обновлена или удалена.
Создание заметки

Используйте это действие для добавления заметки в определенное действие или сущность.
Укажите такие сведения, как название, содержимое и связанные ссылки.
Созданная заметка может быть получена, обновлена или удалена.
Создание нового вызова

Используйте это действие для создания нового действия вызова, включая тему, участников, запланированное время и состояние.
Созданный вызов можно позже получить, обновить или удалить.
Создание нового контакта

Создает новый контакт в указанной компании.
Пользователь, выполняя запрос, должен иметь отношение x-permissions к этому действию.
Создание нового свинца

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

Используйте это действие для создания новой возможности в конвейере продаж.
Возможность обычно представляет собой потенциальную сделку с учетной записью, связанной с потенциальным или созданным независимо.
Создание события

Используйте это действие для планирования или регистрации нового события.
Укажите такие сведения, как название, описание, участники и запланированное время.
Созданное событие может быть обновлено, извлечено или связано с другими действиями.
Создать новую учетную запись

Создает новую учетную запись в указанной компании.
Пользователь, выполняющий запрос, должен иметь отношение x-permissions к этому действию, а сведения о учетной записи должны быть допустимыми.
Удаление возможности по идентификатору

Окончательно удаляет возможность из системы.
Убедитесь, что возможность больше не требуется перед удалением, так как действие не может быть отменено.
Удаление вызова по идентификатору

Окончательно удаляет указанный вызов из системы.
Можно удалить только вызовы, доступные текущему пользователю.
Убедитесь, что вызов не связан с другими процессами перед удалением.
Удаление задачи по идентификатору

Окончательно удаляет указанную задачу из системы.
Убедитесь, что задача не связана с другими процессами перед удалением.
Удалить можно только задачи, доступные текущему пользователю.
Удаление заметки по идентификатору

Окончательно удаляет указанную заметку из системы.
Убедитесь, что заметка не связана с другими процессами перед удалением.
Удалить можно только заметки, доступные текущему пользователю.
Удаление контакта

Удаляет указанный контакт из указанной компании.
Доступ определяется контекстом компании, указанным в заголовке x-companyid .
Удаление свинца по идентификатору

Окончательно удаляет свинца из системы. Убедитесь, что свинца не требуется для дальнейшей обработки или преобразования перед удалением.
Удаление события по идентификатору

Окончательно удаляет указанное событие из системы.
Убедитесь, что событие не связано с другими процессами перед удалением.
Удалить можно только события, доступные текущему пользователю.
Удаление учетной записи

Удаляет указанную учетную запись для данной компании.
Запрос должен содержать допустимые x-companyid и соответствующие разрешения для продолжения.

Обновление вызова по идентификатору

Идентификатор операции:
Call_Update

Используйте это действие для изменения сведений о существующем вызове, таких как тема, участники, запланированное время или состояние.
Можно обновить только вызовы, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор вызова для обновления.
Тип задачи
 taskType string
срок
 dueDate date-time
субъект
 subject string
присвоено типу
 assignedToType string
присвоен идентификатор
 assignedToId string
связанный с типом
 relatedToType string
связанный с идентификатором
 relatedToId string
Тип контакта
 contactType string
Идентификаторы контактов
 contactIds array of string
статус
 status string
Длительность вызова
 callDuration date-span
Идентификатор результата вызова
 callResultId string
comments
 comments string
Текст редактора
 editorBody string
Идентификатор приоритета
 priorityId string
должность
 position integer
родительский идентификатор
 parentId string
Набор напоминаний
 reminderSet boolean
последнее изменение
 lastModifiedBy string
Дата сортировки
 sortDate date-time
исходный идентификатор
 sourceId string
источник, назначенный идентификатору
 sourceAssignedToId string
источник, связанный с идентификатором
 sourceRelatedToId string
исходные идентификаторы контактов
 sourceContactIds array of string
Направление вызова
 callDirection string

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Обновление свинца по идентификатору

Идентификатор операции:
Lead_Update

Обновляет сведения о существующем потенциальных клиентах, таких как сведения о компании, контактные данные, состояние или источник. Можно обновить только потенциальных клиентов, доступных пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор потенциальных обновлений.
Название задания
 jobTitle string
Идентификатор состояния свинца
 leadStatusId string
имя
 firstName True string
фамилия
 lastName string
среднее имя
 middleName string
Идентификатор приветствия
 salutationId string
суффикс
 suffix string
электронная почта
 email string
phone
 phone string
мобильный телефон
 mobilePhone string
Адрес электронной почты
 emailAddress string
type
 type string
устраняться
 optOut boolean
Номер телефона
 phoneNumber string
type
 type string
устраняться
 optOut boolean
Отказ от звонка
 callOptOut boolean
Отказ от отправки электронной почты
 emailOptOut boolean
Идентификатор оценки
 ratingId string
Идентификатор владельца
 ownerId string
тип владельца
 ownerType string
веб-сайт
 website string
компания
 company string
Идентификатор отрасли
 industryId string
нет сотрудников
 noOfEmployees integer
Идентификатор источника учетной записи
 accountSourceTypeId string
адрес1
 address1 string
Адрес2
 address2 string
city
 city string
государство
 state string
country
 country string
почтовый индекс
 postalCode string
описание
 description string
годовой доход
 annualRevenue double
дата последней передачи
 lastTransferDate date-time
идентификатор пола
 genderId string
произнесение идентификатора
 pronounceId string
статус
 status string
последнее изменение
 lastModifiedBy string
Дополнительные поля
 extraFields object

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Обновление существующего контакта

Идентификатор операции:
Contact_Update

Обновляет сведения о указанном контакте в данной компании.
Разрешения пользователей и контекст компании проверяются во время этой операции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контакта
 contactId True string

Уникальный идентификатор контакта для обновления.
Идентификатор владельца
 ownerId string
AccountIds
 accountIds array of string
SourceId
 sourceId string
SourceOwnerId
 sourceOwnerId string
SourceAccountIds
 sourceAccountIds array of string
Имя
 firstName string
Фамилия
 lastName string
MiddleName
 middleName string
SalutationId
 salutationId string
Суффикс
 suffix string
Адрес электронной почты
 email string
Телефон
 phone string
MobilePhone
 mobilePhone string
Факс
 fax string
CallOptOut
 callOptOut boolean
EmailOptOut
 emailOptOut boolean
Адрес электронной почты
 emailAddress string
Тип
 type string
OptOut
 optOut boolean
Номер телефона
 phoneNumber string
Тип
 type string
OptOut
 optOut boolean
Название должности
 jobTitle string
GenderId
 genderId string
PronounceId
 pronounceId string
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Код страны
 countryCode string
Почтовый индекс
 postalCode string
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Отдел
 department string
ReportsTo
 reportsTo string
Помощник
 assistant string
Помощник По телефону
 assistantPhone string
Birthday
 birthday date-time
Description
 description string
LastStayInTouchReportedDate
 lastStayInTouchReportedDate date-time
LastStayInTouchSaveDate
 lastStayInTouchSaveDate date-time
AccountSourceTypeId
 accountSourceTypeId string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string

Возвращаемое значение

Тело
Customer.Api.Features.Contacts.ContactDTO

Обновление существующего события по идентификатору

Идентификатор операции:
Event_Update

Используйте это действие для изменения сведений о существующем событии, таких как название, описание, участники или запланированное время.
Можно обновить только события, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор события для обновления.
Дата обновления
 updateDate date-time
субъект
 subject string
Тип задачи
 taskType string
присвоено типу
 assignedToType string
присвоен идентификатор
 assignedToId string
связанный с типом
 relatedToType string
связанный с идентификатором
 relatedToId string
Тип контакта
 contactType string
Идентификаторы контактов
 contactIds array of string
описание
 description string
Текст редактора
 editorBody string
Идентификатор приоритета
 priorityId string
долгота
 longitude string
широта
 latitude string
Дата начала
 startDate date-time
Дата окончания
 endDate date-time
Набор напоминаний
 reminderSet boolean
создано by
 createdBy string
последнее изменение
 lastModifiedBy string
должность
 position integer
родительский идентификатор
 parentId string
repeat
 repeat string
Состояние события
 eventStatus string
Идентификатор результата события
 eventResultId string
Интервал повторения
 recurrenceInterval string
исходный идентификатор
 sourceId string
источник, назначенный идентификатору
 sourceAssignedToId string
источник, связанный с идентификатором
 sourceRelatedToId string
исходные идентификаторы контактов
 sourceContactIds array of string
Участники команды
 teamMembers array of string

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Обновление существующей возможности по идентификатору

Идентификатор операции:
Opportunity_Update

Применяет изменения к полям указанной возможности, например имя, этап, сумма или ссылка учетной записи.
Доступен только в том случае, если у пользователя есть разрешения на запись.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор возможности обновления.
Идентификатор типа
 typeId string
Идентификатор владельца
 ownerId string
Идентификатор учетной записи
 accountId string
имя
 name string
количество
 amount double
Идентификатор категории прогноза
 forecastCategoryId string
Дата закрытия
 closeDate date-time
вероятность
 probability integer
счёт
 score integer
описание
 description string
Идентификатор конвейера продаж
 salesPipelineId string
Идентификатор кавычки
 quoteId string
Идентификатор состояния возможности
 opportunityStatusId string
статус
 status string
Идентификатор источника учетной записи
 accountSourceTypeId string
Следующий шаг
 nextStep string
бюджет подтвержден
 budgetConfirmed boolean
обнаружение завершено
 discoveryCompleted boolean
ожидаемый доход
 expectedRevenue double
Идентификатор причины потери
 lossReasonId string
частный
 private boolean
последнее изменение
 lastModifiedBy string
Дополнительные поля
 extraFields object

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Обновление существующей задачи по идентификатору

Идентификатор операции:
Task_Update

Используйте это действие для изменения сведений о существующей задаче, таких как тема, описание, дата выполнения, приоритет или назначенный пользователь.
Можно обновить только задачи, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор задачи для обновления.
Тип задачи
 taskType string
субъект
 subject string
срок
 dueDate date-time
Дата завершения
 completedDate date-time
статус
 status string
Идентификатор приоритета
 priorityId string
присвоен идентификатор
 assignedToId string
присвоено типу
 assignedToType string
Идентификаторы контактов
 contactIds array of string
Тип контакта
 contactType string
связанный с идентификатором
 relatedToId string
связанный с типом
 relatedToType string
Идентификатор подтипа задачи
 taskSubTypeId string
comments
 comments string
Текст редактора
 editorBody string
Набор напоминаний
 reminderSet boolean
должность
 position integer
родительский идентификатор
 parentId string
последнее изменение
 lastModifiedBy string

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Обновление существующей заметки по идентификатору

Идентификатор операции:
Note_Update

Используйте это действие для изменения сведений о существующей заметке, например содержимого или связанных ссылок.
Можно обновить только заметки, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор заметки для обновления.
связанный с типом
 relatedToType string
связанный с идентификатором
 relatedToId string
субъект
 subject string
body
 body string
Текст редактора
 editorBody string
последнее изменение
 lastModifiedBy string
Идентификаторы контактов
 contactIds array of string
Тип контакта
 contactType string

Возвращаемое значение

Тело
Task.Api.Features.Notes.NoteDTO

Обновление существующей учетной записи

Идентификатор операции:
Account_Update

Обновляет сведения об указанной учетной записи в данной компании.
Разрешения пользователей и контекст компании проверяются во время этой операции.
Только авторизованные пользователи с допустимыми данными могут выполнять обновление.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 accountId True string

Уникальный идентификатор обновляемой учетной записи.
Имя
 name string
Телефон
 phone string
Олово
 tin string
Code
 code string
Адрес электронной почты
 email string
SourceId
 sourceId string
SourceParentId
 sourceParentId string
SourceOwnerId
 sourceOwnerId string
PrimaryContactIds
 primaryContactIds array of string
ParentAccountId (Идентификатор родителя счета)
 parentAccountId string
Идентификатор владельца
 ownerId string
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Код страны
 countryCode string
Почтовый индекс
 postalCode string
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string
AccountSourceTypeId
 accountSourceTypeId string
IndustryId
 industryId string
TierId
 tierId string
Веб-сайт
 website string
AccountDescription
 accountDescription string
NoOfEmployees
 noOfEmployees integer
AnnualRevenue
 annualRevenue double
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Факс
 fax string
OwnershipId
 ownershipId string
RatingId
 ratingId string
ClassificationId
 classificationId string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string

Возвращаемое значение

Тело
Customer.Api.Features.Accounts.AccountDTO

Получение возможности по идентификатору

Идентификатор операции:
Opportunity_GetById

Возвращает полные сведения об указанной возможности, включая владельца и связанную учетную запись.
Доступ ограничен на основе разрешений пользователей.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор возможности.

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Получение всех возможностей с разбивкой на страницы

Идентификатор операции:
Opportunity_GetAll

Выводит список возможностей, доступных пользователю на основе области (Me, Team или All).
Поддерживает фильтрацию, поиск и разбиение на страницы.
Полезно для панелей мониторинга, отчетов и интеграции, требующих пакетного доступа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Задает идентификаторы для фильтра поиска возможностей.
Идентификатор владельца
 OwnerId string

Задает идентификаторы владельцев, связанных с поиском возможностей.
Имя
 Name string

Представляет имя возможности, используемой в фильтре поиска.
Сумма
 Amount double

Задает ожидаемый доход или денежное значение для фильтра поиска возможностей.
Дата закрытия
 CloseDate string

Представляет фильтр поиска даты закрытия для возможностей. Это свойство позволяет фильтровать возможности на основе их дат закрытия.
Дата обновления
 UpdateDate date-time

Задает дату последнего обновления для фильтра поиска возможностей.
Дата вставки
 InsertDate date-time

Задает дату и время вставки возможности.
Идентификатор учетной записи
 AccountId string

Задает идентификаторы фильтра учетной записи в критериях поиска возможностей.
Идентификатор категории прогноза
 ForecastCategoryId string

Фильтрует возможности на основе указанных идентификаторов категорий прогнозов.
Идентификатор источника учетной записи
 AccountSourceTypeId string

Представляет идентификатор фильтра типа источника учетной записи в поиске возможностей.
Идентификатор состояния возможности
 OpportunityStatusId string

Задает идентификаторы состояний возможностей для фильтрации поиска возможностей.
Идентификатор кавычки
 QuoteId string

Задает уникальный идентификатор связанной кавычки в фильтре возможностей поиска.
Идентификатор причины потери
 LossReasonId string

Представляет идентификатор по причине потери возможности.
Идентификатор типа
 TypeId string

Представляет идентификатор типа, используемый для фильтрации возможностей в поисковом запросе.
Последнее изменение
 LastModifiedBy string

Указывает пользователя, который последний раз изменил возможность.
Создано автором
 CreatedBy string

Указывает идентификатор пользователя или системы, создавшего запись возможности.
Искать
 Search string

Задает ключевое слово или фразу, используемую для выполнения общего поиска по записям возможностей.
Идентификатор конвейера продаж
 SalesPipelineId string

Задает идентификатор фильтра конвейера продаж в поисках возможностей.
Состояние
 Status string

Указывает состояние возможностей для фильтра поиска.
Страница
 Page integer

Задает номер страницы для результатов с разбивкой на страницы. Значение по умолчанию — 1.
Размер страницы
 PageSize integer

Задает количество элементов на страницу для результатов с разбивкой на страницы. Значение по умолчанию — 25.
Сортировать
 Sort string

Указывает критерии сортировки в виде строки. Строка сортировки определяет свойство и направление (возрастание или убывание) для сортировки результатов. Несколько критериев можно объединить с помощью разделителя запятой.

Возвращаемое значение

response
array of SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Получение всех вызовов

Идентификатор операции:
Call_GetAll

Выводит список всех действий вызова, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как назначенный пользователь, состояние или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько вызовов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Уникальный идентификатор, используемый для фильтрации и поиска конкретных задач.
Состояние
 Status string

Состояние задачи
Идентификатор приоритета
 PriorityId string

Представляет идентификатор приоритета, связанного с задачей, включив фильтрацию и классификацию на основе уровней приоритета.
Создано автором
 CreatedBy string

Идентификатор, представляющий пользователя, создавшего задачу, которая использовалась для фильтрации.
Последнее изменение
 LastModifiedBy string

Указывает идентификатор или имя последнего пользователя, который изменил задачу. Это свойство используется для фильтрации и поиска задач на основе изменения пользователя.
Срок
 DueDate date-time

Представляет дату завершения задачи или требуемого действия. Используется в качестве фильтра для поиска или запроса задач на основе их даты выполнения.
Дата сортировки
 SortDate string

Представляет дату или даты, которые можно использовать для сортировки задач. Это свойство позволяет фильтровать задачи на основе указанных дат сортировки.
Присвоен идентификатору
 AssignedToId string

Представляет идентификаторы пользователей или сущностей, которым назначена задача или вызов.
Связанные с идентификатором
 RelatedToId string

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

Представляет идентификатор результата вызова, который можно использовать для фильтрации задач на основе связанного результата вызова.
Искать
 Search string

Представляет поисковый термин, который можно использовать для фильтрации данных путем применения операции "StartsWith" в соответствующих полях.
Страница
 Page integer

Задает текущий номер страницы для результатов с разбивкой на страницы. Это значение используется для определения начальной точки набора данных для разбиения на страницы.
Размер страницы
 PageSize integer

Задает количество элементов, которые необходимо включить в одну страницу результатов с разбивкой на страницы. Это значение определяет размер набора данных, возвращаемого на страницу.
Сортировать
 Sort string

Представляет критерии сортировки результатов поиска. Это свойство определяет порядок сортировки и поля для набора данных.

Возвращаемое значение

response
array of Task.Api.Features.Calls.CallDTO

Получение всех задач, доступных пользователю

Идентификатор операции:
Task_GetAll

Выводит список всех задач, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как назначенный пользователь, состояние или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько задач.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Задает уникальный идентификатор задачи.
Состояние
 Status string

Задает состояние задачи, представляющую ее текущую стадию, например Open или Completed.
Связанные с
 RelatedTo string

Задает связанный тип для задач фильтрации. Это свойство используется для связывания задач с определенной сущностью или категорией.
Связанные с идентификатором
 RelatedToId string

Задает идентификатор сущности, к которой связана задача.
Идентификатор приоритета
 PriorityId string

Задает идентификатор для фильтрации задач по их приоритету.
Тип задачи
 Type string

Задает тип задачи, указывающий ее предназначенную или категорию.
Срок
 DueDate date-time

Задает дату выполнения задачи. Это свойство используется для фильтрации задач на основе их даты выполнения.
Дата сортировки
 SortDate string

Задает значения даты сортировки, используемые для задач фильтрации и сортировки.
Родительский идентификатор
 ParentId string

Задает идентификатор родительской задачи, связанной с текущей задачей.
Последнее изменение
 LastModifiedBy string

Задает идентификатор пользователя, который последний раз изменил задачу.
Создано автором
 CreatedBy string

Задает идентификатор пользователя, создавшего задачу.
Присвоен идентификатору
 AssignedToId string

Задает идентификаторы пользователей, которым назначена задача.
Искать
 Search string

Задает поисковый запрос, используемый для фильтрации задач на основе указанного ключевого слова или текста.
Страница
 Page integer

Задает текущий номер страницы для результатов с разбивкой на страницы. Это значение используется для определения начальной точки набора данных для разбиения на страницы.
Размер страницы
 PageSize integer

Задает количество элементов, которые необходимо включить в одну страницу результатов с разбивкой на страницы. Это значение определяет размер набора данных, возвращаемого на страницу.
Сортировать
 Sort string

Представляет критерии сортировки результатов поиска. Это свойство определяет порядок сортировки и поля для набора данных.

Возвращаемое значение

response
array of Task.Api.Features.Tasks.TaskDTO

Получение всех заметок, доступных пользователю

Идентификатор операции:
Note_GetAll

Перечисляет все заметки, доступные текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как создатель, связанная сущность или диапазон дат.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько заметок.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Возвращает или задает список идентификаторов, используемых для фильтрации заметок.
Искать
 Search string

Возвращает или задает текст, используемый для выполнения поиска по заметкам.
Связанные с идентификатором
 RelatedToId string

Возвращает или задает идентификатор, связанный с определенной сущностью для фильтрации заметок.
связанный с типом
 RelatedToType string

Возвращает или задает тип сущности, связанной с примечанием.
Создано автором
 CreatedBy string

Возвращает или задает идентификатор пользователя, создавшего заметку.
Последнее изменение
 LastModifiedBy string

Возвращает или задает идентификатор пользователя, который последний раз изменил заметку.
Страница
 Page integer

Задает текущий номер страницы для результатов с разбивкой на страницы. Это значение используется для определения начальной точки набора данных для разбиения на страницы.
Размер страницы
 PageSize integer

Задает количество элементов, которые необходимо включить в одну страницу результатов с разбивкой на страницы. Это значение определяет размер набора данных, возвращаемого на страницу.
Сортировать
 Sort string

Представляет критерии сортировки результатов поиска. Это свойство определяет порядок сортировки и поля для набора данных.

Возвращаемое значение

response
array of Task.Api.Features.Notes.NoteDTO

Получение всех контактов для компании

Идентификатор операции:
Contact_GetAll

Возвращает список всех контактов, принадлежащих указанной компании.
Пользователь, выполняя запрос, должен иметь соответствующие разрешения, как определено заголовками. Фильтры можно применять с помощью параметров запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 Name string

Задает имя контакта, который будет использоваться в качестве фильтра в процессе поиска.
Идентификатор владельца
 OwnerId string

Указывает идентификаторы владельца, используемые для фильтрации результатов поиска для контактов.
Suggestions
 Suggestions string

Задает предложения, которые будут использоваться в качестве фильтра в процессе поиска.
Идентификатор источника учетной записи
 AccountSourceTypeId string

Указывает идентификатор источника учетной записи, который будет использоваться в качестве фильтра в поисковом запросе.
Имя (Первое имя)
 FirstName string

Задает имя контакта, которое будет использоваться в качестве фильтра в процессе поиска.
Фамилия
 LastName string

Задает фамилию контакта, который будет использоваться в качестве фильтра в процессе поиска.
Телефон
 Phone string

Задает номер телефона контакта, который будет использоваться в качестве фильтра в процессе поиска.
Мобильный телефон
 MobilePhone string

Задает номер мобильного телефона, который будет использоваться в качестве фильтра в процессе поиска контактов.
Идентификаторы учетной записи
 AccountIds string

Задает идентификаторы учетных записей, которые будут использоваться в качестве фильтра в процессе поиска.
Адрес электронной почты
 Email string

Указывает адрес электронной почты контакта, который будет использоваться в качестве фильтра во время поиска.
Идентификатор
 Id string

Указывает список идентификаторов контактов, используемых в качестве фильтра в процессе поиска.
Назначенные команды
 AssignedTeams string

Указывает список идентификаторов группы, назначенных контакту, используемый в качестве фильтра в процессе поиска.
Искать
 Search string

Указывает термин или значение, используемое в качестве общего фильтра поиска при запросе контактов.
Страница
 Page integer

Указывает текущий номер страницы для результатов поиска с разбивкой на страницы.
Размер страницы
 PageSize integer

Указывает количество элементов, отображаемых на каждой странице в результатах поиска с разбивкой на страницы.
Сортировать
 Sort string

Представляет параметр сортировки для упорядочивания результатов поиска. Принимает разделенный запятыми список полей, префиксируемых "+" для возрастающего порядка или "-" для убывания. Значение по умолчанию — "id", если оно не указано.

Возвращаемое значение

response
array of Customer.Api.Features.Contacts.ContactDTO

Получение всех потенциальных клиентов с разбивкой на страницы

Идентификатор операции:
Lead_GetAll

Выводит список всех потенциальных клиентов, доступных текущему пользователю. Поддерживает разбиение на страницы и фильтрацию с помощью параметров запроса.
Полезно для панелей мониторинга, отчетов или интеграции, требующих пакетной обработки потенциальных клиентов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Задает список идентификаторов свинца, используемых в качестве критерия фильтра в поисковом запросе.
Имя
 Name string

Задает имя свинца, которое служит критерием фильтра в поисковом запросе.
Имя (Первое имя)
 FirstName string

Задает первое имя свинца, используемое в качестве критерия фильтра в поисковых запросах.
Фамилия
 LastName string

Задает фамилию свинца, используемую в качестве критерия фильтра в поисковом запросе.
Дата вставки
 InsertDate string

Задает список дат вставки, используемых в качестве критерия фильтра в поисковом запросе.
Телефон
 Phone string

Задает номер телефона, связанный с свинцом. Это свойство используется в качестве критерия фильтра в поисковом запросе.
Мобильный телефон
 MobilePhone string

Задает номер мобильного телефона свинца, используемый в качестве критерия фильтра в поисковых запросах.
Адрес электронной почты
 Email string

Задает адрес электронной почты свинца, используемый в качестве критерия фильтра в поисковом запросе.
Идентификатор владельца
 OwnerId string

Представляет список идентификаторов владельца, используемых в качестве критерия фильтра в поисковом запросе.
тип владельца
 OwnerType string

Указывает тип владельца для свинца, например отдельный или очередь. Это свойство используется в качестве критерия фильтрации в поисковом запросе.
Идентификатор источника учетной записи
 AccountSourceTypeId string

Указывает тип источника учетной записи, используемого в качестве критерия фильтра в поисковом запросе.
Идентификатор состояния свинца
 LeadStatusId string

Фильтрует потенциальных клиентов на основе связанного идентификатора состояния свинца.
Идентификатор отрасли
 IndustryId string

Задает идентификатор отрасли, используемый в качестве критерия фильтра в поисковом запросе.
Состояние
 Status string

Представляет фильтр состояния, используемый в поисковых запросах свинца. Этот фильтр позволяет указать состояние потенциальных клиентов, например "Default", "Квалифицировано" или "Unqualified".
Искать
 Search string

Задает ключевое слово поиска, используемое в качестве критерия фильтра в поисковом запросе.
Страница
 Page integer

Задает номер страницы для результатов с разбивкой на страницы. Значение по умолчанию — 1.
Размер страницы
 PageSize integer

Задает количество элементов на страницу для результатов с разбивкой на страницы. Значение по умолчанию — 25.
Сортировать
 Sort string

Указывает критерии сортировки в виде строки. Строка сортировки определяет свойство и направление (возрастание или убывание) для сортировки результатов. Несколько критериев можно объединить с помощью разделителя запятой.

Возвращаемое значение

response
array of SalesPipeline.Api.Features.Lead.LeadDto

Получение всех событий, доступных пользователю

Идентификатор операции:
Event_GetAll

Выводит список всех событий, доступных текущему пользователю.
Результаты можно фильтровать с помощью таких критериев поиска, как диапазон дат, назначенный пользователь или состояние.
Полезно для создания отчетов, панелей мониторинга или автоматизации, обрабатывающих несколько событий.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 Id string

Задает уникальный идентификатор, связанный с событием. Установка этого свойства автоматически добавит соответствующий фильтр
Состояние события
 Status string

Задает состояние события, связанное с критериями поиска. Установка этого свойства автоматически добавит соответствующий фильтр
Состояние события
 EventStatus string

Задает состояние запрашиваемого события. Установка этого свойства автоматически добавит соответствующий фильтр
Дата начала
 StartDate date-time

Задает дату начала для условий поиска событий. Установка этого свойства автоматически добавит соответствующий фильтр
Присвоен идентификатору
 AssignedToId string

Задает коллекцию идентификаторов, связанных с назначенными пользователями события. Установка этого свойства автоматически добавит соответствующий фильтр
Связанные с идентификатором
 RelatedToId string

Задает идентификатор сущности, связанной с событием. Установка этого свойства автоматически применит фильтр с помощью
Дата сортировки
 SortDate string

Задает критерии сортировки на основе определенных значений дат, связанных с событием. При настройке этого свойства каждое значение в коллекции автоматически добавляется
Родительский идентификатор
 ParentId string

Задает идентификатор родительской сущности, связанной с событием. Если это свойство задано, соответствующий фильтр автоматически добавляется на основе предоставленного значения.
Идентификатор результата события
 EventResultId string

Задает идентификатор результата события, используемого для фильтрации событий. При назначении значения этому свойству автоматически применяется соответствующий фильтр.
Идентификатор приоритета
 PriorityId string

Задает идентификатор приоритета, связанный с событием. Установка этого свойства автоматически добавит соответствующий фильтр на основе идентификатора приоритета.
Искать
 Search string

Задает поисковый запрос, используемый для фильтрации событий на основе определенного ключевого слова или критерия. При установке этого свойства автоматически добавляется соответствующий фильтр типа Task.Api.Models.Enums.TaskFilterType.Search.
Последнее изменение
 LastModifiedBy string

Задает идентификатор пользователя, который последний раз изменил событие. Задание этого свойства добавит фильтр на основе идентификатора последнего измененного пользователя.
Создано автором
 CreatedBy string

Задает идентификатор пользователя сущности, созданной событием. Установка этого свойства автоматически добавит соответствующий фильтр для событий, созданных указанным пользователем.
Страница
 Page integer

Задает текущий номер страницы для результатов с разбивкой на страницы. Это значение используется для определения начальной точки набора данных для разбиения на страницы.
Размер страницы
 PageSize integer

Задает количество элементов, которые необходимо включить в одну страницу результатов с разбивкой на страницы. Это значение определяет размер набора данных, возвращаемого на страницу.
Сортировать
 Sort string

Представляет критерии сортировки результатов поиска. Это свойство определяет порядок сортировки и поля для набора данных.

Возвращаемое значение

response
array of Task.Api.Features.Events.EventDTO

Получение всех учетных записей для компании

Идентификатор операции:
Account_GetAll

Возвращает список всех учетных записей, принадлежащих указанной компании.
Пользователь, выполняя запрос, должен иметь соответствующие разрешения, определенные в заголовках запроса.
Фильтры можно применять с помощью параметров строки запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Родительская учетная запись
 ParentAccount string

Задает ParentAccount, связанный с текущим поиском.
Телефон
 Phone string

Задает номер телефона, связанный с текущим поиском.
Suggestions
 Suggestions string

Задает предложения, связанные с текущим поиском. Это значение используется для фильтрации результатов поиска на основе указанных предложений.
Идентификатор владельца
 OwnerId string

Указывает фильтр OwnerId, примененный к поиску текущей учетной записи.
Идентификатор владения
 OwnershipId string

Задает Идентификатор владения, используемый в качестве фильтра в поиске.
Идентификатор оценки
 RatingId string

Задает RatingId, связанный с текущим поиском. Используется для фильтрации учетных записей на основе их идентификатора рейтинга.
Идентификатор классификации
 ClassificationId string

Задает идентификатор классификации, используемый для фильтрации учетных записей на основе их классификации.
Идентификатор отрасли
 IndustryId string

Задает Объект IndustryId, связанный с текущим поиском.
Идентификатор источника учетной записи
 AccountSourceTypeId string

Задает AccountSourceTypeId, связанный с текущим поиском.
Первичный идентификатор контакта
 PrimaryContactId string

Представляет идентификатор основного контакта, связанного с поиском учетной записи.
Назначенные команды
 AssignedTeams string

Задает список команд, назначенных текущему поиску.
Искать
 Search string

Задает термин поиска, используемый для фильтрации текущих результатов поиска.
Имя
 Name string

Возвращает или задает имя учетной записи, которая будет использоваться в качестве фильтра в критерии поиска.
Идентификатор
 Id string

Представляет коллекцию идентификаторов учетных записей, используемых для фильтрации результатов поиска.
Страница
 Page integer

Указывает текущий номер страницы для результатов поиска с разбивкой на страницы.
Размер страницы
 PageSize integer

Указывает количество элементов, отображаемых на каждой странице в результатах поиска с разбивкой на страницы.
Сортировать
 Sort string

Представляет параметр сортировки для упорядочивания результатов поиска. Принимает разделенный запятыми список полей, префиксируемых "+" для возрастающего порядка или "-" для убывания. Значение по умолчанию — "id", если оно не указано.

Возвращаемое значение

response
array of Customer.Api.Features.Accounts.AccountDTO

Получение задачи вызова по идентификатору

Идентификатор операции:
Call_GetById

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

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор задачи вызова.

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Получение задачи по идентификатору

Идентификатор операции:
Task_GetById

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

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор задачи.

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Получение заметки по идентификатору

Идентификатор операции:
Note_GetById

Возвращает подробные сведения для указанной заметки, включая содержимое, создателя и связанную сущность.
Используйте это действие для просмотра или ссылки на конкретную заметку в службе автоматизации.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор заметки.

Возвращаемое значение

Тело
Task.Api.Features.Notes.NoteDTO

Получение команды по уникальному идентификатору

Идентификатор операции:
Team_GetById

Возвращает полные сведения указанной команды.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор команды.

Возвращаемое значение

Тело
Identity.Api.Teams.Dtos.GetTeamResponse

Получение контакта по идентификатору

Идентификатор операции:
Contact_GetById

Возвращает сведения для указанного контакта, предоставляя данные и сведения для конкретной компании.
Доступ определяется контекстом компании, предоставленным в заголовке x-companyid запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контакта
 contactId True string

Уникальный идентификатор извлекаемого контакта.

Возвращаемое значение

Тело
Customer.Api.Features.Contacts.Contact

Получение пользователя backoffice по идентификатору

Идентификатор операции:
User_GetById

Возвращает полные сведения о указанном пользователе, включая сведения о роли в данной компании.
Доступ определяется контекстом компании, предоставленным в заголовке запроса.

Параметры

Имя Ключ Обязательно Тип Описание
идентификатор пользователя
 userId True string

Уникальный идентификатор извлекаемого пользователя backoffice.

Возвращаемое значение

Тело
Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Получение свинца по идентификатору

Идентификатор операции:
Lead_GetById

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

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор свинца.

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Получение события по идентификатору

Идентификатор операции:
Event_GetById

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

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор события.

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Получение учетной записи по идентификатору

Идентификатор операции:
Account_GetById

Возвращает сведения об указанной учетной записи, включая данные, относящиеся к компании.
Доступ определяется контекстом компании, предоставленным в заголовке x-companyid запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 accountId True string

Уникальный идентификатор извлекаемой учетной записи.

Возвращаемое значение

Тело
Customer.Api.Features.Accounts.AccountDTO

Создание задачи

Идентификатор операции:
Task_Create

Используйте это действие для добавления новой задачи в систему.
Укажите такие сведения, как тема, описание, дата выполнения, приоритет и назначенный пользователь.
Созданная задача может быть получена, обновлена или удалена.

Параметры

Имя Ключ Обязательно Тип Описание
Тип задачи
 taskType string
субъект
 subject string
срок
 dueDate date-time
статус
 status string
Идентификатор приоритета
 priorityId string
присвоен идентификатор
 assignedToId string
присвоено типу
 assignedToType string
Идентификаторы контактов
 contactIds array of string
Тип контакта
 contactType string
связанный с идентификатором
 relatedToId string
связанный с типом
 relatedToType string
Идентификатор подтипа задачи
 taskSubTypeId string
comments
 comments string
Текст редактора
 editorBody string
Набор напоминаний
 reminderSet boolean
должность
 position integer
родительский идентификатор
 parentId string

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Создание заметки

Идентификатор операции:
Note_Create

Используйте это действие для добавления заметки в определенное действие или сущность.
Укажите такие сведения, как название, содержимое и связанные ссылки.
Созданная заметка может быть получена, обновлена или удалена.

Параметры

Имя Ключ Обязательно Тип Описание
Тип задачи
 taskType string
связанный с типом
 relatedToType string
Тип контакта
 contactType string
связанный с идентификатором
 relatedToId string
субъект
 subject True string
body
 body string
Текст редактора
 editorBody string
Идентификаторы контактов
 contactIds array of string

Возвращаемое значение

Тело
Task.Api.Features.Notes.NoteDTO

Создание нового вызова

Идентификатор операции:
Call_Create

Используйте это действие для создания нового действия вызова, включая тему, участников, запланированное время и состояние.
Созданный вызов можно позже получить, обновить или удалить.

Параметры

Имя Ключ Обязательно Тип Описание
срок
 dueDate date-time
субъект
 subject string
присвоено типу
 assignedToType string
присвоен идентификатор
 assignedToId string
связанный с типом
 relatedToType string
связанный с идентификатором
 relatedToId string
Тип контакта
 contactType string
Идентификаторы контактов
 contactIds array of string
статус
 status string
Длительность вызова
 callDuration date-span
Идентификатор результата вызова
 callResultId string
comments
 comments string
Текст редактора
 editorBody string
Идентификатор приоритета
 priorityId string
должность
 position integer
родительский идентификатор
 parentId string
Набор напоминаний
 reminderSet boolean
Дата сортировки
 sortDate date-time
исходный идентификатор
 sourceId string
источник, назначенный идентификатору
 sourceAssignedToId string
источник, связанный с идентификатором
 sourceRelatedToId string
исходные идентификаторы контактов
 sourceContactIds array of string
Направление вызова
 callDirection string

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Создание нового контакта

Идентификатор операции:
Contact_Create

Создает новый контакт в указанной компании.
Пользователь, выполняя запрос, должен иметь отношение x-permissions к этому действию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 id string
CompanyId
 companyId string
Идентификатор владельца
 ownerId string
AccountIds
 accountIds array of string
SourceId
 sourceId string
SourceOwnerId
 sourceOwnerId string
SourceAccountIds
 sourceAccountIds array of string
Имя
 firstName string
Фамилия
 lastName string
MiddleName
 middleName string
SalutationId
 salutationId string
Суффикс
 suffix string
Адрес электронной почты
 email string
Телефон
 phone string
MobilePhone
 mobilePhone string
Факс
 fax string
CallOptOut
 callOptOut boolean
EmailOptOut
 emailOptOut boolean
Адрес электронной почты
 emailAddress string
Тип
 type string
OptOut
 optOut boolean
Номер телефона
 phoneNumber string
Тип
 type string
OptOut
 optOut boolean
Название должности
 jobTitle string
GenderId
 genderId string
PronounceId
 pronounceId string
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Код страны
 countryCode string
Почтовый индекс
 postalCode string
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string
InsertDate
 insertDate date-time
UpdateDate
 updateDate date-time
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Отдел
 department string
ReportsTo
 reportsTo string
Помощник
 assistant string
Помощник По телефону
 assistantPhone string
Birthday
 birthday date-time
Description
 description string
LastStayInTouchReportedDate
 lastStayInTouchReportedDate date-time
LastStayInTouchSaveDate
 lastStayInTouchSaveDate date-time
AccountSourceTypeId
 accountSourceTypeId string
FullName
 fullName string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string

Возвращаемое значение

Тело
Customer.Api.Features.Contacts.ContactDTO

Создание нового свинца

Идентификатор операции:
Lead_Create

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

Параметры

Имя Ключ Обязательно Тип Описание
Название задания
 jobTitle string
Идентификатор состояния свинца
 leadStatusId string
имя
 firstName True string
фамилия
 lastName string
среднее имя
 middleName string
Идентификатор приветствия
 salutationId string
суффикс
 suffix string
электронная почта
 email string
phone
 phone string
мобильный телефон
 mobilePhone string
Адрес электронной почты
 emailAddress string
type
 type string
устраняться
 optOut boolean
Номер телефона
 phoneNumber string
type
 type string
устраняться
 optOut boolean
Отказ от звонка
 callOptOut boolean
Отказ от отправки электронной почты
 emailOptOut boolean
Идентификатор оценки
 ratingId string
Идентификатор владельца
 ownerId string
тип владельца
 ownerType string
веб-сайт
 website string
компания
 company string
Идентификатор отрасли
 industryId string
нет сотрудников
 noOfEmployees integer
Идентификатор источника учетной записи
 accountSourceTypeId string
адрес1
 address1 string
Адрес2
 address2 string
city
 city string
государство
 state string
country
 country string
почтовый индекс
 postalCode string
описание
 description string
годовой доход
 annualRevenue double
дата последней передачи
 lastTransferDate date-time
идентификатор пола
 genderId string
произнесение идентификатора
 pronounceId string
статус
 status string
Дополнительные поля
 extraFields object

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Создание новой возможной сделки

Идентификатор операции:
Opportunity_Create

Используйте это действие для создания новой возможности в конвейере продаж.
Возможность обычно представляет собой потенциальную сделку с учетной записью, связанной с потенциальным или созданным независимо.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа
 typeId string
Идентификатор владельца
 ownerId string
Идентификатор учетной записи
 accountId string
имя
 name True string
количество
 amount double
Идентификатор категории прогноза
 forecastCategoryId string
Идентификатор конвейера продаж
 salesPipelineId string
Дата закрытия
 closeDate True date-time
вероятность
 probability integer
счёт
 score integer
описание
 description string
Идентификатор кавычки
 quoteId string
Идентификатор состояния возможности
 opportunityStatusId string
статус
 status string
Идентификатор источника учетной записи
 accountSourceTypeId string
Следующий шаг
 nextStep string
бюджет подтвержден
 budgetConfirmed boolean
обнаружение завершено
 discoveryCompleted boolean
ожидаемый доход
 expectedRevenue double
Идентификатор причины потери
 lossReasonId string
частный
 private boolean
Дополнительные поля
 extraFields object

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Создание события

Идентификатор операции:
Event_Create

Используйте это действие для планирования или регистрации нового события.
Укажите такие сведения, как название, описание, участники и запланированное время.
Созданное событие может быть обновлено, извлечено или связано с другими действиями.

Параметры

Имя Ключ Обязательно Тип Описание
Дата обновления
 updateDate date-time
субъект
 subject string
Тип задачи
 taskType string
присвоено типу
 assignedToType string
присвоен идентификатор
 assignedToId string
связанный с типом
 relatedToType string
связанный с идентификатором
 relatedToId string
Тип контакта
 contactType string
Идентификаторы контактов
 contactIds array of string
описание
 description string
Текст редактора
 editorBody string
Идентификатор приоритета
 priorityId string
долгота
 longitude string
широта
 latitude string
Дата начала
 startDate date-time
Дата окончания
 endDate date-time
Набор напоминаний
 reminderSet boolean
создано by
 createdBy string
последнее изменение
 lastModifiedBy string
должность
 position integer
родительский идентификатор
 parentId string
repeat
 repeat string
Состояние события
 eventStatus string
Идентификатор результата события
 eventResultId string
Интервал повторения
 recurrenceInterval string
исходный идентификатор
 sourceId string
источник, назначенный идентификатору
 sourceAssignedToId string
источник, связанный с идентификатором
 sourceRelatedToId string
исходные идентификаторы контактов
 sourceContactIds array of string
Участники команды
 teamMembers array of string

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Создать новую учетную запись

Идентификатор операции:
Account_Create

Создает новую учетную запись в указанной компании.
Пользователь, выполняющий запрос, должен иметь отношение x-permissions к этому действию, а сведения о учетной записи должны быть допустимыми.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 id string
CompanyId
 companyId string
Имя
 name True string
Code
 code string
Олово
 tin string
Адрес электронной почты
 email string
Телефон
 phone string
SourceId
 sourceId string
SourceParentId
 sourceParentId string
SourceOwnerId
 sourceOwnerId string
PrimaryContactIds
 primaryContactIds array of string
ParentAccountId (Идентификатор родителя счета)
 parentAccountId string
Идентификатор владельца
 ownerId string
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Код страны
 countryCode string
Почтовый индекс
 postalCode string
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string
UpdateDate
 updateDate date-time
InsertDate
 insertDate date-time
TaxOffice
 taxOffice string
AccountSourceTypeId
 accountSourceTypeId string
IndustryId
 industryId string
TierId
 tierId string
Веб-сайт
 website string
AccountDescription
 accountDescription string
NoOfEmployees
 noOfEmployees integer
AnnualRevenue
 annualRevenue double
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Факс
 fax string
OwnershipId
 ownershipId string
RatingId
 ratingId string
ClassificationId
 classificationId string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string
AiScore
 aiScore double
AiScoreReasoning
 aiScoreReasoning string
AiSentiment
 aiSentiment integer
AiGenerationDate
 aiGenerationDate date-time

Возвращаемое значение

Тело
Customer.Api.Features.Accounts.AccountDTO

Удаление возможности по идентификатору

Идентификатор операции:
Opportunity_Delete

Окончательно удаляет возможность из системы.
Убедитесь, что возможность больше не требуется перед удалением, так как действие не может быть отменено.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор возможности удаления.

Удаление вызова по идентификатору

Идентификатор операции:
Call_Delete

Окончательно удаляет указанный вызов из системы.
Можно удалить только вызовы, доступные текущему пользователю.
Убедитесь, что вызов не связан с другими процессами перед удалением.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор вызова для удаления.

Удаление задачи по идентификатору

Идентификатор операции:
Task_Delete

Окончательно удаляет указанную задачу из системы.
Убедитесь, что задача не связана с другими процессами перед удалением.
Удалить можно только задачи, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор задачи для удаления.

Удаление заметки по идентификатору

Идентификатор операции:
Note_Delete

Окончательно удаляет указанную заметку из системы.
Убедитесь, что заметка не связана с другими процессами перед удалением.
Удалить можно только заметки, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор заметки для удаления.

Удаление контакта

Идентификатор операции:
Contact_Delete

Удаляет указанный контакт из указанной компании.
Доступ определяется контекстом компании, указанным в заголовке x-companyid .

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контакта
 contactId True string

Уникальный идентификатор удаленного контакта.

Удаление свинца по идентификатору

Идентификатор операции:
Lead_Delete

Окончательно удаляет свинца из системы. Убедитесь, что свинца не требуется для дальнейшей обработки или преобразования перед удалением.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор свинца для удаления.

Удаление события по идентификатору

Идентификатор операции:
Event_Delete

Окончательно удаляет указанное событие из системы.
Убедитесь, что событие не связано с другими процессами перед удалением.
Удалить можно только события, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор события для удаления.

Удаление учетной записи

Идентификатор операции:
Account_Delete

Удаляет указанную учетную запись для данной компании.
Запрос должен содержать допустимые x-companyid и соответствующие разрешения для продолжения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 accountId True string

Уникальный идентификатор учетной записи для удаления.

Триггеры

Возможность удаленного триггера

Окончательно удаляет возможность из системы.
Убедитесь, что возможность больше не требуется перед удалением, так как действие не может быть отменено.
Вызов обновленного триггера

Используйте это действие для изменения сведений о существующем вызове, таких как тема, участники, запланированное время или состояние.
Можно обновить только вызовы, доступные текущему пользователю.
Вызов созданного триггера

Используйте это действие для создания нового действия вызова, включая тему, участников, запланированное время и состояние.
Созданный вызов можно позже получить, обновить или удалить.
Вызов удаленного триггера

Окончательно удаляет указанный вызов из системы.
Можно удалить только вызовы, доступные текущему пользователю.
Убедитесь, что вызов не связан с другими процессами перед удалением.
Обновленный триггер возможности

Применяет изменения к полям указанной возможности, например имя, этап, сумма или ссылка учетной записи.
Доступен только в том случае, если у пользователя есть разрешения на запись.
Обновленный триггер задачи

Используйте это действие для изменения сведений о существующей задаче, таких как тема, описание, дата выполнения, приоритет или назначенный пользователь.
Можно обновить только задачи, доступные текущему пользователю.
Созданный триггер задачи

Используйте это действие для добавления новой задачи в систему.
Укажите такие сведения, как тема, описание, дата выполнения, приоритет и назначенный пользователь.
Созданная задача может быть получена, обновлена или удалена.
Триггер обновления свинца

Обновляет сведения о существующем потенциальных клиентах, таких как сведения о компании, контактные данные, состояние или источник. Можно обновить только потенциальных клиентов, доступных пользователю.
Триггер обновления события

Используйте это действие для изменения сведений о существующем событии, таких как название, описание, участники или запланированное время.
Можно обновить только события, доступные текущему пользователю.
Триггер создания возможностей

Используйте это действие для создания новой возможности в конвейере продаж.
Возможность обычно представляет собой потенциальную сделку с учетной записью, связанной с потенциальным или созданным независимо.
Триггер создания свинца

Используйте это действие для создания нового руководителя, включая сведения о компании, контактные данные и источник. Созданный свинца может быть обогащен, оценен, преобразован или обновлен.
Триггер создания события

Используйте это действие для планирования или регистрации нового события.
Укажите такие сведения, как название, описание, участники и запланированное время.
Созданное событие может быть обновлено, извлечено или связано с другими действиями.
Триггер удаления свинца

Окончательно удаляет свинца из системы. Убедитесь, что свинца не требуется для дальнейшей обработки или преобразования перед удалением.
Триггер удаления события

Окончательно удаляет указанное событие из системы.
Убедитесь, что событие не связано с другими процессами перед удалением.
Удалить можно только события, доступные текущему пользователю.
Удаленный триггер задачи

Окончательно удаляет указанную задачу из системы.
Убедитесь, что задача не связана с другими процессами перед удалением.
Удалить можно только задачи, доступные текущему пользователю.

Возможность удаленного триггера

Идентификатор операции:
Opportunity_Deleted

Окончательно удаляет возможность из системы.
Убедитесь, что возможность больше не требуется перед удалением, так как действие не может быть отменено.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Вызов обновленного триггера

Идентификатор операции:
Call_Updated

Используйте это действие для изменения сведений о существующем вызове, таких как тема, участники, запланированное время или состояние.
Можно обновить только вызовы, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Вызов созданного триггера

Идентификатор операции:
Call_Created

Используйте это действие для создания нового действия вызова, включая тему, участников, запланированное время и состояние.
Созданный вызов можно позже получить, обновить или удалить.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Вызов удаленного триггера

Идентификатор операции:
Call_Deleted

Окончательно удаляет указанный вызов из системы.
Можно удалить только вызовы, доступные текущему пользователю.
Убедитесь, что вызов не связан с другими процессами перед удалением.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Calls.CallDTO

Обновленный триггер возможности

Идентификатор операции:
Opportunity_Updated

Применяет изменения к полям указанной возможности, например имя, этап, сумма или ссылка учетной записи.
Доступен только в том случае, если у пользователя есть разрешения на запись.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Обновленный триггер задачи

Идентификатор операции:
Task_Updated

Используйте это действие для изменения сведений о существующей задаче, таких как тема, описание, дата выполнения, приоритет или назначенный пользователь.
Можно обновить только задачи, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Созданный триггер задачи

Идентификатор операции:
Task_Created

Используйте это действие для добавления новой задачи в систему.
Укажите такие сведения, как тема, описание, дата выполнения, приоритет и назначенный пользователь.
Созданная задача может быть получена, обновлена или удалена.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Триггер обновления свинца

Идентификатор операции:
Lead_Updated

Обновляет сведения о существующем потенциальных клиентах, таких как сведения о компании, контактные данные, состояние или источник. Можно обновить только потенциальных клиентов, доступных пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Триггер обновления события

Идентификатор операции:
Event_Updated

Используйте это действие для изменения сведений о существующем событии, таких как название, описание, участники или запланированное время.
Можно обновить только события, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Триггер создания возможностей

Идентификатор операции:
Opportunity_Created

Используйте это действие для создания новой возможности в конвейере продаж.
Возможность обычно представляет собой потенциальную сделку с учетной записью, связанной с потенциальным или созданным независимо.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Триггер создания свинца

Идентификатор операции:
Lead_Created

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

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Триггер создания события

Идентификатор операции:
Event_Created

Используйте это действие для планирования или регистрации нового события.
Укажите такие сведения, как название, описание, участники и запланированное время.
Созданное событие может быть обновлено, извлечено или связано с другими действиями.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Триггер удаления свинца

Идентификатор операции:
Lead_Deleted

Окончательно удаляет свинца из системы. Убедитесь, что свинца не требуется для дальнейшей обработки или преобразования перед удалением.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
SalesPipeline.Api.Features.Lead.LeadDto

Триггер удаления события

Идентификатор операции:
Event_Deleted

Окончательно удаляет указанное событие из системы.
Убедитесь, что событие не связано с другими процессами перед удалением.
Удалить можно только события, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Events.EventDTO

Удаленный триггер задачи

Идентификатор операции:
Task_Deleted

Окончательно удаляет указанную задачу из системы.
Убедитесь, что задача не связана с другими процессами перед удалением.
Удалить можно только задачи, доступные текущему пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Название
 Title True string

Название регистрации веб-перехватчика

Возвращаемое значение

Тело
Task.Api.Features.Tasks.TaskDTO

Определения

Task.Api.Features.CallDTO

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
Тип задачи
 taskType Task.Api.Models.Enums.TaskType
dueDate
 dueDate date-time
субъект
 subject string
присвоено типу
 assignedToType Task.Api.Models.Enums.AssignedToType
assignedToId
 assignedToId string
связанный с типом
 relatedToType Task.Api.Models.Enums.RelatedToType
relatedToId
 relatedToId string
Тип контакта
 contactType Task.Api.Models.Enums.ContactType
contactIds
 contactIds array of string
статус
 status Task.Api.Models.Enums.Status
callDuration
 callDuration date-span
callResultId
 callResultId string
comments
 comments string
editorBody
 editorBody string
priorityId
 priorityId string
последние изменения внесены
 lastModifiedBy string
создано кем
 createdBy string
должность
 position integer
parentId
 parentId string
набор напоминаний
 reminderSet boolean
sortDate
 sortDate date-time
sourceId
 sourceId string
sourceAssignedToId
 sourceAssignedToId string
sourceRelatedToId
 sourceRelatedToId string
sourceContactIds
 sourceContactIds array of string
Направление вызова
 callDirection Task.Api.Models.Enums.CallDirection

Task.Api.Features.Events.EventDTO

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
субъект
 subject string
Тип задачи
 taskType Task.Api.Models.Enums.TaskType
присвоено типу
 assignedToType Task.Api.Models.Enums.AssignedToType
assignedToId
 assignedToId string
связанный с типом
 relatedToType Task.Api.Models.Enums.RelatedToType
relatedToId
 relatedToId string
Тип контакта
 contactType Task.Api.Models.Enums.ContactType
contactIds
 contactIds array of string
описание
 description string
editorBody
 editorBody string
priorityId
 priorityId string
location
 location Task.Api.Features.Events.LocationDTO
startDate
 startDate date-time
Дата окончания
 endDate date-time
набор напоминаний
 reminderSet boolean
создано кем
 createdBy string
последние изменения внесены
 lastModifiedBy string
должность
 position integer
parentId
 parentId string
repeat
 repeat string
Состояние события
 eventStatus Task.Api.Models.Enums.EventStatus
eventResultId
 eventResultId string
повторениеInterval
 recurrenceInterval string
sourceId
 sourceId string
sourceAssignedToId
 sourceAssignedToId string
sourceRelatedToId
 sourceRelatedToId string
sourceContactIds
 sourceContactIds array of string
teamMembers
 teamMembers array of string

Task.Api.Features.Events.LocationDTO

Имя Путь Тип Описание
долгота
 longitude string
широта
 latitude string

Task.Api.Features.Notes.NoteDTO

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
связанный с типом
 relatedToType Task.Api.Models.Enums.RelatedToType
relatedToId
 relatedToId string
субъект
 subject string
создано кем
 createdBy string
последние изменения внесены
 lastModifiedBy string
body
 body string
editorBody
 editorBody string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
contactIds
 contactIds array of string
Тип контакта
 contactType Task.Api.Models.Enums.ContactType
Тип задачи
 taskType Task.Api.Models.Enums.TaskType
sortDate
 sortDate date-time

Task.Api.Features.Tasks.TaskDTO

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
создано кем
 createdBy string
последние изменения внесены
 lastModifiedBy string
Тип задачи
 taskType Task.Api.Models.Enums.TaskType
субъект
 subject string
dueDate
 dueDate date-time
completedDate
 completedDate date-time
статус
 status Task.Api.Models.Enums.Status
priorityId
 priorityId string
assignedToId
 assignedToId string
присвоено типу
 assignedToType Task.Api.Models.Enums.AssignedToType
contactIds
 contactIds array of string
Тип контакта
 contactType Task.Api.Models.Enums.ContactType
relatedToId
 relatedToId string
связанный с типом
 relatedToType Task.Api.Models.Enums.RelatedToType
taskSubTypeId
 taskSubTypeId string
comments
 comments string
editorBody
 editorBody string
набор напоминаний
 reminderSet boolean
должность
 position integer
parentId
 parentId string

Task.Api.Models.Enums.AssignedToType

присвоено типу
string

Task.Api.Models.Enums.CallDirection

Направление вызова
string

Task.Api.Models.Enums.ContactType

Тип контакта
string

Task.Api.Models.Enums.EventStatus

Состояние события
string

Task.Api.Models.Enums.RelatedToType

связанный с типом
string

Task.Api.Models.Enums.Status

статус
string

Task.Api.Models.Enums.TaskType

Тип задачи
string

SalesPipeline.Api.DTOs.AddressDto

Имя Путь Тип Описание
адрес1
 address1 string
Адрес2
 address2 string
city
 city string
государство
 state string
country
 country string
почтовый индекс
 postalCode string

SalesPipeline.Api.DTOs.EmailDTO

Имя Путь Тип Описание
Адрес электронной почты
 emailAddress string
type
 type SalesPipeline.Api.Models.Enums.EmailType
устраняться
 optOut boolean

SalesPipeline.Api.DTOs.NameDTO

Имя Путь Тип Описание
имя
 firstName string
фамилия
 lastName string
среднее имя
 middleName string
Идентификатор приветствия
 salutationId string
суффикс
 suffix string

SalesPipeline.Api.DTOs.PhoneDTO

Имя Путь Тип Описание
Номер телефона
 phoneNumber string
type
 type SalesPipeline.Api.Models.Enums.PhoneType
устраняться
 optOut boolean

SalesPipeline.Api.Features.Lead.LeadDto

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
Название должности
 jobTitle string
leadStatusId
 leadStatusId string
имя
 name SalesPipeline.Api.DTOs.NameDTO
электронная почта
 email string
phone
 phone string
мобильный телефон
 mobilePhone string
otherEmail
 otherEmail array of SalesPipeline.Api.DTOs.EmailDTO
otherPhone
 otherPhone array of SalesPipeline.Api.DTOs.PhoneDTO
callOptOut
 callOptOut boolean
emailOptOut
 emailOptOut boolean
ratingId
 ratingId string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
ownerId
 ownerId string
тип владельца
 ownerType SalesPipeline.Api.Models.Enums.OwnerType
веб-сайт
 website string
компания
 company string
IndustryId
 industryId string
noOfEmployees
 noOfEmployees integer
accountSourceTypeId
 accountSourceTypeId string
address
 address SalesPipeline.Api.DTOs.AddressDto
описание
 description string
создано кем
 createdBy string
последние изменения внесены
 lastModifiedBy string
annualRevenue
 annualRevenue double
lastTransferDate
 lastTransferDate date-time
genderId
 genderId string
pronounceId
 pronounceId string
fullName
 fullName string
статус
 status SalesPipeline.Api.Models.Enums.Status
extraFields
 extraFields object
aiScore
 aiScore double
aiScoreReasoning
 aiScoreReasoning string
aiSentiment
 aiSentiment SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment
aiGenerationDate
 aiGenerationDate date-time

SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment

string

SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Имя Путь Тип Описание
id
 id string
companyId
 companyId string
accountId
 accountId string
TypeId
 typeId string
ownerId
 ownerId string
имя
 name string
количество
 amount double
forecastCategoryId
 forecastCategoryId string
salesPipelineId
 salesPipelineId string
insertDate
 insertDate date-time
updateDate
 updateDate date-time
CloseDate
 closeDate date-time
вероятность
 probability integer
счёт
 score integer
описание
 description string
quoteId
 quoteId string
opportunityStatusId
 opportunityStatusId string
статус
 status SalesPipeline.Api.Models.Enums.OpportunityStatus
accountSourceTypeId
 accountSourceTypeId string
nextStep
 nextStep string
budgetConfirmed
 budgetConfirmed boolean
discoveryCompleted
 discoveryCompleted boolean
expectedRevenue
 expectedRevenue double
lossReasonId
 lossReasonId string
частный
 private boolean
создано кем
 createdBy string
последние изменения внесены
 lastModifiedBy string
extraFields
 extraFields object
aiScore
 aiScore double
aiScoreReasoning
 aiScoreReasoning string
aiSentiment
 aiSentiment SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment
aiGenerationDate
 aiGenerationDate date-time

SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment

string

SalesPipeline.Api.Models.Enums.EmailType

type
string

SalesPipeline.Api.Models.Enums.OpportunityStatus

статус
string

SalesPipeline.Api.Models.Enums.OwnerType

тип владельца
string

SalesPipeline.Api.Models.Enums.PhoneType

type
string

SalesPipeline.Api.Models.Enums.Status

статус
string

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Имя Путь Тип Описание
id
 id string

Идентификатор пользователя
электронная почта
 email string

Электронная почта пользователя.
Имя
 firstName string

Имя пользователя.
lastName
 lastName string

Фамилия пользователя
fullName
 fullName string

Полное имя пользователя
userRole
 userRole Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role
profileImage
 profileImage Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image
lastLogin
 lastLogin date-time

Дата последнего входа пользователей. Может иметь значение NULL, если пользователь никогда не вошел в систему
insertDate
 insertDate date-time

Дата создания пользователя
updateDate
 updateDate date-time

Дата последнего обновления пользователя.

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image

Имя Путь Тип Описание
id
 id string
galleryId
 galleryId string

Идентификатор, хранящийся в коллекции
ALT
 alt string

Замещающий элемент для отображения
link
 link string

URL-адрес изображения

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role

Имя Путь Тип Описание
companyId
 companyId string

Идентификатор компании для роли всегда будет идентификатором компании, который вы запрашивали для пользователей.
isAdmin
 isAdmin boolean

Считается ли этот пользователь администратором в текущей компании.
roleId
 roleId string

Идентификатор роли, если пользователь не является администратором. Когда пользователь является администратором, идентификатор роли будет отсутствует.

Identity.Api.Teams.Dtos.GetTeamResponse

Имя Путь Тип Описание
id
 id string
имя
 name string
users
 users array of Identity.Api.Teams.Dtos.TeamUserDto
modifiedBy
 modifiedBy string
создано кем
 createdBy string
createdAt
 createdAt date-time
modifiedAt
 modifiedAt date-time

Identity.Api.Teams.Dtos.TeamUserDto

Имя Путь Тип Описание
id
 id string

Customer.Api.DTOs.AddressDTO

Имя Путь Тип Описание
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Код страны
 countryCode string
Почтовый индекс
 postalCode string
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string

Customer.Api.Features.Accounts.AccountDTO

Имя Путь Тип Описание
Идентификатор
 id string
CompanyId
 companyId string
Имя
 name string
Code
 code string
Олово
 tin string
Адрес электронной почты
 email string
Телефон
 phone string
SourceId
 sourceId string
SourceParentId
 sourceParentId string
SourceOwnerId
 sourceOwnerId string
PrimaryContactIds
 primaryContactIds array of string
ParentAccountId (Идентификатор родителя счета)
 parentAccountId string
Идентификатор владельца
 ownerId string
address
 address Customer.Api.DTOs.AddressDTO
UpdateDate
 updateDate date-time
InsertDate
 insertDate date-time
TaxOffice
 taxOffice string
AccountSourceTypeId
 accountSourceTypeId string
IndustryId
 industryId string
TierId
 tierId string
Веб-сайт
 website string
AccountDescription
 accountDescription string
NoOfEmployees
 noOfEmployees integer
AnnualRevenue
 annualRevenue double
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Факс
 fax string
OwnershipId
 ownershipId string
RatingId
 ratingId string
ClassificationId
 classificationId string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string
AiScore
 aiScore double
AiScoreReasoning
 aiScoreReasoning string
AiSentiment
 aiSentiment integer
AiGenerationDate
 aiGenerationDate date-time

Customer.Api.Features.Contacts.Contact

Имя Путь Тип Описание
Идентификатор
 id string
CompanyId
 companyId string
PartitionKey
 partitionKey string
Идентификатор владельца
 ownerId string
AccountIds
 accountIds array of string
SourceId
 sourceId string
SourceAccountIds
 sourceAccountIds array of string
SourceOwnerId
 sourceOwnerId string
имя
 name Customer.Api.Features.Contacts.Name
Адрес электронной почты
 email string
Телефон
 phone string
MobilePhone
 mobilePhone string
Факс
 fax string
CallOptOut
 callOptOut boolean
EmailOptOut
 emailOptOut boolean
OtherEmail
 otherEmail array of Customer.Api.Features.Contacts.Email
OtherPhone
 otherPhone array of Customer.Api.Features.Contacts.Phone
Название должности
 jobTitle string
GenderId
 genderId string
PronounceId
 pronounceId string
address
 address Customer.Api.Models.Address
InsertDate
 insertDate date-time
UpdateDate
 updateDate date-time
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Отдел
 department string
ReportsTo
 reportsTo string
Помощник
 assistant string
Помощник По телефону
 assistantPhone string
Birthday
 birthday date-time
Description
 description string
LastStayInTouchReportedDate
 lastStayInTouchReportedDate date-time
LastStayInTouchSaveDate
 lastStayInTouchSaveDate date-time
AccountSourceTypeId
 accountSourceTypeId string
ЭкстраФилды
 extraFields object
SearchTags
 searchTags array of string
AssignedTeams
 assignedTeams array of string

Customer.Api.Features.Contacts.ContactDTO

Имя Путь Тип Описание
Идентификатор
 id string
CompanyId
 companyId string
Идентификатор владельца
 ownerId string
AccountIds
 accountIds array of string
SourceId
 sourceId string
SourceOwnerId
 sourceOwnerId string
SourceAccountIds
 sourceAccountIds array of string
имя
 name Customer.Api.Features.Contacts.NameDTO
Адрес электронной почты
 email string
Телефон
 phone string
MobilePhone
 mobilePhone string
Факс
 fax string
CallOptOut
 callOptOut boolean
EmailOptOut
 emailOptOut boolean
OtherEmail
 otherEmail array of Customer.Api.Features.Contacts.EmailDTO
OtherPhone
 otherPhone array of Customer.Api.Features.Contacts.PhoneDTO
Название должности
 jobTitle string
GenderId
 genderId string
PronounceId
 pronounceId string
address
 address Customer.Api.DTOs.AddressDTO
InsertDate
 insertDate date-time
UpdateDate
 updateDate date-time
Создано пользователем
 createdBy string
Последнее изменение сделано
 lastModifiedBy string
Отдел
 department string
ReportsTo
 reportsTo string
Помощник
 assistant string
Помощник По телефону
 assistantPhone string
Birthday
 birthday date-time
Description
 description string
LastStayInTouchReportedDate
 lastStayInTouchReportedDate date-time
LastStayInTouchSaveDate
 lastStayInTouchSaveDate date-time
AccountSourceTypeId
 accountSourceTypeId string
FullName
 fullName string
ЭкстраФилды
 extraFields object
AssignedTeams
 assignedTeams array of string

Customer.Api.Features.Contacts.Email

Имя Путь Тип Описание
Адрес электронной почты
 emailAddress string
Тип
 type string
OptOut
 optOut boolean

Customer.Api.Features.Contacts.EmailDTO

Имя Путь Тип Описание
Адрес электронной почты
 emailAddress string
Тип
 type string
OptOut
 optOut boolean

Customer.Api.Features.Contacts.Name

Имя Путь Тип Описание
Имя
 firstName string
Фамилия
 lastName string
MiddleName
 middleName string
SalutationId
 salutationId string
Суффикс
 suffix string

Customer.Api.Features.Contacts.NameDTO

Имя Путь Тип Описание
Имя
 firstName string
Фамилия
 lastName string
MiddleName
 middleName string
SalutationId
 salutationId string
Суффикс
 suffix string

Customer.Api.Features.Contacts.Phone

Имя Путь Тип Описание
Номер телефона
 phoneNumber string
Тип
 type string
OptOut
 optOut boolean

Customer.Api.Features.Contacts.PhoneDTO

Имя Путь Тип Описание
Номер телефона
 phoneNumber string
Тип
 type string
OptOut
 optOut boolean

Customer.Api.Models.Address

Имя Путь Тип Описание
Имя
 firstName string
Фамилия
 lastName string
Номер телефона
 phoneNumber string
Адрес электронной почты
 email string
Адрес1
 address1 string
Адрес2
 address2 string
Город
 city string
Государство
 state string
Широта
 latitude string
Longtitude
 longtitude string
Страна
 country string
Почтовый индекс
 postalCode string
Код страны
 countryCode string