PUT
/
roles
/
{id}
curl --request PUT \
  --url https://api.beyondwords.io/v1/roles/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "name": "New role",
  "permissions": {
    "content_view": {
      "enabled": false
    },
    "content_create": {
      "enabled": false
    }
  }
}'
{
  "id": 1,
  "key": "owner",
  "name": "Owner",
  "organization_id": 1,
  "permissions": {
    "content_view": {
      "enabled": true
    },
    "content_create": {
      "enabled": false
    }
  },
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

The numeric ID of your role

Body

application/json
​
name
string
​
permissions
object | null

Response

200 - application/json
successful
​
id
integer
​
key
string
​
name
string
​
organization_id
integer
​
permissions
object | null
​
members_count
integer
​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)