Table of Contents
Through the Dashboard Edit Individual User Edit Multiple Users Using API v3 Edit a User Authentication Fields Example Request 1. API Endpoint 2. Request BodyEditing users is fairly simple and can be done through the Dashboard or via APIv3:
Through the Dashboard
Edit Individual User
- Log Into Helpjuice
- Click on the Users button
- Hover over the user you would like to edit
- Click on the pencil Edit button
- Update all necessary information and click on the Edit User button

Edit Multiple Users
- Log Into Helpjuice
- Click on the Users button

Using API v3
To edit a user using the Helpjuice API, you can follow the instructions below:
Edit a User
- HTTP Method:
PUT
- URL:
https://<your-subdomain>.helpjuice.com/api/v3/users/:id
Replace <your-subdomain>
with your subdomain and :id
with the ID of the user you want to update. You can find their ID in the Users file – learn how you can export it in the How To Export Your Helpjuice Data Help Article.
Authentication
The API key is required for using API v3 — Learn how to obtain it here.
The API key grants Super Administrator privileges to anyone with access to it. Please be cautious about who you share it with.
Fields
Field | Type | Description |
---|---|---|
first_name | String | First name of the user |
last_name | String | Last name of the user |
String | Unique email of the user | |
role_id | String | Role of the user (e.g., superadmin, admin, collaborator, draftwriter, viewer) |
group_ids | Array | IDs of the groups where the user should be added |
Example Request
1. API Endpoint
PUT https://<your-account>.helpjuice.com/api/v3/users/123
2. Request Body
In the body of the request, you should include the user data you want to update in JSON format. Here is an example of the body:
{
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "john@doe.com",
"role_id": "admin",
"group_ids": [1, 2]
}
}