1. Users
Returning.AI copy
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Field Histories
          • Get all user field histories in a community
          • Get user field histories for a specific field
          • Get user field histories for a specific user
          • Get user field histories of specific user field and user
          • Create user field history for specific user
        • User Fields
          • Get All User Fields
          • Get Specific User Field
          • Create Custom User Field
          • Update Custom User Field
          • Delete Custom User Field
      • Integration API
        • Analysis API
          • Create Analysis
          • Get Analysis
          • Update Analysis
          • Delete Analysis
          • List Analyses
          • Append Drawings
        • Users
          • Get Users with Filters
            POST
          • Create New User
            POST
          • Get User Data
            POST
          • Manage User Account
            POST
          • Get User Gamification Stats
            POST
          • Bulk Import
            POST
          • Bulk Update
            POST
          • Premium Currency Bulk Update
            POST
          • Get All Bulk Update
            GET
          • Check Bulk Update Status
            GET
          • Check Bulk Update Details
            GET
          • Get all mini game logs by user email
            POST
          • Get user's current Mini Games and Streak stats
            POST
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
          • Upload Image
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
        • Gamifications
          • Get User Gamification History
          • Get User Gamification Logs
        • Redemption Transactions
          • Update redemption transaction status
          • Get all redemption transactions by user email
          • Get All Redemption Statuses
          • Get Redemption Status by ID
          • Create Redemption Status
          • Get all redemption transactions by Community
        • Streak Logs
          • Get Streak Logs
    • Channels
      • Iframe
    • Events
      • Outgoing webhooks
        • Encryption
        • User Joins Server
        • User Visits server
        • New Message Posted Anywhere
        • New Message Posted To channel
        • Purchased Store Item
      • Incoming webhooks
        • API Keys & Encryption
        • Send message into channels
        • Update Custom User Fields
        • Update In-game currency
    • Widgets
      • Authenticated Widgets
      • Public widgets
    • Features
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ValidationError
      • NotFoundError
      • InternalServerError
      • NotImplementedError
      • CreateUserFieldHistoryResponse
      • CreateUserFieldHistorySuccessResponse
      • UserFieldHistoryItem
      • GetUserFieldHistoriesResponse
      • UserFieldHistoriesValidationError
      • UserFieldHistoriesMetaWithValidation
      • UserFieldHistoriesMetaWithPagination
      • GetUserFieldHistoriesSuccessResponse
      • CreateUserFieldResponse
      • CreateUserFieldSuccessResponse
      • DeleteUserFieldResponse
      • DeleteUserFieldSuccessResponse
      • UserFieldCreator
      • GetUserFieldResponse
      • GetUserFieldSuccessResponse
      • ValidationErrorItem
      • GetUserFieldsMetaResponse
      • CreatorInfo
      • UserFieldResponse
      • GetUserFieldsSuccessResponse
      • UpdateUserFieldResponse
      • UpdateUserFieldPayload
      • UpdateUserFieldSuccessResponse
      • MetaResponse
      • GetUserResponse
      • GetUserSuccessResponse
    • Outgoing webhooks
      • Purchased store item
      • New message posted to channel
      • User visits server
      • User join server
      • ErrorResponse
    • Analysis
      • UpdateAnalysisRequest
      • AppendDrawingsRequest
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
  1. Users

Create New User

POST
/apis/v1/users
This endpoints creates a new user in your community.

Authorization#

Bearer token Required
Found in the platform under community settings > API keys.
Permission: Create User

User details#

User information needed for the API are
Email (Unique)
First name
Last name
Username (Unique)
Display name
If 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:
8 - 20 characters
At least 1 number
At least 1 special character (e.g !@#$%^& )
No spaces
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.
image.png
When creating an access level, the value you enter becomes the identifier used in this API.
Example set up:
image.png

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 when visiting the first time.
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 template
Found 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"
image.png

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Error
🟠400Error
🟠400Bad Request
🟠401Insufficient permission
🟠401Invalid token
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/apis/v1/users' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "John",
    "lastname": "Doe",
    "username": "24_magohew",
    "displayname": "John Doe",
    "email": "24_magohew@mailfrs.com",
    "password": "@Password123",
    "confirmPassword": "@Password123",
    "accessLevel": 1,
    "joinServer": true,
    "emailPassword": true,
    "sendEmail": true,
    "emailTemplate": "0",
    "country": "Thailand",
    "phoneNumber": "080374893013",
    "referral": "referral_id",
    "customFields": [
        {
            "fieldIdorName": "revenue",
            "value": 123
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "status": "success",
    "message": "User created successfully"
}
Modified at 2026-03-24 09:39:51
Previous
Get Users with Filters
Next
Get User Data
Built with