Skip to main content
POST
/
user
/
bulk
Create Bulk User
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/user/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "users": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "nickName": "<string>",
      "userType": "<string>",
      "email": "jsmith@example.com",
      "ipi": "<string>",
      "role": "<string>",
      "phone": "<string>",
      "country": "<string>"
    }
  ],
  "sendEmail": true,
  "redirect_url": "<string>",
  "message": "<string>"
}'
{
  "message": "Done.",
  "createdUsers": [
    "John Doe",
    "Jericho Doe"
  ],
  "processedCount": 3,
  "errors": [
    "User Jane Doe already associated with workspace!",
    "Invalid email format for Jacob Doe",
    "Invalid email format for Jake Doe"
  ]
}
/user/bulk Description:
The /user/bulk endpoint allows the creation of multiple users simultaneously by providing an array of user objects, each containing user details.
Method:
POST
Request Payload:
ParameterTypeDescription
usersarrayAn array of user objects with their details.
sendEmail (Optional)booleanThis sends an invite email to the users, by default it is true.
redirect_url (Optional)stringThe URL to redirect after creation.
message (Optional)stringFor passing the invite email custom message.
See sample response for request payload in the body below

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Request Body

Request Schema

FieldTypeRequiredDescription
usersarrayāœ…
sendEmailbooleanāŒ
redirect_urlstringāŒ
messagestringāŒ

Responses

āœ… 201 - Created with Errors

āš ļø 401 - Unauthorized

āš ļø 404 - Not Found

āŒ 500 - Internal Server Error

Tags

User

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
users
object[]
required
sendEmail
boolean
default:true
redirect_url
string
message
string

Response

Created with Errors

message
string
createdUsers
string[]
processedCount
integer
errors
string[]
⌘I