Centro assistenzaIntegrazioni

Per: Amministratori

Aggiungi e rimuovi i membri del caso con una chiave di gestione

Assegna ruoli e qualifiche ai membri del team, invia l'email di invito, verifica chi è stato assegnato al caso oppure rimuovi un membro.

In questo articolo8 sezioni

Prima di iniziare

Questa pagina descrive le operazioni legate all’inserimento e alla rimozione delle persone dai “case” corrispondenti. I percorsi sono indicati sotto https://prd-api-manage.caseactive.com/v1/<hub id>; la persona deve già essere presente nel proprio “hub”. Per ulteriori informazioni, consultare “Aggiungere e aggiornare utenti con una chiave di gestione”.

Chiamate

ChiamataCosa fa
GET /cases/permissions?case_id=<case_id>Elenca tutti coloro che sono coinvolti in un caso.
POST /cases/permissionsMette qualcuno al lavoro per svolgere una determinata mansione.
GET /cases/permissions/<case_id>/<user_id>Leggendo il posto che una persona occupa in un caso…
PUT /cases/permissions/<case_id>/<user_id>Cambiare il nome di una persona relativo a un caso specifico.
DELETE /cases/permissions/<case_id>/<user_id>Prende qualcuno da una situazione difficile/pericolosa.

Non c’è alcun motivo per cambiare il ruolo di una persona in un caso, né è necessario inviarle nuovamente l’invito a partecipare. Basta semplicemente rimuoverla dal gruppo e poi aggiungerla di nuovo, tenendo conto delle regole relative al suo ruolo nel gruppo.

Aggiungere qualcuno

CampoCosa faNecessarioPredefinito
case_idIl caso, proveniente dal tuo hub…Sì.–
user_idLa persona, proveniente dal tuo luogo di residenza… Qualcuno che vive nel tuo luogo di residenza viene rifiutato.Sì.–
case_role_idLe loro RuoloRuolo Un insieme di autorizzazioni che determina cosa una persona può vedere e fare su un caso, ad esempio il personale o i clienti. In merito a questo caso, nel dettaglio: role::clients, role::staff O una delle vostre role personalizzate. GET /roles. L’assistente virtuale role::bots È rifiutato.Sì.–
case_notifytrue invia loro l’invito relativo al loro caso.Sì.–
staff_designationPer role::staff e i tuoi ruoli personalizzati: primary, attorney, paralegal, case_manager, lead_attorney o lead_paralegalNo.primary
client_designationPer role::clients: primary o guardianNo.primary

A DesignazioneDesignazione Un'etichetta che identifica il ruolo di una persona all'interno di un caso, come ad esempio Avvocato responsabile, Assistente legale o Tutore. I template permettono di indicare chi è responsabile di un determinato caso; ad esempio, possono indicare il cliente principale di quel caso. role::clients mantiene client_designation, E ogni altro ruolo continua a esistere… staff_designation. Ometti l’altro, oppure invia-lo. primary: a guardian Con qualsiasi altro ruolo, oppure con una designazione di staff. role::clients, Viene rifiutato sul campo, e nessuno viene aggiunto.

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

Risponde a 201 con case_id e user_id.

  • Il caso può ospitare fino a 20 persone. Assistente virtualAssistente virtuale Un membro automatizzato del team che pubblica messaggi di benvenuto, check-in e post di aggiornamento per l'azienda; i suoi post sono contrassegnati da un badge di Assistente Virtuale. Inclusi, quindi altri 19.
  • Un caso chiuso non richiede alcuna attenzione da parte di nessuno. È necessario riaprirlo prima; per ulteriori informazioni, consultare la sezione “Creazione e aggiornamento dei casi con il tool di gestione”.
  • La persona riesce a visualizzare il caso nel proprio portale, immediatamente.

Cosa succederà dopo?

  • Quando case_notify viene impostato su true, la persona riceve un’invito da parte della vostra azienda, insieme a un link per accedere al caso in questione. Il messaggio viene inviato all’indirizzo email confermato della persona, oppure come messaggio di testo al numero di telefono confermato, se la persona non possiede un indirizzo email. Se nessuno dei due metodi viene utilizzato, niente viene inviato. Chi ha rimosso l’accesso alla vostra azienda non riceverà alcun messaggio.
  • Le regole di benvenuto relative al loro ruolo aggiungono i relativi template al caso corrispondente; per maggiori informazioni, vedere Benvenuti ai clienti quando si uniscono a un caso.
  • Inoltre, le persone che partecipano al caso non pubblicano alcun contenuto riguardo a esso. Tuttavia, vengono pubblicati dei modelli di post per le regole di benvenuto, e non viene inviato alcun webhook.

Modificare una designazione

Con PUT /cases/permissions/<case_id>/<user_id> e {"case_designation": "lead_attorney"} si ottiene 204. Questo modifica soltanto il nome della persona coinvolta in quel caso; per il resto, non cambia nulla: la persona continua ad avere tutti i diritti che aveva prima. Nessuno riceve alcun messaggio di benvenuto, e non viene applicata alcuna regola relativa al benvenuto. Il prossimo post del template e il modulo precompilato utilizzano ora il nuovo formato.

Il nome da assegnare deve essere adeguato al ruolo svolto in quel caso: primary o guardian per role::clients; per tutti gli altri ruoli, invece, si possono utilizzare le sei denominazioni disponibili. Il nome del “Assistente Virtuale” non può essere modificato.

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

Leggere chi si occupa di un caso

GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 risponde a tutti i messaggi riguardanti quel caso, compreso il Virtual Assistant. Come 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"
  }
}

Ogni entry contiene anche una copia dei valori title e description relativi a quel caso. Gli indirizzi email e i numeri di telefono non vengono inclusi: per ulteriori informazioni, si può consultare la persona indicata con GET /users/relations/<user_id>. Un caso che non è presente nella lista dei casi gestiti da voi significa che non esiste alcuna informazione su quel caso.

Togliere qualcuno

DELETE /cases/permissions/<case_id>/<user_id> Risposte 204, Inoltre, anche quando la persona non è presente per gestire il caso, è sicuro ripetere l’operazione. Nessuno viene informato di nulla; tuttavia, alla persona viene inviata una notifica di cancellazione per ogni evento previsto legato al caso in questione, indipendentemente dal fatto che l’evento venga effettivamente organizzato o meno. La persona perde immediatamente il controllo sul caso dal proprio portale. La Virtual Assistant, invece, non può essere rimossa.

Se una chiamata viene rifiutata

StatomessagePerché
400SchemaFieldsExceptionUn campo è mancante o non valido; il nome di quel campo è errors. Una casella, una persona o un ruolo che non fa parte del proprio “hub” è indicato con FieldValidatorFailedException in quel campo. Inoltre, esiste anche una denominazione che non corrisponde a nessun ruolo disponibile.
400FieldUserDupsExceptionLa persona è già al lavoro sul caso.
400CaseUserLimitOrTransactionExceptionIl caso richiede già l’intervento di 20 persone; quindi, è impossibile annullare l’ordine in questo momento. Verifica il numero delle persone coinvolte, poi prova di nuovo.
400TransactionCanceledExceptionUn momento di grande affollamento ha causato l’annullamento dell’annuncio. Provi ancora.
400CaseUserDisabledExceptionLa persona in questione è disabile nel tuo hub. Prima di tutto, riattiva il suo account.
403CaseClosedExceptionIl caso è chiuso; non ci sono più bisogno di alcun aggiornamento o modifica riguardo alla denominazione o alle informazioni relative all’organizzazione.
403DatabaseTransactionConditionalCheckFailedHai cercato di eliminare l’Assistente Virtuale.
404ItemNotFoundExceptionSe si legge il nome di una persona o se viene cambiata la sua designazione… in tal caso, quella persona non è più presente nel caso in questione, oppure il caso non è più nella tua area di controllo. Se invece si aggiunge una nuova persona o si modifica la designazione di qualcuno… allora quel caso viene eliminato.

Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.

Articoli correlati

Crea e aggiorna i casi con una chiave di gestioneElenca, crea, leggi, aggiorna ed elimina i casi del tuo hub dal tuo software, inclusi i relativi campi di fase e personalizzati.IntegrazioniAggiungi e aggiorna gli utenti con una chiave di gestioneVisualizza l'elenco dei membri del tuo hub, aggiungi clienti, visualizza i dettagli e i casi di un utente e disabilita o riabilita il suo accesso.IntegrazioniLeggi i ruoli con un tasto di gestioneElenca i ruoli del tuo hub e leggi le autorizzazioni di ciascun ruolo, in modo che il software possa assegnare ai casi gli utenti con il ruolo corretto.Integrazioni