ClickHelp User Manual

Change power reader profile

ClickHelp User Manual/ClickHelp API/API: Users/Change power reader profile

Updates Power Reader's profile information.

PATCH users/{pr-login}

Authentication

This request requires basic authentication.

Request Parameters

Path params
pr-login string
The login of the Power Reader to update the profile of.
Body params
updatedFieldsstring
A comma-separated list of fields that will be updated. If a field name is not in the list, it will not be updated even if the field value is specified in other request parameters.
emailstring
[optional] Email of the Power Reader.
userRole
string
[optional] Comma-separated list of Power Reader roles assigned to this user.
isEnabled
bool
[optional] Whether the account is enabled or not.

Samples

Request sample
Bash (Unix Shell)
curl --location -g --request PATCH 'https://{portal-url}/api/v1/users/pr1' ^
--data-raw '{
"updatedFields": "email, userRole, isEnabled",
"email": "power-reader@company.co",
"userRole": "Group A",
"isEnabled": true,
}'