Sign in
admin-user-roles

Update User Role

Update a user role and optionally its groups/permissions.

put/api/v1/admin/user-roles/{role_id}

Path parameters

role_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring nullable
descriptionstring nullable
all_access_levelstring nullable
is_all_accessboolean nullable
can_manage_activitiesboolean nullable
can_manage_tasksboolean nullable
can_create_dashboardsboolean nullable
is_activeboolean nullable
record_type_group_idsinteger[] nullable

Replace group assignments if provided

Response

Successful Response

idinteger required
tenant_idinteger required
namestring required
descriptionstring nullable
all_access_levelstring
can_manage_activitiesboolean
can_manage_tasksboolean
can_create_dashboardsboolean
is_activeboolean required
created_atstring date-time nullable
updated_atstring date-time nullable
user_countinteger

Changes

Changed in 1 of the 5 revisions of this API.4

  • db5ab8f1fcef4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added