Change a custom role. Members get the new permissions at once; a new base role signs them out

patch/api/v1/team/custom-roles/{id}

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/team/custom-roles/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

namestring
base_role'owner' | 'manager' | 'receptionist' | 'practitioner'

Sets the rank: who may grant the role and manage its members

scopesstring[]

Permissions; each must be one you hold. Owner-only permissions need an owner base

restrict_to_staffboolean

Own diary and the clients they serve only

expected_versioninteger

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.