POST/user/createWithList

Create multiple user accounts

Creates multiple user accounts from an array of user objects. Include any applicable user properties in each array item; the schema does not mark individual properties as required. The 200 response contains a user object.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

An optional array of user objects to create.

idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status

2 status codes
200Returns a user object containing its identifier, username, name, email, password, phone, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultReturned when an unexpected error occurs.

Error handling

The request body is optional; when supplied, it must be an array of user objects. Each object's id and userStatus values must be integers, while username, firstName, lastName, email, password, and phone must be strings.