帮助中心集成

为了: 管理员

使用管理密钥添加和删除案例成员

为案件分配人员角色和职称,发送邀请邮件,查看案件中的人员,或将某人从案件中移除。

在本文中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读取某人的信息或更改其角色:该人并未处于该案件处理中,或者该案件并不在你的管辖范围内。添加新人员或更改角色:意味着该案件将被删除。

关于错误 bodies 以及其他代码格式,请参考 处理 API 错误和状态代码 的相关说明。

相关文章

使用管理密钥创建和更新案例使用您自己的软件列出、创建、读取、更新和删除您中心的案例,包括其阶段和自定义字段。集成使用管理密钥添加和更新用户列出您中心的成员,添加客户,查看某人的详细信息和案例,以及禁用或重新启用他们的访问权限。集成读取具有管理密钥的角色列出您中心的角色并读取其中一个角色的权限,以便您的软件可以将具有正确角色的人员分配到案例中。集成