Para: Administradores
Agregue y elimine miembros del caso con una clave de administración.
Asigna un rol y una designación a cada persona en los casos, envía el correo electrónico de invitación, verifica quién está asignado a un caso o retira a alguien de él.
En este artículo8 secciones
Antes de empezar
Esta página cubre las llamadas que ponen a las personas en determinados casos y las sacan de ellos. Los caminos están indicados bajo https://prd-api-manage.caseactive.com/v1/<hub id>. La persona debe ya estar en tu centro de control; para más información, ve a Agregar y actualizar usuarios con una clave de administración.
Llamadas
| Llamar | Lo que hace |
|---|---|
GET /cases/permissions?case_id=<case_id> | Lista a todos los involucrados en un caso. |
POST /cases/permissions | Se pone a alguien en una situación difícil. |
GET /cases/permissions/<case_id>/<user_id> | Lee el lugar que ocupa una persona en un caso. |
PUT /cases/permissions/<case_id>/<user_id> | Cambiar la designación de alguien en un caso. |
DELETE /cases/permissions/<case_id>/<user_id> | Se lleva a alguien de un caso. |
No hay necesidad de cambiar el rol de alguien en un caso, ni de enviarle nuevamente la invitación. Basta con eliminarlo del listado y luego agregarlo nuevamente, de acuerdo con las reglas de bienvenida relacionadas con su rol.
Agregar a alguien
| Campo | Lo que hace | Requerido | Por defecto |
|---|---|---|---|
case_id | El caso, procedente de tu centro de datos. | Sí. | — |
user_id | La persona, que pertenece a tu grupo de contacto… Alguien que está desactivado en tu grupo de contacto, no puede ser seleccionado. | Sí. | — |
case_role_id | Ellos/ellas Papel/rolloPapel Un conjunto de permisos que determina qué puede ver y hacer una persona en un caso, como por ejemplo, el personal o los clientes. En cuanto a este caso, en detalle: role::clients, role::staff O una de las funciones personalizadas que usted tiene. GET /roles. La asistente virtual role::bots Se rechaza la solicitud. | Sí. | — |
case_notify | true les envía la invitación para su caso. | Sí. | — |
staff_designation | Para role::staff y tus roles personalizados: primary, attorney, paralegal, case_manager, lead_attorney o lead_paralegal | No. | primary |
client_designation | Para role::clients: primary o guardian | No. | primary |
A DesignaciónDesignación Una denominación para el puesto que desempeña una persona en un caso, como Abogado Principal, Asistente Legal o Tutor. Eso indica quién es la persona encargada de manejar el caso. De esta manera, los plantillas pueden nombrar, por ejemplo, al cliente principal del caso. role::clients se mantiene client_designation, Y todas las demás funciones también se mantienen. staff_designation. Olvídate por el otro; o envía solo lo que es necesario. primary: a guardian Con cualquier otra función, o con alguna designación de personal. role::clients, Se rechaza en su campo, y nadie se añade.
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"}'
Responde a 201 con case_id y user_id.
- Un caso puede albergar a 20 personas. Asistente virtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual. Incluido, así que son 19 más.
- Un caso cerrado no requiere ningún esfuerzo adicional. Primero, abra el caso nuevamente. Consulte la sección “Crear y actualizar casos con una clave de gestión” para obtener más información.
- La persona puede ver el caso en su portal de inmediato.
¿Qué sucede después?
- Cuando
case_notifyse establece entrue, la persona recibe una invitación desde tu empresa, junto con un enlace que le permite acceder al caso. El mensaje se envía a su dirección de correo electrónico confirmada, o como un texto al número de teléfono confirmado, si no tiene correo electrónico. Si ninguno de estos datos está disponible, entonces no se envía nada. Aquellas personas que hayan eliminado el acceso a tu empresa, no recibirán ningún tipo de información. - Las reglas de bienvenida que se aplican a sus roles le agregan sus propios plantillas al caso en cuestión. Para más información, vea “Bienvenida a los clientes cuando se unen a un caso”.
- Además, nadie publica ningún contenido relacionado con el caso en sí. Sin embargo, se publican plantillas de postulaciones para las reglas de bienvenida, y no se envía ningún webhook.
Cambiar una designación
Con PUT /cases/permissions/<case_id>/<user_id> y {"case_designation": "lead_attorney"}, se obtienen 204 respuestas. Esto cambia la designación de la persona en ese caso, pero nada más: ella sigue teniendo todos los mismos derechos y privilegios. Nadie recibe ningún tipo de beneficio adicional, y no existe ninguna regla de bienvenida aplicable. El siguiente post y el formulario prellenado utilizan la nueva configuración.
La designación debe adaptarse a su rol en el caso: primary o guardian para role::clients. Para cualquier otro rol, se pueden utilizar las seis designaciones disponibles. No es posible cambiar la designación del Asistente Virtual.
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"}'
Leer quién está a cargo de un caso
GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 responde a todos los problemas relacionados con el caso de inmediato, incluyendo al Asistente Virtual. Como 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"
}
}
Cada entrada también incluye una copia de los datos title y description relacionados con el caso. Las direcciones de correo electrónico y los números de teléfono no están incluidos. Para obtener más información sobre esa persona, consulte la entrada correspondiente a GET /users/relations/<user_id>. Si un caso no está en la lista de respuestas de tu hub, significa que no existe ninguna información al respecto.
Quitarle el puesto a alguien
La respuesta de DELETE /cases/permissions/<case_id>/<user_id> es la misma que la de 204, incluso cuando la persona no está involucrada en el caso. Por lo tanto, es seguro repetir esa información. A nadie se le informa al respecto, pero a la persona se le envía una notificación de cancelación para cada evento que se avecina relacionado con el caso, ya sea que haya sido respondido o no. La persona pierde el acceso al caso desde su portal de forma inmediata. La asistente virtual no puede ser eliminada.
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 400 | SchemaFieldsException | El campo está faltando o es inválido. errors Se trata de un caso, una persona o una función que no forma parte de tu “hub”. FieldValidatorFailedException En ese campo, y también en otros casos, existe una designación que no se utiliza para desempeñar esa función. |
| 400 | FieldUserDupsException | La persona ya está ocupándose del caso. |
| 400 | CaseUserLimitOrTransactionException | El caso ya cuenta con 20 personas involucradas. Es posible que haya algún momento en el que se cancele la publicación del anuncio. Verifique el número de personas involucradas y luego intente nuevamente. |
| 400 | TransactionCanceledException | Un momento de mucha actividad impidió que se realizara el anuncio. Intente de nuevo. |
| 400 | CaseUserDisabledException | La persona en cuestión está discapacitada en tu centro de control. Primero, habilítala nuevamente. |
| 403 | CaseClosedException | El caso está cerrado. No hay necesidad de realizar ningún tipo de cambio o modificación en la designación del mismo. |
| 403 | DatabaseTransactionConditionalCheckFailed | Intentaste eliminar al Asistente Virtual. |
| 404 | ItemNotFoundException | Leer la información de una persona o cambiar su designación no significa que el caso esté en tu área de control. Al agregar a alguien o cambiar su designación, el caso se elimina. |
Para información sobre el cuerpo de error y los demás códigos, vea Como manejar los errores de la API y los códigos de estado.