Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Patch Update a Base Role

Used to add permissions, and update the key/name of the base role. Patch Update adds the supplied permissions to existing ones in the supplied base role.

patch/base-roles/{id}/

Path parameters

idstring required

id of the base role to be updated

Request body

namestring

new name for the base role

descriptionstring

new description for the base role

keystring

new key for the base role

permission_idsstring[]

permission_ids to be added

permission_keysstring[]

permission_keys to be added

role_template_idstring

id of the role template, permissions of which need to be added to the base role

role_template_keystring

key of the role template, permissions of which need to be added to the role

is_activeboolean

Active status for the base role

Response

200

idstring
urlstring
client_idstring
namestring
descriptionstring
keystring
created_atstring
is_activeboolean

Example response

{
  "id": "5678b4cf-7ec5-46fb-b54b-449c689325d0",
  "url": "https://cf-blast-dig.livelikecdn.com/api/v1/base-roles/5678b4cf-7ec5-46fb-b54b-449c689325d0/",
  "client_id": "ROA1TtZi9rGdYeGVRdHCs5oBc3J3o4fOgNlh1FPN",
  "name": "Test Base Role",
  "description": "Example Description",
  "key": "test-base-role",
  "permissions": [
    {
      "id": "8ef670c4-a740-4758-ac1d-70121c5550d5",
      "url": "https://cf-blast-dig.livelikecdn.com/api/v1/permissions/8ef670c4-a740-4758-ac1d-70121c5550d5/",
      "name": "Publish Alert",
      "key": "publish-alert",
      "created_at": "2023-12-29T00:15:49.123000Z"
    }
  ],
  "created_at": "2025-05-21T11:03:06.841084Z",
  "is_active": true
}