Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01421779.8 KB
Role

Update a role given the role id.

put/role/{id}

Path parameters

idinteger required

Role ID

Request body

namestring
descriptionstring
{"stackTrail":"paths:/role/{id}:put:requestBody:content:application/json:schema:properties:min_available","oasType":"schema","type":"unknown","example":1}
{"stackTrail":"paths:/role/{id}:put:requestBody:content:application/json:schema:properties:max_available","oasType":"schema","type":"unknown","example":3}
finalisedboolean

Whether this role has been finalised (e.g. max available number)

Example request

{
  "name": "Chief Whip",
  "description": "Put a bit of stick about!",
  "min_available": 1,
  "max_available": 3,
  "finalised": true
}

Response

OK

messagestring

Example response

{
  "message": "Successfully update organisation."
}