POST/user/createWithList

Create user accounts from a list

Creates user accounts from an array of user objects. The request body is optional; when supplied, include the account details for each user in the array. A 200 response returns a user object.

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

8 body fields

Optional array of user objects; each object can include the following fields.

idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status

2 status codes
200Returns a user object with its account fields.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultReturned when an unexpected error occurs.

Error handling

The request body may be omitted. If supplied, it must be an array of user objects; id and userStatus are integers, while username, firstName, lastName, email, password, and phone are strings.