Skip to main content
PATCH
/
organizations
/
{organizationId}
/
roles
/
{slug}
Atualizar Role
curl --request PATCH \
  --url https://api.example.com/organizations/{organizationId}/roles/{slug} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}
'
{
  "roleId": "role_org_custom_editor",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "slug": "custom-editor",
  "name": "Updated Editor",
  "description": "Updated custom role description",
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "users:write", "roles:read"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:30:00.000Z"
}
Atualiza um role pelo slug. 
curl -X PATCH https://api.awsales.io/studio/organizations/ORG_ID/roles/custom-editor \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Editor",
    "permissions": ["content:read", "content:write", "content:publish"]
  }'
Roles herdados do ambiente nao podem ser modificados. Tentar atualizar um role herdado retornara 403 role.cannot_modify_inherited.
Requer permissao roles:write.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.
​
slug
string
required
O slug do role.

​
Corpo da Requisicao

​
name
string
Nome de exibicao atualizado.
​
description
string
Descricao atualizada.
​
permissions
string[]
Array atualizado de slugs de permissao.

​
Resposta

​
roleId
string
O ID do role.
​
organizationId
string
O UUID da organizacao. Present only for organization roles.
​
slug
string
Identificador unico do role.
​
name
string
Nome de exibicao.
​
description
string
Descricao do role.
​
type
string
Tipo do role (ENVIRONMENT_ROLE ou ORGANIZATION_ROLE).
​
permissions
string[]
Array de slugs de permissao.
​
inherited
boolean
Se o role e herdado do ambiente.
​
createdAt
string
Timestamp de criacao ISO 8601.
​
updatedAt
string
Timestamp da ultima atualizacao ISO 8601.
{
  "roleId": "role_org_custom_editor",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "slug": "custom-editor",
  "name": "Updated Editor",
  "description": "Updated custom role description",
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "users:write", "roles:read"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:30:00.000Z"
}

​
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 role herdado
404organization.not_foundOrganizacao nao encontrada
404role.not_foundRole nao encontrado
404permission.not_foundUma ou mais permissoes nao existem
500internal_server_errorOcorreu um erro inesperado