This endpoints creates a new user in your community.Authorization#
Bearer token Required
Found in the platform under community settings > API keys.
Permission: Create UserUser details#
User information needed for the API areIf the email or username is already in use, the request will fail with a conflict error.Password#
A password have to be pre-set for the user, password requirements are as follows:At least 1 special character (e.g !@#$%^& )
Not identical to username
Access levels#
Access level grant's a user their starting role in the community (Including @all role).Configure in Community Settings → Login Management. Click the + next to Login API to add access levels.
When creating an access level, the value you enter becomes the identifier used in this API.
Example set up:
Join server#
Controls whether the new user is immediately added to the server.joinServer: false, user account will be created but user will not be in the server.User have will see the join model
User will not appear in User list
User will not receive any changes for updates done via webhooks or API.
User will have to log in and join the server themselves.
Compliance note (PDPA): This flow helps ensure the user explicitly agrees to Terms & Conditions and provides consent upon joining.
joinServer: true: The user is automatically joined to the server on creation and behaves like a regular user even if they have never logged in.
Email#
After creating a user, you can send them an email notification.
Email templateFound in community setting > Custom Email & Email Template > Create Account (API request)
To use the active template, "emailTemplate": "0"
To use other templates: "emailTemplate": "template ID"
