HilfezentrumIntegrationen

Für: Administratoren

Fallmitglieder mit einem Verwaltungsschlüssel hinzufügen und entfernen

Weisen Sie Personen Fälle mit einer Rolle und Bezeichnung zu, versenden Sie die Einladungs-E-Mail, lesen Sie nach, wer an einem Fall arbeitet, oder entfernen Sie jemanden.

In diesem Artikel8 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt die Anrufe, die dazu dienen, Personen in bestimmte Fälle einzubeziehen oder sie wieder aus diesen Fällen herauszunehmen. Die Wege sind unter https://prd-api-manage.caseactive.com/v1/<hub id> angegeben. Die Person muss bereits in Ihrem Hub sein – siehe „Hinzufügen und Aktualisieren von Benutzern mit einer Verwaltungsschlüssel“.

Anrufe

AnrufWas es tut
GET /cases/permissions?case_id=<case_id>Eine Liste aller Personen, die an einem Fall beteiligt sind.
POST /cases/permissionsJemanden in eine bestimmte Angelegenheit einzusetzen/zu beauftragen
GET /cases/permissions/<case_id>/<user_id>liest den Stand eines Menschen in einem Fall
PUT /cases/permissions/<case_id>/<user_id>Ändert die Bezeichnung einer Person bezüglich eines Falls.
DELETE /cases/permissions/<case_id>/<user_id>Man nimmt jemanden aus einem Fall heraus.

Es gibt keinen Grund, die Rolle einer Person in einem Fall zu ändern oder ihre Einladung erneut zu senden. Man sollte sie einfach entfernen und anschließend wieder hinzufügen – dabei werden die Regeln für ihre Rolle berücksichtigt.

Jemanden hinzufügen

FeldWas es tutErforderlichStandard
case_idDer Fall betrifft Ihren Zuhause.Ja.–
user_idDie Person aus Ihrem Zuhause – jemand, der in Ihrem Zuhause behindert ist – wird abgewiesen.Ja.–
case_role_idIhre rolleRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten. in diesem Fall – genauer gesagt: role::clients, role::staff oder eine der von Ihnen selbst definierten Rollen aus GET /roles. Die role::bots des virtuellen Assistenten wird abgelehnt.Ja.–
case_notifytrue sendet ihnen die Einladung zu ihrem Fall.Ja.–
staff_designationFür role::staff und Ihre benutzerdefinierten Rollen: primary, attorney, paralegal, case_manager, lead_attorney oder lead_paralegalNein.primary
client_designationFür role::clients: primary oder guardianNein.primary

Die BezeichnungBezeichnung Eine Bezeichnung für die Funktion einer Person in einem Fall, wie z. B. leitender Anwalt, Rechtsanwaltsgehilfe oder Vormund. gibt an, wer für eine bestimmte Angelegenheit zuständig ist. So können beispielsweise die Hauptkunden der Angelegenheit benannt werden. role::clients behält client_designation bei sich – alle anderen Rollen behalten hingegen staff_designation bei sich. Die andere Bezeichnung kann weggelassen werden, oder man kann primary verwenden: Eine guardian mit einer beliebigen anderen Rolle, oder eine Bezeichnung für das Personal mit role::clients – diese werden in diesem Feld abgelehnt, und niemand wird hinzugefügt.

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"}'

Es beantwortet die Fragen mit den Werten 201, case_id und user_id.

  • Das Fahrzeug kann 20 Personen aufnehmen. Virtuelle Assistentin/Virtueller AssistentVirtueller 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. Inklusive – also insgesamt 19 weitere.
  • Ein geschlossenes Fallverfahren beansprucht keine Aufmerksamkeit mehr. Öffnen Sie das Fallverfahren erst einmal wieder – siehe dazu „Erstellen und aktualisieren von Fällen mit der Verwaltungsfunktion“.
  • Die Person kann den Fall sofort in ihrem Portal einsehen.

Was geschieht als Nächstes?

  • Wenn case_notify auf true gesetzt wird, erhält die Person eine Einladung von Ihrer Firma. Die Einladung enthält einen Link, mit dem sie sich anmelden kann. Der Link geht an ihre bestätigte E-Mail-Adresse – oder als Text an ihre bestätigte Telefonnummer, falls sie keine E-Mail-Adresse hat. Wenn weder die E-Mail-Adresse noch die Telefonnummer vorhanden sind, wird nichts gesendet. Jemand, der den Zugriff auf Ihre Firma entfernt hat, erhält also nichts.
  • Ihre Regeln bezüglich der Rolle der Kunden fügen ihre Vorlagen dem Fall hinzu. Siehe dazu „Willkommenstellung für Kunden, wenn sie einen Fall betreuen“.
  • Es wird nichts von Seiten der Person, die das Posting durchführt, hinzugefügt. Allerdings werden die Vorlagen für die Willkommensrichtlinien veröffentlicht – und es wird keine Webhook-Aktion ausgelöst.

Änderung einer Bezeichnung

Mit PUT /cases/permissions/<case_id>/<user_id> und {"case_designation": "lead_attorney"} werden 204 Antworten gegeben. Dadurch ändert sich nur die Bezeichnung der Person in diesem Fall – ansonsten bleibt alles wie bisher. Niemand wird entlassen, und es gibt keine Regeln bezüglich der Begrüßung der Personen. Der nächste Template-Post sowie das vorgefüllte Formular verwenden nun die neue Struktur.

Die Bezeichnung muss zu ihrer Rolle passen: primary oder guardian für role::clients. Für alle anderen Rollen gibt es jeweils sechs mögliche Bezeichnungen. Die Bezeichnungen der virtuellen Assistenten können nicht geändert werden.

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"}'

Zu lesen, wer an einem Fall arbeitet

GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 beantwortet alle Fragen bezüglich des Falls sofort – auch den virtuellen Assistenten. Wie 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"
  }
}

Jede Eintragung enthält außerdem eine Kopie der Werte title und description des jeweiligen Falls. Adressen und Telefonnummern werden nicht angegeben – bitte lesen Sie die Informationen über die Person mit dem Wert GET /users/relations/<user_id>. Ein Fall, der nicht in Ihrem „Hub“ enthalten ist, wird in der leeren Liste angezeigt.

Jemanden absetzen

DELETE /cases/permissions/<case_id>/<user_id> Antworten 204, Auch dann, wenn die Person nicht an der Betreuung des Falls beteiligt ist, kann man das gerne wiederholen. Niemand wird darüber informiert – doch derjenige erhält eine Benachrichtigung über die Absage jedes bevorstehenden Ereignisses, egal ob diese Benachrichtigung bereits angekommen ist oder nicht. Die Person verliert den Zugang zum Fall auf ihrem Portal. Die virtuelle Assistentin kann nicht abgeschaltet werden.

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionEs fehlt ein Feld oder das Feld ist ungültig. Die Namen für diese Felder sind errors. Eine Rolle, Person oder Position, die nicht in Ihrem Hub enthalten ist, steht in diesem Feld unter FieldValidatorFailedException. Ebenso steht dort eine Position, die von dieser Rolle nicht übernommen werden kann.
400FieldUserDupsExceptionDie Person befindet sich bereits im Zuständigkeitsbereich des Falles.
400CaseUserLimitOrTransactionExceptionIm Moment haben wir bereits 20 Personen in der Liste – oder anders ausgedrückt: Es gibt einen Moment, in dem die Anzeige nicht angezeigt wird. Überprüfen Sie die Anzahl der Personen, und versuchen Sie es noch einmal.
400TransactionCanceledExceptionEin hektischer Moment hat dazu geführt, dass die Anzeige nicht angezeigt werden konnte. Versuchen Sie es noch einmal.
400CaseUserDisabledExceptionDie Person ist in Ihrem Netzwerk behindert. Bitte aktivieren Sie sie zuerst wieder.
403CaseClosedExceptionDer Fall ist abgeschlossen – es gibt keine weiteren Änderungen bezüglich der Bezeichnung oder des Namens.
403DatabaseTransactionConditionalCheckFailedSie haben versucht, den virtuellen Assistenten zu entfernen.
404ItemNotFoundExceptionWenn man eine Person liest oder deren Bezeichnung ändert: Dann befindet sich diese Person nicht im Fall, oder der Fall befindet sich nicht in Ihrem Hub. Wenn man jemanden hinzufügt oder eine Bezeichnung ändert: Dann wird der Fall gelöscht.

Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.

Verwandte Artikel

Fälle mit einem Verwaltungsschlüssel erstellen und aktualisierenSie 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.IntegrationenBenutzer mit einem Verwaltungsschlüssel hinzufügen und aktualisierenErstellen Sie eine Liste der Mitarbeiter Ihres Hubs, fügen Sie Kunden hinzu, lesen Sie die Details und Fälle einzelner Personen und deaktivieren oder aktivieren Sie deren Zugriff.IntegrationenLesen Sie Rollen mit einem VerwaltungsschlüsselListen Sie die Rollen Ihres Hubs auf und lesen Sie die Berechtigungen einer Rolle, damit Ihre Software die richtigen Personen den Fällen mit der passenden Rolle zuweisen kann.Integrationen