POST/user/createWithList

Create users from a list

Creates users from an array of user objects. Provide the user properties you want to set in each object; no item fields are marked as required.

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

8 body fields

An array of user objects to create; each object can include the listed user properties.

emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional

2 status codes
200Returns a user object containing its email, name, identifier, password, phone, status, and username.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
defaultReturned when an unexpected error occurs.

Error handling

The request body is optional and accepts an array of user objects. No item properties are marked as required, so each object can omit any of username, email, firstName, lastName, password, phone, id, or userStatus.