Centre d'aideIntégrations

Pour: Administrateurs

Consultez et mettez à jour les détails du dossier à l'aide d'une clé de hub.

Consultez les détails d'un dossier et de l'équipe, et modifiez les détails que l'administrateur autorise le rôle de l'assistant virtuel à modifier, tels que l'étape ou un champ personnalisé.

Dans cet article8 sections

Avant de commencer

Cette page traite de la lecture et du changement des détails d’un cas, à l’aide d’une clé de hub. Les chemins sont indiqués sous https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Appels

AppelCe que cela fait
GET /caseLise les détails de l’affaire.
PUT /caseCela modifie les détails ; la clé peut changer.
GET /whoamiIl indique en détail les informations qui peuvent être modifiées dans ce cas, ainsi que les sections concernées.
GET /teamCette liste indique les personnes concernées par cette affaire.
GET /placeholdersLise les valeurs que les codes de vos modèles renferment dans ce cas.

Ce que le hub peut lire et modifier dépend du rôle de votre 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. et des bots de votre hub. Par défaut, le hub lit les informations standard relatives au cas en question. Il ne peut modifier aucune de ces informations avant que l’administrateur ne le permette.

Laisser la clé changer les détails

Dans les Paramètres › Rôles, modifiez le rôle du bot. Sous Cas, cochez la case Actualiser tous les champs de cas spécifiés dans le rôle. Les détails de cette clé peuvent changer : Titre, La description, Date d'ouverture, Statut, Scène ou des champs personnalisés. Pour permettre au bot d’accéder à un champ personnalisé, cochez cette option sous Lire tous les champs de cas spécifiés dans le rôle. Consultez Changer ce qu’un rôle peut faire.

GET /whoami remplit le rôle clé dans ce cas. case_read_fields et case_write_fields indiquent les détails qu’il peut lire et modifier. case_write_fields est omis, car il ne change rien. Un champ personnalisé est indiqué sous la forme de meta_data.<field key>. Ce champ correspond également à case_modules, c’est-à-dire aux sections que le cas présente : les sections de votre hub, moins celles qui sont cachées dans ce cas. Toute demande concernant une section manquante est rejetée.

Lecture d'un cas

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • Par défaut, la clé est lisible. case_id, ref_id (le) ID de l’élémentID de l'étiquette Une étiquette permanente que vous attribuez à un boîtier, telle que rear-end-2026, également appelée ID de référence et utilisée dans les importations.), case_status, date_opened, title, description, case_type Et… case_stage. Un détail du cas n’a pas été mentionné.
  • case_stage est l’ID d’une étapeScène Une étape du traitement d'un dossier, telle que la prise en charge ou l'envoi d'une demande, que le cabinet nomme et décrit et qui apparaît sur la page du dossier. ; GET /v1/<hub id>/stages liste leurs noms.
  • meta_data.content contient les valeurs des champs personnalisés. Un objet correspond à chaque champ, par ordre de clé. Cependant, seuls les champs pour lesquels la clé peut lire des données sont inclus dans le résultat. Par défaut, aucune donnée n’est lue, donc la première page est vide. Dans l’exemple, un administrateur a autorisé l’application à lire le numéro de la politique. meta_data.schema décrit les champs présents dans chaque page.
  • hidden_modules indique les sections qui sont masquées dans ce cas, s’il y en a.

Changer un cas

PUT /case prend n’importe l’un de ces champs en format JSON, et modifie uniquement les valeurs que vous lui transmettez.

ChampCe que cela faitRequisDéfaut
titleLe nom de l’affaire est affiché pour que tout le monde puisse le voir.Non.Toujours le même
descriptionDescription pour le personnel : Envoyer "" pour le effacer.Non.Toujours le même
date_openedLa date à laquelle l’affaire a été jugée, par exemple 2026-03-15Non.Toujours le même
case_status0 Pour fermer l’affaire. Une clé de hub ne peut pas la rouvrir.Non.Toujours le même
case_stageL’ID de la scène est GET /v1/<hub id>/stages. Envoyez "" pour retirer l’élément de sa scène.Non.Toujours le même
meta_dataValeurs de champs personnalisées : une liste contenant un objet par page de champ, dans l’ordre donné. Chaque objet représente les valeurs correspondant au champ en question. Seules la première page peut être modifiée ici. Vous pouvez utiliser "" ou null pour effacer une valeur d’un champ ; un champ obligatoire ne peut pas être effacé.Non.Toujours le même
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

Cela répond à 200 avec l’identifiant du cas en question. Si aucun des champs que vous envoyez n’est un champ clé, alors la valeur de ce champ peut changer. Dans ce cas, la requête est rejetée avec le code 403, et rien ne change. reason indique les champs à modifier ; un champ personnalisé est désigné par meta_data.<field key>. Un champ qui reçoit une valeur déjà présente dans le cas concerné ne nécessite aucun changement. Par conséquent, cette requête n’est ni rejetée ni traitée. Une requête qui ne modifie rien répond à 204.

  • En déplaçant un dossier ouvert vers une étape spécifique, le poste correspondant à cette étape est également ajouté. Si votre hub dispose d’une fonction de assistant virtuel, veuillez consulter l’article « Ajouter automatiquement un poste lorsque le dossier atteint une étape spécifique ». Rien d’autre n’est publié ou envoyé : la clôture d’un dossier ou le changement de ses détails ne concerne personne.
  • Une fois qu’un cas est clos, toute modification effectuée via la clé de gestion est refusée, y compris la réouverture du cas. Vous pouvez réouvrir le cas via l’interface administrative ou en utilisant une autre clé de gestion. Veuillez consulter Clôturer ou réouvrir un cas.
  • L’identifiant de la catégorie et le type de cas ne peuvent pas être modifiés ici ; seule une clé de gestion peut permettre de changer ce type.

L'équipe

GET /team liste tous les personnes concernées par cette affaire, y compris l’assistant virtuel et les membres handicapés. Une affaire ne peut contenir au maximum 20 personnes. C’est ce que a déterminé l’assistant virtuel.

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id représente le rôle de cette personne dans ce cas. case_designation correspond à sa designationDésignation Une étiquette désignant le rôle d'une personne dans une affaire, comme avocat principal, assistant juridique ou tuteur., par exemple primary.
  • host_user_status est égal à 0 pour une personne handicapée dans votre centre de soins.
  • Les noms de chaque personne, leur langue (locale) et leur fuseau horaire (zoneinfo) sont toujours affichés par défaut. En revanche, les adresses e-mail et les numéros de téléphone ne sont jamais affichés.
  • Une clé de hub ne peut ni ajouter ni enlever des personnes : ces appels sont donc gérés par les clés 403 HostAddCaseUserNotEnabledException et HostRemoveCaseUserNotEnabledException. Il est préférable d’utiliser une clé de gestion pour gérer ces appels. Voir Ajouter et enlever des membres du cas avec une clé de gestion .

Valeurs du modèle

GET /placeholders Réponses, en bas. placeholders, La valeur que chaque code de vos modèles fournit dans ce cas, par exemple… clients.primary.full_name, clients.primary.email, case_ref_id Et… company.phone. Un code pour désigner personne dans ce cas est omis. Lorsque la section concernant l’équipe est désactivée ou masquée, tous les codes d’équipes sont omis, mais les autres codes continuent de s’afficher. Voir… Remplissez les champs de formulaires avec les détails concernant l’affaire..

Si un appel est refusé

StatutmessagePourquoi
400SchemaFieldsExceptionLe champ est invalide, c’est-à-dire qu’il est vide. title, Le champ requis a été envoyé vide, ou le stade correspondant n’existe pas dans votre hub. errors On l’appelle ainsi.
403CaseFieldNotWritableExceptionLe champ que vous avez envoyé n’est pas un champ clé. Son nom est reason.
403CaseClosedExceptionL’affaire est close.
403HostModuleDisabledExceptionLes détails de l’affaire ou l’équipe chargée de son traitement sont cachés dans cette affaire. Ou bien, ils sont désactivés pour votre hub.
403CaseModulePermissionDeniedExceptionLe rôle des bots ne permet pas de lire les détails de l’affaire ou des informations concernant l’équipe.
404CaseNotFoundExceptionCet enregistrement n’existe pas. Il appartient à un autre hub, ou il est en train d’être supprimé.

Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.

Articles connexes

Comprendre les possibilités de l'APIDécouvrez ce que permettent chacune une clé de gestion et une clé de hub, pourquoi chaque clé agit comme un assistant virtuel et où trouver la liste technique complète.IntégrationsTrouvez les étuis avec une clé de hubRépertoriez les dossiers de votre plateforme, ouverts ou fermés, recherchez-les par identifiant de balise ou par titre, et retrouvez l'identifiant d'un dossier dans votre propre logiciel.IntégrationsModifier les possibilités d'un rôleModifiez les autorisations d'un rôle, les champs de requête qu'il peut lire ou modifier, et ses limites de téléchargement, y compris les rôles intégrés.Sécurité et compte · 5 minGérer les erreurs et les codes d'état de l'APILisez le corps de l'erreur, ce que signifient les codes 400, 401, 403, 404, 500 et 503, et pourquoi un élément que votre clé ne peut pas voir renvoie la réponse 404.Intégrations