Update a role

POSThttp://localhost:4000/api/permissionsRoles/update

Changes the name or description of a role. Always send name.

Your API key needs the permissionsRoles.MANAGE_ORG_ROLES permission.

Body Params

idintegerrequired

ID of the role.

namestringrequired

Role name.

descriptionstring

What the role is for.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/permissionsRoles/update \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"id":5,"name":"Viewer","description":"Can read everything."}'

Response

Click Try It! to send a request and see the response here, or choose an example: