Skip to main content
PUT
/
api
/
roles
/
{id}
Error
A valid request URL is required to generate request examples
{
  "role": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "is_system_role": true,
    "created_by_user_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

​
id
integer
required

Body

application/json

Partial update. Omitted fields preserve the current value.

  • description is a nullable string: omitting it preserves the existing description; sending an empty string clears it.
  • dac defaults to the existing value when omitted, preventing accidental scope escalation.
​
name
string

If supplied (and different from current), must match the role-name regex.

Maximum string length: 255
​
description
string | null
​
dac
enum<string>

Data access scope. Determines which rows members of the role can see.

  • own-data - Only rows the member personally owns.
  • team-data - Own rows plus rows owned by any team they belong to.
  • all-data - No row filtering.
Available options:
own-data,
team-data,
all-data

Response

Role updated

​
role
object