Central de ajudaIntegrações

Para: Administradores

Adicione e remova membros do caso com uma chave de gerenciamento.

Atribua funções e designações às pessoas responsáveis pelos casos, envie o e-mail de convite, verifique quem está alocado a um caso ou remova alguém da equipe.

Neste artigo8 seções

Antes de começar

Esta página aborda as chamadas que colocam pessoas em determinados casos e as retiram desses casos. Os caminhos estão indicados em https://prd-api-manage.caseactive.com/v1/<hub id>. A pessoa deve já estar no seu hub; consulte Adicionar e atualizar usuários com uma chave de gerenciamento.

Chamadas

ChamarO que faz
GET /cases/permissions?case_id=<case_id>Lista todas as pessoas envolvidas num determinado caso.
POST /cases/permissionsColoca alguém no caso.
GET /cases/permissions/<case_id>/<user_id>Leia a posição de uma pessoa em um caso específico.
PUT /cases/permissions/<case_id>/<user_id>Modificar o nome de alguém em um caso
DELETE /cases/permissions/<case_id>/<user_id>Tira alguém de um caso.

Não há necessidade de alterar o papel de alguém em um caso, nem de enviar novamente a sua convocação. Basta removê-lo e adicioná-lo novamente, conforme as regras de boas-vindas aplicáveis ao seu papel.

Adicionando alguém

CampoO que fazObrigatórioPadrão
case_idO caso, vindo do seu hub.Sim—
user_idA pessoa, que vem da sua cidade natal… Alguém que está com deficiência na sua cidade natal foi recusado.Sim—
case_role_idO seu “rolamentoFunção Um conjunto de permissões que define o que alguém pode ver e fazer em um caso, como funcionários ou clientes.” no caso, em detalhes: role::clients, role::staff ou um dos seus próprios roles personalizados, de GET /roles. O role::bots do Assistente Virtual é recusado.Sim—
case_notifytrue envia-lhes a convocatória para o seu caso.Sim—
staff_designationPara role::staff e as suas funções personalizadas: primary, attorney, paralegal, case_manager, lead_attorney ou lead_paralegalNãoprimary
client_designationPara role::clients: primary ou guardianNãoprimary

A designaçãoDesignação Uma designação que designa a função de alguém em um caso, como Advogado Principal, Assistente Jurídico ou Tutor. indica quem é responsável pelo caso em questão. Assim, os modelos podem, por exemplo, nomear o cliente principal do caso. role::clients mantém client_designation, enquanto todas as outras funções mantêm staff_designation. Deixe de lado a outra designação, ou envie primary: um guardian com qualquer outra função, ou uma designação de funcionário com role::clients. Essas designações serão rejeitadas no campo correspondente, e ninguém será adicionado à lista.

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

Ele responde a 201 com case_id e user_id.

  • O caso acomoda 20 pessoas. Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual. Incluídos, então são outros 19.
  • Um caso fechado não requer nenhuma intervenção. Primeiro, abra o caso novamente. Veja Criar e atualizar casos com um gerenciador de casos.
  • A pessoa consegue visualizar o caso em seu portal, imediatamente.

O que acontece a seguir?

  • Quando case_notify é definido como true, a pessoa recebe um convite para participar do caso realizado pela sua empresa. O convite inclui um link que permite que ela entre no sistema. O e-mail é enviado para o endereço de e-mail confirmado da pessoa, ou, se ela não tiver e-mail, o mensagem é enviada para o número de telefone confirmado dela. Se nenhum desses dados estiver disponível, nada será enviado. Aqueles que removeram o acesso à sua empresa não receberão nenhum convite.
  • As regras de boas-vindas relacionadas ao seu papel incluem os seus modelos de comportamento no caso em questão. Veja Boas-vindas aos clientes quando eles se juntam a um caso.
  • Além disso, ninguém posta nada relacionado ao caso em si. No entanto, os modelos de postagem para regras de boas-vindas são enviados, e nenhum webhook é enviado.

Alterar uma designação

Com PUT /cases/permissions/<case_id>/<user_id> e {"case_designation": "lead_attorney"} respondendo a 204. Isso altera apenas o nome da pessoa nesse caso. As pessoas continuam com tudo o que tinham antes; ninguém recebe nada, e não há regras de welcome para aplicar. O próximo post do modelo e o formulário preenchido utilizam o novo formato.

A designação deve se adequar ao papel que cada um desempenha no caso em questão: primary ou guardian para role::clients. As outras seis designações podem ser usadas para qualquer outro papel. As designações do Assistente Virtual não podem ser alteradas.

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

Lendo quem está investigando o caso

GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 responde a todas as perguntas relacionadas ao caso, incluindo o Assistente Virtual. Isso é feito por 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 também contém uma cópia dos dados title e description do caso em questão. Endereços de e-mail e números de telefone não são incluídos: consulte a pessoa relacionada com o GET /users/relations/<user_id>. Um caso que não está listado no seu hub significa que ele não foi respondido.

Tirar alguém de

DELETE /cases/permissions/<case_id>/<user_id> Respostas 204, Além disso, quando a pessoa não está envolvida no caso, é seguro repetir isso. Ninguém é informado sobre isso, embora a pessoa receba um aviso de cancelamento para cada evento relacionado ao caso, independentemente de o evento ter sido atendido ou não. A pessoa perde o acesso ao caso em seu portal imediatamente. O Assistente Virtual não pode ser removido.

Se uma chamada for recusada

StatusmessagePor que
400SchemaFieldsExceptionO campo está ausente ou inválido; o nome desse campo é errors. Uma caso, pessoa ou função que não faz parte do seu hub está relacionada ao campo FieldValidatorFailedException. Além disso, existe também uma designação que não corresponde a nenhuma função disponível para essa pessoa/função.
400FieldUserDupsExceptionA pessoa já está trabalhando no caso.
400CaseUserLimitOrTransactionExceptionO caso já tem 20 pessoas envolvidas. Ou seja, é um momento difícil para cancelar o anúncio. Verifique o número de pessoas envolvidas e tente novamente.
400TransactionCanceledExceptionUm momento de grande agitação cancelou a publicação do anúncio. Tente novamente.
400CaseUserDisabledExceptionA pessoa está com deficiência no seu hub. Por favor, reativá-la primeiro.
403CaseClosedExceptionO caso está encerrado. Não há necessidade de fazer nenhuma alteração ou mudança no nome ou na designação do produto.
403DatabaseTransactionConditionalCheckFailedVocê tentou remover o Assistente Virtual.
404ItemNotFoundExceptionLer as informações de uma pessoa ou alterar sua designação: essa pessoa não está relacionada ao caso em questão, ou o caso não está no seu hub. Adicionar alguém ou alterar a designação de alguém: o caso será excluído.

Para informações sobre o corpo do erro e os demais códigos de erro, consulte Como lidar com erros da API e códigos de status.

Artigos relacionados

Crie e atualize casos com uma chave de gerenciamento.Liste, crie, leia, atualize e exclua os casos do seu hub a partir do seu próprio software, incluindo o estágio e os campos personalizados.IntegraçõesAdicione e atualize usuários com uma chave de gerenciamento.Liste as pessoas da sua central, adicione clientes, leia os detalhes e casos de alguém e desative ou reative o acesso dessa pessoa.IntegraçõesLeia as funções com uma chave de gerenciamento.Liste as funções do seu hub e leia as permissões de uma função, para que seu software possa atribuir os casos às pessoas com a função correta.Integrações