ヘルプセンター統合

のために: 管理者

管理キーを使用してケースメンバーを追加および削除します。

担当者に役割と役職を割り当てたり、招待メールを送信したり、担当者を確認したり、担当者を外したりすることができます。

この記事では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_designationrole::staffと、お客様が定義したロールであるprimary、attorney、paralegal、case_manager、lead_attorney、またはlead_paralegalについてです。いいえ。primary
client_designationrole::clientsの場合:primaryまたはguardianいいえ。primary

<A指定指定 事件における担当者の役職を表すラベル。例えば、主任弁護士、パラリーガル、後見人など。によって、その人がどのケースを担当しているかがわかります。例えば、テンプレートでは、そのケースの主要なクライアントの名前を記載することができます。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に設定すると、その人はあなたの会社から招待状を受け取ります。その招待状には、その案件にログインするためのリンクが含まれています。この招待状は、その人の確認済みのメールアドレスに送信されます。もしメールアドレスがない場合は、その人の確認済みの電話番号にテキストメッセージとして送信されます。しかし、どちらも持っていない場合は、何も送信されません。また、あなたの会社のアクセス権を解除された人には、何も送信されません。
  • 彼らの役割に関する歓迎規則では、彼らがケースに参加した際の歓迎方法についてのテンプレートが追加されています。詳細は ケースに参加したクライアントを歓迎する方法をご覧ください。
  • その人は、その案件に関する何の投稿もしていません。ただし、歓迎用のルールに関する投稿テンプレートは掲載されており、ウェブホックも送信されていません。

役職の変更

PUT /cases/permissions/<case_id>/<user_id>に対して、{"case_designation": "lead_attorney"}が204を回答します。これにより、その人物の役割が変わるだけで、他には何も変わりません。彼らは以前と同じ状態のままで、誰も何かを送られることはありません。また、どんな歓迎ルールも適用されません。次のテンプレートや事前入力されたフォームでは、新しい設定が使用されます。

その名称は、その人がその案件で果たす役割に合わせて決められるべきです。 primary または guardian ためには role::clients, そして、他の役割に関する6つのスタッフの名称も変更することはできません。バーチャルアシスタントの名称は変更できないのです。

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のエラーやステータスコードの処理方法を参照してください。

関連記事

管理キーを使用してケースを作成および更新します。ハブのケースを、ステージやカスタムフィールドを含め、独自のソフトウェアから一覧表示、作成、閲覧、更新、削除できます。統合管理キーを使用してユーザーを追加および更新します。ハブのメンバー一覧を表示したり、クライアントを追加したり、個々のユーザーの詳細情報や案件を閲覧したり、アクセス権を無効化または有効化したりできます。統合管理キーを持つロールを読み取るハブの役割を一覧表示し、それぞれの役割の権限を読み取ることで、ソフトウェアが適切な役割を持つ担当者をケースに割り当てられるようにします。統合