PATCH Atualizar Role
Atualiza nome, descrição, permissões e tela inicial de uma role da clínica.
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Exige a permissão update_roles.
As roles da clínica ficam no provedor de login (WorkOS), identificadas pelo slug. O banco do PEP guarda só a tela inicial de cada role. As permissões ficam em cache por até 5 minutos; alterações feitas por estas rotas limpam o cache na hora.
Endpoint
PATCH https://api-dev.imagemais.com.br/api/roles/{slug}
Parâmetros de Rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
slug | string | ✅ | Identificador da role na clínica, como devolvido em slug (ex.: org-recepcao). Apenas letras, números, _ e - |
Corpo da Requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ❌ | Novo nome (se enviado, não pode ficar vazio). O slug não muda |
description | string | ❌ | Nova descrição |
permissionsToAdd | string[] | ❌ | Permissões a acrescentar (só as do catálogo) |
permissionsToRemove | string[] | ❌ | Permissões a retirar |
redirectRoute | string | null | ❌ | Tela inicial (caminho interno começando com /). null apaga; omitido mantém |
Requisição
curl -X 'PATCH' \n 'https://api-dev.imagemais.com.br/api/roles/org-recepcao' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}' \n -H 'Content-Type: application/json' \n -d '{
"name": "Recepção",
"permissionsToAdd": [
"read_patients"
],
"permissionsToRemove": [],
"redirectRoute": "/agenda"
}'
Respostas
200 Sucesso
Sem corpo de resposta.
400 Requisição inválida
Mensagens possíveis: Role inválida (slug), Informe o nome da role, Permissão desconhecida: {nome} e A tela inicial deve ser um caminho do sistema, começando com "/".
{
"message": "Role inválida",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}
404 Role não encontrada
{
"message": "Role não encontrada",
"error": "Not Found",
"statusCode": 404
}
503 Serviço de login indisponível
{
"message": "Não foi possível falar com o serviço de login. Tente novamente em instantes.",
"error": "Service Unavailable",
"statusCode": 503
}
Se uma etapa falhar no meio (por exemplo, as permissões), o nome e as permissões voltam aos valores anteriores.