admin-users

Change User Role

Change a user's role, auto-transferring owned records if necessary.

When the new role belongs to different record type groups than the current role, records owned by the user in the old groups are automatically transferred to the user's manager (parent role in hierarchy).

If the user owns records and no manager exists in the hierarchy, the request is rejected with a 409 status and ROLE_CHANGE_BLOCKED error code.

post/api/v1/admin/users/{user_id}/change-role

Request

  • Base URL
    https://api.ninjavan.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ninjavan.co/api/v1/admin/users/{user_id}/change-role
  • Auth
    none declared

Path parameters

user_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

new_role_idinteger required

The ID of the role to assign to the user

Response

Successful Response

detailstring required
transferred_recordsinteger

Changes

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