User / Create

post deprecated

https://{tenantUrl}/public-api/resources/users/v1.0

Create new User

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

operatorId

integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

string

required

emailVerified

string | null

ISO 8601 formatted date

password

string

required

length ≥ 6

requirePasswordReset

boolean

Sets a requirement for the user to set a new password when they next open the app. After a new password is set, this option resets automatically.

first_name

string

middle_name

string

last_name

string

phone

string

country

string

enum

state

enum

The field will be considered only if the provided country is US or AU

For cases when the country is USA.

city

string

post_code

string

address

string

vehicle_no

string

personal_id

string

company_name

string

locale

string | null

The language and regional settings to use in the app.

Only available if the option to update the user locale has been enabled for the operator.

userGroupIds

array of integers

userGroupIds

externalId

string | null

Third party identifier of the user

options

object

receiveNewsAndPromotions

boolean

Indicates whether the user has opted into receiving news and promotions. To opt in, set this field to 'true'; otherwise, set it to 'false'.

skipPreAuthorization

boolean

When enabled, the user can start charging sessions without a pre-authorization hold on their payment method.

skipUnpaidSessionCheck

boolean

When enabled, this user can start new sessions even if they have unpaid sessions or unpaid post-paid subscription fees.

bankDetails

object

externalAppData

object | null

The externalAppData field is an object designed to hold additional data related to external integrations.
This object can contain the following keys, which are currently supported:

externalCustomerId: A string representing the customer ID of the user in an external payment provider integration. This ID is used to link the user's account within the system to their corresponding account in the external payment provider.

If no information is available, the externalAppData object will be null."

nonce

string

A optional unique string that is used to prevent replay attacks. It's generated by the server, the client should pass it if the user is being created from an external sign up embedded web app and needs to automatically log in the user in the mobile app after creation.

Responses

201User created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*