TOtoolhouse
Backoffice

Set User Read Only Route

Changed on

Set read-only mode for a user

put/backoffice/users/{user_id}/read-only

Request

  • Base URL
    https://api.toolhouse.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.toolhouse.ai/backoffice/users/{user_id}/read-only
  • Auth
    HTTP bearer

Path parameters

user_idstring required

Request body

read_onlyboolean required

Response

User read-only status updated successfully

idstring required
auth_idstring required
emailstring required
read_onlyboolean
languagestring nullable
credit_multiplierinteger
organisation_limitinteger
created_atstring date-time nullable
is_organisation_memberboolean
can_use_organisationsboolean required

Whether the organisation switcher should be shown to this user.

True either because they may create organisations of their own, or because they have been invited into someone else's — with a limit of 0 and no memberships the personal organisation is all they will ever have, so there is nothing to switch between.

Changes

  • 9dc55a5522bbRevision changes
    • info

      added the optional property to the response with the status

  • 72e064594fc8Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status