Für: Administratoren
Fälle mit einem Verwaltungsschlüssel erstellen und aktualisieren
Sie können die Fälle Ihres Hubs in Ihrer eigenen Software auflisten, erstellen, lesen, aktualisieren und löschen, einschließlich ihrer Phase und benutzerdefinierten Felder.
In diesem Artikel10 Abschnitte
Bevor Sie beginnen
Diese Seite beschreibt, wie die „Manage Key“-Funktion verwendet werden kann. Die Pfade befinden sich unter https://prd-api-manage.caseactive.com/v1/<hub id>.
Anrufe
| Anruf | Was es tut |
|---|---|
GET /cases | Listet die Fälle Ihres Zentrums auf – am neuesten Punkt anfangen. |
POST /cases | Erstellt einen Fall/ eine Situation |
GET /cases/<case_id> | Liest einen Fall |
PUT /cases/<case_id> | Veränderung des Großbuchstabens |
DELETE /cases/<case_id> | Ein Fall wird endgültig gelöscht. |
GET /stages | Listet die Phasen Ihres Zentrums auf, um deren IDs zu ermitteln. |
GET /schemas?schema_type=cases | Liest die benutzerdefinierten Felder des Falles deines Hubs. |
Auflistung der Fälle
| Parameter | Was es tut | Erforderlich | Standard |
|---|---|---|---|
type | 1 steht für Fälle, die noch offen sind. 0 steht für Fälle, die bereits abgeschlossen sind. Trotz des Namens wird dabei nur nach dem Status der Fälle gefiltert – nicht nach dem Typ des Falls. | Nein. | Beide |
limit | Wie viele Einträge können auf eine Seite gespeichert werden – bis zu 1000 Einträge. | Nein. | 20 |
start_key | Der startKey aus der vorherigen Seite | Nein. | Erste Seite |
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"
}
}
usersweist jede Person im Fall zu ihrer RolleRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten. zu. Dazu gehört auch die virtuelle AssistentinVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen. Ihres Zentrums, die alsrole::botsbezeichnet wird.- Während es noch mehr Fälle gibt, enthält die Seite auch die Adresse von der nächsten Seite – nämlich
nextLink– sowiestartKey. Rufen SienextLinkauf, oder senden SiestartKeyalsstart_key, bis eine Seite ohne diese Informationen zurückkommt. - Die gelöschten Fälle werden hier nicht berücksichtigt. Um einen Fall anhand seiner Tag-IDTag-ID Eine permanente Bezeichnung, die Sie einem Fall geben, z. B. rear-end-2026, die auch als Referenz-ID angezeigt und bei Importen verwendet wird. zu finden, siehe Suchfunktion für Fälle und Benutzer mit Berechtigung zum Verwalten.
Großbuchstaben
POST /cases und PUT /cases/<case_id> betrachten diese Felder als JSON-Daten. Felder, die nicht aufgelistet sind, werden ignoriert.
| Feld | Was es tut | Erforderlich | Standard |
|---|---|---|---|
ref_id | Die Kennziffer des Falles: Buchstaben, Zahlen, Leitwörter und Semikole – alle in Kleinbuchstaben geschrieben. Kein zwei Fall kann dieselbe Kennziffer haben. Diese Kennziffer kann nur bei der Erstellung eines neuen Falls festgelegt werden; sie kann nicht später geändert werden. | Ja, beim Erstellen. | – |
title | Der Name des Falles wird allen mitgeteilt. | Ja, beim Erstellen. | – |
description | Eine Beschreibung für das Personal. Die Kunden sehen es nicht. Bei einer Änderung wird "" dieses Element entfernen. | Nein. | Keine. |
case_type | general, Oder einer der Ihren. FalltypenFallart Eine Kategorie für Fälle, wie z. B. „Allgemein“, die dazu dient, Automatisierungen auf die richtigen Fälle auszurichten., Wortweise so: die Einstellungen › Felder. Es gibt eine Änderung: Der eigene Typ des Falles wird auch weiterhin akzeptiert – nachdem man ihn aus den Einstellungen entfernt hat. | Nein. | general |
case_status | 1 steht für „offen“, 0 steht für „geschlossen“. | Nein. | 1 |
case_stage | Der ID seiner StageBühne Ein Verfahrensschritt, den ein Fall durchläuft, wie z. B. die Aufnahme oder das Versenden der Aufforderung, der von der Kanzlei benannt und beschrieben wird und auf der Fallseite angezeigt wird. stammt von GET /stages. Bei einer Änderung nimmt "" die Position der Stage nicht mehr an. | Nein. | Keine Phase |
date_opened | Der Tag, an dem der Fall verhandelt wurde, beispielsweise 2026-03-15 | Nein. | Heute, in UTC |
hidden_modules | Seiten, die in diesem Fall versteckt werden sollen: case, convos, events, forms, signs, invoices, notes, tasks und team. Senden Sie [], um diese Seiten wieder zu zeigen. | Nein. | Nichts versteckt. |
meta_data | Die benutzerdefinierten Felder – siehe unten. | Nein. | Keine. |
Man kann keine Personen zur Erstellung eines neuen Falls hinzufügen – nur den virtuellen Assistenten kann man in ein neues Fall hinzuwerfen. Hinzufügen der Personen erfolgt mit POST /cases/permissions. Weitere Informationen finden Sie unter Erweiterung und Entfernung von Mitgliedern eines Falls mithilfe der Management-Funktionen.
Fall erstellen
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"}'
Es wird die 201 mit der ID des neuen Falls beantwortet.
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}
Niemand erhält E-Mails. Die Regeln für die Zuweisung von Fällen besagen, dass für jeden Fall sowie für die jeweilige Fallart die entsprechenden Personen festgelegt werden müssen. Daher wird jede weitere Zuweisung dieser Personen als Duplikation abgelehnt. Ein Fall, der in einer bestimmten Phase erstellt wird, erhält keine Nachricht über den Fortschritt des Falls.
Lesen eines Falls
GET /cases/<case_id> entspricht den Eigenschaften von case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct. Wie viele Personen an dieser Gruppe beteiligt sind – einschließlich der virtuellen Assistentin –, kann man mit created_on und updated_on herausfinden. Um zu erfahren, wer an dieser Gruppe beteiligt ist, verwenden Sie GET /cases/permissions?case_id=<case_id>.
einen Fall ändern
PUT /cases/<case_id> nimmt jedes der Fall-Felder entgegen – außer ref_id. Es ändert nur diejenigen Felder, die Sie angeben. Es antwortet mit 204, ohne weitere Informationen zu geben.
- Wenn man ein offenes Case in eine bestimmte Phase verschiebt, wird eine entsprechende Meldung für diese Phase erstellt. Die virtuelle Assistentin erhält dabei eine Meldung – sofern Ihr Hub dafür eine Funktion bietet. Siehe dazu „Automatische Meldung bei Erreichen einer bestimmten Phase des Cases“. Sonst wird nichts gesendet oder übermittelt: Das Schließen eines Cases oder der Wechsel des Kategorienstatus des Cases wird von niemandem bekannt gegeben.
meta_dataersetzt jedes benutzerdefinierte Feld, das im Fall vorhanden ist.- Ein geschlossenes Fall kann dennoch geändert werden. Deshalb kann eine Synchronisierung dieses Falls wieder durchgeführt werden, mit dem Befehl
"case_status": 1.
Phasen und benutzerdefinierte Felder
GET /stages listet die verschiedenen Stufen Ihres Zentrums auf. Diese werden vom Administrator unter die Einstellungen › Phasen eingerichtet. Jede dieser Stufen hat jeweils die Eigenschaften stage_id, name, description und order. Ein Administrator kann die Stufen lesen, aber sie nicht ändern.
GET /schemas?schema_type=cases Die benutzerdefinierten Felder in Ihrem Hub werden berücksichtigt. Diese Felder sind unter… eingestellt. die Einstellungen › Felder, Als Liste der Seiten – jede Seite enthält die Schlüsselwörter, Beschreibungen sowie die Arten der Felder. Senden. meta_data Als Liste mit einem Objekt pro Seite – in derselben Reihenfolge – wobei jedes Objekt die Werte nach dem Schlüssel des jeweiligen Feldes enthält.
{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}
Eine Werte muss dem Typ des jeweiligen Feldes entsprechen – sonst wird die Anfrage abgelehnt. Erforderlich wird nur durch die Formulare im Admin-Panel und im Lobby-Teil überprüft. Deshalb kann ein Feld, das hier erstellt oder aktualisiert wird, leer bleiben.
Löschen eines Falls
DELETE /cases/<case_id> antwortet auf 204. In diesem Fall werden die Listen sofort gelöscht – samt allen Beiträgen, Dateien, Formularen, elektronischen Dokumenten, Rechnungen, Ereignissen, Aufgaben und Notizen. Das kann nicht rückgängig gemacht werden, und niemand wird darüber informiert. Die Tag-ID wird wieder frei, sobald die Löschung abgeschlossen ist.
Wenn ein Anruf abgelehnt wird
| Status | message | Warum |
|---|---|---|
| 400 | SchemaFieldsException | Es fehlt ein Feld oder das Feld ist ungültig. Der Name des Feldes lautet errors. Ein unbekannter Falltyp oder Status befindet sich auf diesem Feld – der Name dieses Elements lautet FieldValidatorFailedException. |
| 400 | CaseReferenceIdExistsException | Es gibt bereits einen weiteren Fall, bei dem eine solche Tag-ID verwendet wird – auch wenn dieser Fall noch gelöscht werden muss. reason behält die case_id-Informationen dieses Falls bei. |
| 404 | ItemNotFoundException | Der Fall existiert nicht. Er gehört zu einem anderen Hub oder wird gerade gelöscht. |
| 403 | ManageBillingInactiveException | Das Administrationspanel Ihres Servers ist nach einem fehlgeschlagenen Zahlungsvorgang gesperrt. |
Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.