Returning.AI
  1. users
Returning.AI
  • Returning.AI
    • Auth
      • register
      • verify email
      • login
      • secure auth
    • Server
      • create new server
      • get my servers
      • update server
      • role list of server
      • channel list of server
    • Role
      • create new role
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • users
        • create new user
          POST
        • manage user
          POST
        • user data
          POST
        • gamification stats
          GET
        • user bulk update
          POST
        • user bulk import
          POST
        • get users by filter
          POST
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Field Histories
        • Create user field history
        • Get user field histories
      • User Fields
        • Create user field
        • Get all user fields for a community
        • Delete user field
        • Update user field
        • Get specific user field
      • Users
        • Get user
    • Application
      • API Keys
        • Create API key
        • Read API keys
        • Delete API key
        • Update API key
      • Users
        • Get user
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • 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
  1. users

create new user

Developing
POST
/apis/v1/users

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
firstname
string 
required
lastname
string 
required
username
string 
required
displayname
string 
required
email
string 
required
password
string 
required
confirmPassword
string 
required
accessLevel
integer 
required
joinServer
boolean 
required
emailPassword
boolean 
required
sendEmail
boolean 
required
emailTemplate
string 
required
Example
{
    "firstname": "Pewo",
    "lastname": "Lu",
    "username": "pewowoy",
    "displayname": "pewowoy",
    "email": "pewowoy@uiemail.com",
    "password": "@Password123",
    "confirmPassword": "@Password123",
    "accessLevel": 1,
    "joinServer": true,
    "emailPassword": true,
    "sendEmail": true,
    "emailTemplate": "0"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://integration.returning.ai/apis/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "Pewo",
    "lastname": "Lu",
    "username": "pewowoy",
    "displayname": "pewowoy",
    "email": "pewowoy@uiemail.com",
    "password": "@Password123",
    "confirmPassword": "@Password123",
    "accessLevel": 1,
    "joinServer": true,
    "emailPassword": true,
    "sendEmail": true,
    "emailTemplate": "0"
}'

Responses

🟢200Success
application/json
Body
status
string 
required
success
message
string 
required
User created successfully
Example
{
    "status": "success",
    "message": "User created successfully"
}
Modified at 2025-06-18 17:58:57
Previous
remove badge from user
Next
manage user