OPopenintake
Admin

Update Role

Changed on

Replace a custom role's name, description and permissions.

The change reaches everyone on the role at their next request. Nobody can edit a role that holds more than they do, or make it hold more.

put/admin/roles/{role_id}

Request

  • Base URL
    https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.openintake.ai/admin/roles/{role_id}
  • Auth
    none declared

Path parameters

role_idstring uuid required

Request body

namestring required
descriptionstring nullable
permissionsPermission[]

Response

Successful Response

idstring required

'admin' or 'staff' for a built-in role, otherwise the custom role's id

namestring required
descriptionstring nullable
built_inboolean required
permissionsPermission[] required

Everything the role holds

user_countinteger required

Changes

  • ceeae5525826Revision changes
    • breaking

      removed the enum value calls.feedback of the request property /

    • info

      removed the calls.feedback enum value from the / response property for the response status

  • 6cf2cbf46fe1Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property