Centre d'aideIntégrations

Pour: Administrateurs

Créer et mettre à jour des dossiers avec une clé de gestion

Répertoriez, créez, consultez, mettez à jour et supprimez les dossiers de votre hub depuis votre propre logiciel, y compris leur étape et leurs champs personnalisés.

Dans cet article10 sections

Avant de commencer

Cette page traite du cas où une clé de gestion peut être utilisée. Les chemins se trouvent sous https://prd-api-manage.caseactive.com/v1/<hub id>.

Appels

AppelCe que cela fait
GET /casesAffiche les cas de votre hub, avec les plus récents en premier.
POST /casesCrée un cas de figure
GET /cases/<case_id>Lise un cas.
PUT /cases/<case_id>Changement de cas
DELETE /cases/<case_id>Supprime un cas définitivement.
GET /stagesAffiche les étapes de votre hub, afin de trouver leurs identifiants.
GET /schemas?schema_type=casesLisez les champs personnalisés concernant l’affaire de votre partenaire.

Liste des cas

ParamètreCe que cela faitRequisDéfaut
type1 pour les affaires ouvertes, 0 pour les affaires closes. Malgré son nom, il filtre en fonction de l’état de l’affaire, et non du type d’affaire.Non.Les deux
limitCombien de cas peuvent être stockés par une page, jusqu’à 1000.Non.20
start_keyLe startKey de la page précédenteNon.Première page
curl "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "host_id": "ca-7e6d5c4b3a2f10",
        "ref_id": "rear-end-2026",
        "title": "Jane Sample auto accident",
        "case_type": "general",
        "case_status": 1,
        "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
        "users": {
          "cu-7e6d5c4b3a2f10": "role::bots",
          "cu-4f1c2a9e8b7d60": "role::clients",
          "cu-9d8c7b6a5f4e30": "role::staff"
        },
        "created_on": "2026-10-02T14:05:09+00:00"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1"
  }
}
  • users Chaque personne concernée par cette affaire est associée à l’une de ces cartes. 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.. Cela inclut votre hub. Assistante virtuelleAssistant 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., comme role::bots.
  • Bien que de nombreux cas restent à traiter, cette page contient également les valeurs nextLink, qui représentent l’adresse complète de la page suivante, ainsi que les valeurs startKey. Appelons nextLink, ou envoyons startKey en tant que start_key, jusqu’à ce qu’une page nous renvoie des données sans ces éléments.
  • Les cas qui sont supprimés ne sont pas inclus dans le résultat. Pour trouver un cas en fonction de son ID de tagID 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., veuillez consulter la section Recherche de cas et d’utilisateurs avec une clé de gestion.

Champs de cas

POST /cases et PUT /cases/<case_id> considèrent ces champs comme des données au format JSON. Les champs qui ne sont pas listés sont ignorés.

ChampCe que cela faitRequisDéfaut
ref_idL’identifiant de l’affaire est composé de lettres, de chiffres, de barres et de crochets. Ces caractères sont toujours en minuscule. Aucune affaire dans votre système ne peut partager le même identifiant. Cet identifiant est défini lors de la création de l’affaire ; il ne peut être modifié par la suite.Oui, c’est possible.—
titleLe nom de l’affaire est affiché pour que tout le monde puisse le voir.Oui, c’est possible.—
descriptionUne description destinée au personnel. Les clients ne la voient pas. Lors d’un changement, "" la supprime.Non.Aucun.
case_typegeneral, ou l’un des types de cas de votre hubType de cas Une catégorie pour les cas particuliers, telle que « général », utilisée pour cibler les automatisations sur les cas appropriés.. Ces types sont indiqués sous Paramètres › Champs. En cas de modification, le type du cas lui-même peut également être utilisé, après avoir été supprimé des paramètres de votre système.Non.general
case_status1 pour les cas ouverts, 0 pour les cas fermés.Non.1
case_stageL’ID de sa scèneScè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. provient de GET /stages. En cas de changement, "" enlève cette scène de son écran.Non.Pas de phase
date_openedLa date à laquelle l’affaire a été jugée, par exemple 2026-03-15Non.Aujourd’hui, dans l’heure universelle.
hidden_modulesLes sections à cacher dans ce cas sont : case, convos, events, forms, signs, invoices, notes, tasks et team. Envoie [] pour les afficher à nouveau.Non.Aucun élément caché.
meta_dataSes champs personnels ; voir ci-dessous.Non.Aucun.

Vous ne pouvez pas ajouter des personnes directement lors de la création d’un nouveau cas. Seule l’assistante virtuelle peut être ajoutée dans un nouveau cas. Ajoutez-les ensuite via POST /cases/permissions. Pour en savoir plus, consultez Comment ajouter et supprimer des membres d’un cas avec la clé “manage”.

Création d'un cas

curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ref_id": "rear-end-2026", "title": "Jane Sample auto accident", "case_type": "general", "date_opened": "2026-10-02"}'

Cela répond à la question 201 en utilisant l’ID du nouveau cas.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}

Personne n’est envoyée de courriel. Les règles relatives aux cas assignés pour chaque cas, ainsi que pour le type de cas en question, stipulent que les personnes concernées doivent être incluses dans l’assignation. Par conséquent, toute nouvelle personne ajoutée ultérieurement sera considérée comme une duplication de l’assignation existante. Un cas créé à un certain stade ne recevra donc aucun message de mise à jour.

Lecture d'un cas

GET /cases/<case_id> Répond aux questions liées à l’affaire. case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct Combien de personnes participent à ce projet ? Y compris l’assistant virtuel. created_on Et… updated_on. Pour savoir qui est impliqué dans cette affaire, utilisez ce moyen. GET /cases/permissions?case_id=<case_id>.

Changer un cas

PUT /cases/<case_id> prend n’importe l’un des champs de cas, sauf ref_id. Il modifie uniquement les valeurs que vous lui transmettez. Il renvoie 204, sans aucune information supplémentaire.

  • 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 pour cela, veuillez consulter Comment ajouter automatiquement un poste lorsque un dossier atteint une étape donnée. Rien d’autre n’est publié ou envoyé : la clôture d’un dossier ou le changement de son type ne concerne personne.
  • meta_data remplace tous les champs personnalisés que le cas possède.
  • Un cas fermé peut toujours être modifié. Ainsi, une synchronisation peut le réouvrir en utilisant "case_status": 1.

Étapes et champs personnalisés

GET /stages liste les étapes de votre hub. Ces étapes sont définies par un administrateur via Paramètres › Étapes. Chaque étape est identifiée par ses valeurs stage_id, name, description et order. Un clé peut lire ces informations, mais ne peut pas les modifier.

GET /schemas?schema_type=cases Les champs personnalisés de votre hub permettent de répondre aux besoins spécifiques de votre site. Ces champs sont configurés en conséquence. Paramètres › Champs, Comme une liste de pages, chaque page contenant les clés, les étiquettes et les types des champs correspondants. Envoyer. meta_data Comme une liste, avec un objet par page, dans le même ordre, chaque objet contenant des valeurs correspondant aux clés de champ.

{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}

Une valeur doit correspondre au type de champ concerné ; sinon, la demande sera rejetée. Champs obligatoires ne est vérifié que par les formulaires de saisie situés dans le Panneau administratif et dans le Lobby. Par conséquent, les champs obligatoires peuvent être laissés vides lorsque vous créez ou mettez à jour des informations ici.

Suppression d'un dossier

DELETE /cases/<case_id> répond à 204. Ce cas efface immédiatement vos listes, et ces dernières sont ensuite détruites définitivement, avec toutes leurs publications, fichiers, formulaires, écritures électroniques, factures, événements, tâches et notes associées. Il est impossible de revenir en arrière, et personne n’est informé de cet effacement. L’identifiant de cette entrée est de nouveau disponible après l’effacement.

Si un appel est refusé

StatutmessagePourquoi
400SchemaFieldsExceptionLe champ est manquant ou n’est pas valide ; errors le désigne. Un type de cas ou une étape inconnue se trouve dans ce champ : FieldValidatorFailedException.
400CaseReferenceIdExistsExceptionUn autre cas possède déjà cette ID de tag, même si celui-ci est encore en cours de suppression. reason contient les informations relatives à ce cas, sous forme de case_id.
404ItemNotFoundExceptionCet enregistrement n’existe pas. Il appartient à un autre hub, ou il est en train d’être supprimé.
403ManageBillingInactiveExceptionLe panneau d’administration de votre hôte est verrouillé après un échec de paiement.

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

Articles connexes

Ajouter et supprimer des membres d'un dossier à l'aide d'une clé de gestionAttribuer 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.IntégrationsRechercher les dossiers et les utilisateurs avec une clé de gestionTrouvez des dossiers, des personnes, des membres de dossiers, des rôles et importez des lignes par texte, avec des filtres, à partir de votre propre logiciel.IntégrationsGé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