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:
Parameter | Type | Description |
---|---|---|
users | array | An array of user objects with their details. |
sendEmail (Optional) | boolean | This sends an invite email to the users, by default it is true. |
redirect_url (Optional) | string | The URL to redirect after creation. |
message (Optional) | string | For 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
Field | Type | Required | Description |
---|---|---|---|
users | array | ā | |
sendEmail | boolean | ā | |
redirect_url | string | ā | |
message | string | ā |
Responses
ā 201 - Created with Errors
ā ļø 401 - Unauthorized
ā ļø 404 - Not Found
ā 500 - Internal Server Error
Tags
User
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json