Skip to main content
PATCH
Update many roles

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json

Every field is optional. Only the fields you send are changed.

name
string

Role name. At least one character.

Minimum string length: 1
description
string | null

What the role is for.

permissions
string[]

Legacy flat permission strings. Defaults to empty.

Legacy permission string.

permissionsV2
object[]

Fine-grained permission statements. This is the form the app writes today.

isApiKey
boolean
default:false

true for the synthetic role behind an API key. Leave it alone on roles you create.

Response

The updated roles.

values
object[]
required