Skip to main content
POST
/
workspaces
/
{workspace_id}
/
roles
Create Workspace Role
curl --request POST \
  --url https://api.wacht.dev/workspaces/{workspace_id}/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "Admin",
  "description": "<string>",
  "permissions": [
    "workspace.manage",
    "members.invite",
    "members.remove"
  ],
  "is_default": false,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication using the Authorization header

Path Parameters

workspace_id
string
required

(i64 formatted as string)

Body

application/json
name
string
required
permissions
string[]
required
description
string

Response

Role created successfully

id
string

(i64 formatted as string)

name
string
Example:

"Admin"

description
string | null
permissions
string[]
Example:
[
"workspace.manage",
"members.invite",
"members.remove"
]
is_default
boolean
Example:

false

created_at
string<date-time>