Skip to Content
Roles and permissions

Update a role

PATCH
/api/v1/roles/{id}

Renames a role, replaces its permissions, or both. You can't edit a built-in role. To grant ADMINISTRATOR, you must hold it yourself.

Permission required: MANAGE_WORKSPACE_ROLES on the workspace.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The workspace role ID.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key?string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Lengthlength <= 255

Request Body

Body

application/json
  1. body

Update a workspace role

name?string

New role name

Length1 <= length
permissions?array<>

Replacement set of permission keys. Omit to leave permissions unchanged.

Response Body

Workspace role

application/json
  1. response

Workspace role

id*string

Role ID. Pass it as roleId when you add or update a member; role names can change.

name*string

Role name. Organization administrators can rename it.

isDefault*boolean

True for a built-in role, which you can't edit or delete

permissions*array<>

Permission keys granted by this role

memberCount*number

Number of workspace members currently assigned this role

createdAt*string

When the workspace role was created.

Formatdate-time
updatedAt*string

When the workspace role was last updated.

Formatdate-time
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/roles/cm4k2x9p10026abcd1234efgh' \  -H 'Content-Type: application/json' \  -d '{  "name": "Rekryterare",  "permissions": [    "READ_DOCUMENT"  ]}'
Example Response
{  "id": "cm4k2x9p10026abcd1234efgh",  "name": "Rekryterare",  "isDefault": false,  "permissions": [    "READ_DOCUMENT"  ],  "memberCount": 4,  "createdAt": "2026-09-28T09:12:00.000Z",  "updatedAt": "2026-09-28T09:15:00.000Z"}

Was this page helpful?