Skip to main content
PATCH
/
roles
/
{slug}
Atualizar Papel
curl --request PATCH \
  --url https://api.example.com/roles/{slug} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}
'
{
  "roleId": "10",
  "organizationId": null,
  "slug": "custom-editor",
  "name": "Updated Editor",
  "description": null,
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "users:write"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:30:00.000Z"
}
Requer permissao roles:write.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
slug
string
required
Slug do papel.

​
Parametros de Query

​
organizationId
string
O UUID da organizacao.

​
Corpo da Requisicao

​
name
string
Nome atualizado.
​
description
string
Descricao atualizada.
​
permissions
string[]
Permissoes atualizadas.

​
Resposta

{
  "roleId": "10",
  "organizationId": null,
  "slug": "custom-editor",
  "name": "Updated Editor",
  "description": null,
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "users:write"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:30:00.000Z"
}

​
Exemplos de Codigo

curl -X PATCH https://api.awsales.io/admin/roles/billing-manager \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Billing Admin",
  "permissions": [
    "billing:manage",
    "invoices:read",
    "invoices:write"
  ]
}'

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
403role.cannot_modify_inheritedNao e possivel modificar um papel herdado
404role.not_foundPapel nao encontrado
404permission.not_foundUma ou mais permissoes nao existem
500internal_server_errorOcorreu um erro inesperado