POST/user/createWithList

Create users from a list

Creates users from an input array of user objects. Supply an array containing the user details to create; the schema does not mark any object properties as required. Use this operation when you need to submit multiple user records in one request.

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

8 body fields

An array of user objects to create. The schema does not mark any object properties as required.

idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status

2 status codes
200Returns a user object with its identifier, username, name, email, password, phone number, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The request body is an array of user objects, and no object properties are marked as required. If supplied, id and userStatus must be integers, while the other user properties must be strings.