Skip to main content
PUT
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to update an existing role.

name
string
required

The name of the role.

Example:

"Prompt Engineer"

permissions
string[]
required

The permissions associated with the role. Available permissions can be found by calling GET /permissions.

Example:
id
integer
required

The internal ID of the role.

Example:

1

description
string | null

The description of the role.

Example:

"Role for users who can fetch and change prompts"

last_updated_comments
string | null

Comments for the most recent edit to the role.

Example:

"Updated to add delete permission"

Response

Successful Response

Information about a role.

name
string
required

The name of the role.

Example:

"Prompt Engineer"

permissions
string[]
required

The permissions associated with the role. Available permissions can be found by calling GET /permissions.

Example:
id
integer
required

The internal ID of the role.

Example:

1

is_system_role
boolean
required

Whether this is a built-in system role that cannot be updated or deleted

Example:

false

last_updated
string<date-time>
required

The timestamp of the most recent update to the role

last_updated_by
string
required

The email of the user who last updated the role

Example:

"user@email.com"

description
string | null

The description of the role.

Example:

"Role for users who can fetch and change prompts"

last_updated_comments
string | null

Comments for the most recent edit to the role.

Example:

"Updated to add delete permission"