POST/user

Create a user

Creates a new user account from the supplied user details. The request body is optional, and none of its fields are required by the schema. Only the authenticated user can perform this operation.

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

8 body fields

User details for the account to create; all fields are optional.

emailstringoptional

The user's email address.

firstNamestringoptional

The user's first name.

idintegeroptional

The user's identifier as an int64 integer.

lastNamestringoptional

The user's last name.

passwordstringoptional

The user's password.

phonestringoptional

The user's phone number.

userStatusintegeroptional

User Status

usernamestringoptional

The user's username.

2 status codes
200Returns the created user object.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
defaultUnexpected error

Error handling

The request body has no required properties. If supplied, id must be an int64 integer, userStatus must be an int32 integer, and the other fields must be strings.