PATCH
/
api
/
v2
/
platform
/
roles
/
{id}
Update a Role
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/roles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": {
    "name": "vendor"
  }
}'
{
  "data": {
    "id": "8",
    "type": "role",
    "attributes": {
      "name": "administrator",
      "created_at": "2022-11-08T19:35:07.901Z",
      "updated_at": "2022-11-08T19:35:08.133Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json

Response

200
application/vnd.api+json

Record updated

The response is of type object.