Pour: Administrateurs
Ajouter et supprimer des membres d'un dossier à l'aide d'une clé de gestion
Attribuer les dossiers aux personnes en leur attribuant un rôle et une désignation, envoyer l'e-mail d'invitation, consulter la liste des personnes affectées à un dossier ou en retirer une.
Dans cet article8 sections
Avant de commencer
Cette page traite des appels qui mettent des personnes dans certains cas ou les retirent de ceux-ci. Les parcours sont situés sous https://prd-api-manage.caseactive.com/v1/<hub id>. La personne doit déjà être présente dans votre hub. Pour plus d’informations, veuillez consulter Ajouter et mettre à jour les utilisateurs avec une clé de gestion .
Appels
| Appel | Ce que cela fait |
|---|---|
GET /cases/permissions?case_id=<case_id> | Liste de toutes les personnes impliquées dans une affaire. |
POST /cases/permissions | Cela fait en sorte que quelqu’un soit chargé de l’affaire. |
GET /cases/permissions/<case_id>/<user_id> | Lire la position d’une personne dans une affaire donnée. |
PUT /cases/permissions/<case_id>/<user_id> | Changer la désignation de quelqu’un dans une affaire |
DELETE /cases/permissions/<case_id>/<user_id> | Retire quelqu’un d’une affaire. |
Il n’est pas nécessaire de changer le rôle de quelqu’un dans un cas donné, ni de lui envoyer une nouvelle invitation. Il suffit de le retirer de la liste des personnes invitées, puis de l’ajouter à nouveau, en tenant compte des règles relatives à son rôle dans le cas en question.
Ajouter quelqu'un
| Champ | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
case_id | Cet article provient de votre hub. | Oui. | — |
user_id | Cette personne, originaire de votre ville natale… Une personne handicapée vivant dans votre ville natale a été refusée. | Oui. | — |
case_role_id | Leur rôleRôle Un ensemble d'autorisations qui détermine ce qu'une personne peut voir et faire sur un dossier, qu'il s'agisse de membres du personnel ou de clients. dans cette affaire est le suivant : role::clients, role::staff, ou l’un de vos rôles personnalisés provenant de GET /roles. Le role::bots de l’assistante virtuelle est refusé. | Oui. | — |
case_notify | true envoie aux personnes concernées l’invitation pour leur affaire. | Oui. | — |
staff_designation | Pour role::staff et vos rôles personnalisés : primary, attorney, paralegal, case_manager, lead_attorney ou lead_paralegal | Non. | primary |
client_designation | Pour role::clients : primary ou guardian | Non. | primary |
Une designationDésignation Une étiquette désignant le rôle d'une personne dans une affaire, comme avocat principal, assistant juridique ou tuteur. indique qui est responsable d’un cas donné. Ainsi, les modèles peuvent indiquer, par exemple, le client principal du cas en question. role::clients conserve client_designation, tandis que toutes les autres rôles conservent staff_designation. On peut omettre l’autre désignation, ou envoyer primary : une guardian avec n’importe quel autre rôle, ou une désignation de personnel avec role::clients, sera rejetée dans le champ correspondant ; personne ne sera donc ajouté.
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"}'
Cela répond à 201 avec case_id et user_id.
- Ce véhicule peut accueillir 20 personnes, y compris son assistant virtuelAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel.. Donc, il y a encore 19 personnes qui peuvent être transportées dans ce véhicule.
- Un cas clos ne nécessite aucune attention de la part des personnes concernées. Il est préférable de rouvrir le dossier en premier lieu. Pour cela, consultez l’article Créer et mettre à jour les dossiers avec une clé de gestion.
- La personne peut voir l’affaire directement dans son portail.
Que se passe-t-il ensuite ?
- Lorsque
case_notifyest fixé àtrue, la personne reçoit une invitation de votre entreprise, accompagnée d’un lien lui permettant d’y accéder. L’invitation est envoyée à son adresse e-mail confirmée, ou par texto au numéro de téléphone confirmé, si elle n’a pas d’adresse e-mail. Si aucune de ces informations n’est disponible, rien n’est envoyé. Ceux qui ont supprimé l’accès de votre entreprise ne reçoivent donc aucune invitation. - Les règles de bienvenue liées à leur rôle ajoutent leurs modèles au cas en question. Veuillez consulter Comment accueillir les clients lorsqu’ils rejoignent un cas.
- Personne n’a posté aucun message concernant cette affaire. Cependant, les modèles de postes pour les règles souhaitables ont bien été publiés, et aucun webhook n’a été envoyé.
Modifier une désignation
PUT /cases/permissions/<case_id>/<user_id> avec {"case_designation": "lead_attorney"} qui répond à 204. Cela modifie simplement la désignation de la personne concernée, mais rien d’autre. Elle reste dans toutes les situations où elle se trouve actuellement. Personne n’est envoyé ailleurs, et aucune règle de bienvenue ne s’applique. Le prochain post et le formulaire rempli utilisent donc la nouvelle désignation.
Le nom doit correspondre au rôle qu’ils jouent dans l’affaire concernée : primary ou guardian pour role::clients. Pour les autres rôles, il y a six options possibles. Le nom du assistant virtuel ne peut pas être modifié.
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"}'
Lire qui est sur une affaire
GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 répond à toutes les questions concernant cette affaire, y compris au Virtual Assistant. Comme 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"
}
}
Chaque entrée contient également une copie des informations relatives aux cas concernés, sous les noms title et description. Les adresses e-mail et numéros de téléphone ne sont pas incluses : veuillez consulter la personne correspondante via GET /users/relations/<user_id>. Un cas qui n’est pas inclus dans votre liste de réponses correspond à une liste vide.
Enlever quelqu'un
DELETE /cases/permissions/<case_id>/<user_id> répond à 204, même lorsque la personne n’est pas présente pour participer au traitement du cas. Il est donc safe de répéter cette action. Personne ne reçoit d’information supplémentaire ; toutefois, la personne reçoit une notification de suppression pour chaque événement prévu concernant le cas, qu’il ait été traité ou non. La personne perd alors le cas depuis son propre portail. L’assistante virtuelle ne peut pas être retirée.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 400 | SchemaFieldsException | Un champ est manquant ou est inválable. errors C’est un nom que l’on peut utiliser pour désigner une situation, une personne ou un rôle qui ne fait pas partie de votre « hub ». FieldValidatorFailedException Sur ce terrain, une telle désignation ne joue aucun rôle. |
| 400 | FieldUserDupsException | La personne est déjà sur l’affaire. |
| 400 | CaseUserLimitOrTransactionException | Le cas concerne déjà 20 personnes. Il s’agit donc d’une situation très complexe. Vérifiez le nombre de personnes concernées, puis réessayez. |
| 400 | TransactionCanceledException | Un moment chargé a annulé l’ajout de cette annonce. Veuillez essayer à nouveau. |
| 400 | CaseUserDisabledException | La personne concernée est handicapée dans votre hub. Il est nécessaire de les réactiver d’abord. |
| 403 | CaseClosedException | L’affaire est close. Il n’y a pas de besoin d’ajouter de nouveaux éléments ou de modifier les informations concernant cette personne. |
| 403 | DatabaseTransactionConditionalCheckFailed | Vous avez essayé de supprimer l’assistant virtuel. |
| 404 | ItemNotFoundException | Lire les informations concernant une personne ou changer son statut : cette personne n’est pas concernée par l’affaire en question, ou l’affaire ne se trouve pas dans votre espace de travail. Ajouter une personne ou changer son statut : l’affaire est alors supprimée. |
Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.