How To Guides
- How to sign in to the superflow toolbar
- How to add a comment on an element
- How to add a comment to a text
- How to add an arrow comment
- How to draw a box comment on the page
- How to enter exit comment mode
- How to start a huddle
- How to open the comments sidebar
- How to filter comments in the sidebar
- How to exit the review mode
- How to switch to mobile view
- How to record voice notes
- How to attach files
- How to add a priority
- How to change status
- How to search comments
- How to delete comments
- How to enter the review mode
- How to view the project dashboard
- How to use the AI co pilot
- How can I export comments
- How to use guest mode
- How to add private comments
- How to expand the superflow toolbar
- How to record screen and add it to comments
- How to leave video comments
Create User
This endpoint creates a new user
curl --location --request POST 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
"current_token": ""
}'
{
"success": 1,
"user_group": {
"team_id": 3,
"token": "<user_group_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1"
}
}
Body
This is the current user group token you have for the user group that you want to rotate.
Response
Indicates whether the call was successful. 1 if successful, 0 if not.
The contents of the user group
This is the internal ID for this user group. You don’t need to record this information, since you will not need to use it.
This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be used to identify which user group is viewing the dashboard. You should save this on your end to use when rendering an embedded dashboard.
This is the name of the user group provided in the request body.
This is the user_group_id provided in the request body.
This is the environment tag of the user group. Possible values are ‘Customer’ and ‘Testing’. User group id’s must be unique to each environment, so you can not create multiple user groups with with same id. If you have a production customer and a test user group with the same id, you will be required to label one as ‘Customer’ and another as ‘Testing’
curl --location --request POST 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
"current_token": ""
}'
{
"success": 1,
"user_group": {
"team_id": 3,
"token": "<user_group_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1"
}
}
Was this page helpful?
curl --location --request POST 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
"current_token": ""
}'
{
"success": 1,
"user_group": {
"team_id": 3,
"token": "<user_group_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1"
}
}