Центр поддержкиИнтеграции

Для: Администраторы

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

Распределяйте людей по делам, указывая их роли и должности, отправляйте приглашения по электронной почте, читайте список участников дела или снимайте кого-либо с участия.

В этой статье8 разделов

Прежде чем начать

На этой странице описаны действия, связанные с приемом и удалением пользователей из списка. Пути для этих действий указаны под https://prd-api-manage.caseactive.com/v1/<hub id>. Пользователь должен уже находиться в вашем хабе; подробности смотрите в разделе Добавление и обновление пользователей с использованием управляющей ключи.

Звонки

ВызовЧто это делает
GET /cases/permissions?case_id=<case_id>Перечень всех людей, связанных с данным делом.
POST /cases/permissionsПривлекает кого-то к ответственности.
GET /cases/permissions/<case_id>/<user_id>Определяет место одного человека в данном случае.
PUT /cases/permissions/<case_id>/<user_id>Изменение назначения человека по делу
DELETE /cases/permissions/<case_id>/<user_id>Вытаскивает кого-то из деле.

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

Добавление кого-либо

ПолеЧто это делаетНеобходимыйПо умолчанию
case_idЭтот случай касается вашего хаба.Да.—
user_idЭтот человек из вашего района… Кто-то из людей из вашего района был отклонен.Да.—
case_role_idИх РольРоль Набор разрешений, определяющий, что может видеть и делать тот или иной пользователь в рамках дела, например, сотрудники или клиенты. В данном случае, в полном объеме: role::clients, role::staff Или одна из ваших пользовательских ролей. GET /roles. Виртуальный помощник role::bots Отказано.Да.—
case_notifytrue отправляет им приглашение для участия в их деле.Да.—
staff_designationДля role::staff и ваших пользовательских ролей: primary, attorney, paralegal, case_manager, lead_attorney или lead_paralegalНет.primary
client_designationДля role::clients: primary или guardianНет.primary

А назначениеОбозначение Обозначение должности, занимаемой сотрудником по делу, например, ведущий юрист, помощник юриста или опекун. Это указывает, кто является ответственным за рассмотрение данного дела. Таким образом, шаблоны позволяют указывать имя основного клиента, который участвует в рассмотрении дела. role::clients держит client_designation, И все остальные роли также сохраняются. staff_designation. Оставьте другой вариант без внимания, или отправьте его в другое место. primary: а guardian Любая другая должность или назначение в штате… role::clients, Это запрещено на этом поле; никто не может быть добавлен в список.

curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id": "cc-1a2b3c4d5e6f70", "user_id": "cu-4f1c2a9e8b7d60", "case_role_id": "role::clients", "case_notify": true, "client_designation": "primary"}'

Это соответствие между 201 и case_id, а также user_id.

  • В этом отеле размещается 20 человек, включая виртуального помощникаВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника.. Следовательно, в отеле находится ещё 19 человек.
  • Закрытый случай не требует внимания. Сначала необходимо восстановить его. См. раздел Создание и обновление случаев с использованием функции управления ими.
  • Люди сразу видят информацию о данном случае на своем портале.

Что произойдет дальше?

  • Если значение case_notify установлено на true, то человек получает приглашение от вашей компании. В приглашении содержится ссылка, которая позволяет ему войти в систему. Приглашение отправляется на его подтвержденную электронную почту или по телефону, если у него нет электронной почты. Если ни одно из этих условий не выполняется, ничего не отправляется. Человек, у которого удалено право доступа к вашей компании, ничего не получает.
  • Правила входа клиентов в их случаи включают соответствующие шаблоны. См. Приветствие клиентов при их входе в случай.
  • Человек, который публикует посты на этой странице, ничего не пишет по поводу самого случая. Однако шаблоны для правил приветствия все же размещаются на странице, а webhook не отправляется.

Изменение обозначения

С использованием значений PUT /cases/permissions/<case_id>/<user_id>, {"case_designation": "lead_attorney"} и 204 меняется только название человека в данном случае. В остальном все остается как прежде: человек продолжает иметь все свои права и обязанности. Никто не получает никаких новых прав или обязанностей, а также не действует никакие правила приветствия. Следующий шаблон поста и заполненный формуляр используют новые значения.

Этот титул должен соответствовать их роли в данной ситуации. primary или guardian для role::clients, А также шесть должностей, связанных с выполнением других обязанностей. Должности виртуального помощника не могут быть изменены.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions/cc-1a2b3c4d5e6f70/cu-9d8c7b6a5f4e30 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_designation": "lead_attorney"}'

Читаю, кто занимается тем или иным делом.

GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 может ответить на все вопросы по данному делу одновременно, включая виртуального помощника. А именно: role::bots

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": true,
        "case_status": 1,
        "case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
        "given_name": "Jane",
        "family_name": "Sample",
        "host_user_status": 1,
        "locale": "en",
        "zoneinfo": "US/Eastern",
        "created_on": "2026-10-02T14:06:30+00:00"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions?case_id=cc-1a2b3c4d5e6f70"
  }
}

В каждой записи также содержится копия значений title и description. Адреса электронной почты и номера телефонов не указаны; для получения информации о данной личности необходимо обратиться к человеку с адресом GET /users/relations/<user_id>. Если дело не находится в вашей базе данных, то список будет пустым.

Снятие с кого-либо

Ответы DELETE /cases/permissions/<case_id>/<user_id> содержат информацию о 204. Это касается случаев, когда человек не участвовал в рассмотрении дела. Поэтому можно повторять эти ответы. Никому не сообщается об этом, но человеку отправляется уведомление о отмене всех предстоящих мероприятий, связанных с данным делом, независимо от того, были ли ответы получены или нет. Человек теряет доступ к делу через свой портал. Виртуальный помощник также не может быть удален.

Если звонок отклонен

СтатусmessageПочему
400SchemaFieldsExceptionПоле отсутствует или имеет некорректное значение. errors Это название того случая, человека или роли, который не находится в вашем хабе. FieldValidatorFailedException На том поле… Также существует определение, которое не соответствует данной роли.
400FieldUserDupsExceptionЛюдина уже находится в процессе работы над этим делом.
400CaseUserLimitOrTransactionExceptionВ данном случае уже 20 человек зарегистрированы как участники мероприятия. Возможно, это привело к отмене записи на участие в мероприятии. Проверьте количество участников, а затем попробуйте снова.
400TransactionCanceledExceptionНекоторые моменты, связанные с работой, помешали выполнению этой задачи. Попробуйте снова.
400CaseUserDisabledExceptionУ этого человека есть инвалидность в вашем хабе. Сначала активируйте его полномочия снова.
403CaseClosedExceptionДело закрыто. Не требуется никаких изменений в описании или назначении объекта.
403DatabaseTransactionConditionalCheckFailedВы попытались отключить виртуального помощника.
404ItemNotFoundExceptionЕсли вы читаете информацию о каком-либо человеке или меняете его должность/назначение – это означает, что данный человек не участвует в рассмотрении дела, или дело не находится в вашем распоряжении. Если вы добавляете нового человека или меняете его должность/назначение – это означает, что дело удаляется из обработки.

Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.

Статьи по теме

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