User / Create

post

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

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

company_tax_id

string

company_address

string

company_city

string

company_postal_code

string

company_country

string

enum

company_receipts_enabled

boolean

When enabled, receipt integrations that support company receipts use this user's company details for receipts when all required company fields are present.

locale

string | null

enum

The user locale value sets the Mobile App and notifications language. To change this value you must enable 'Allow updating user locale via API' in the EV drivers tab of the Operator resource.

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'.

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.

partnerId

integer | null

The ID of the partner to associate the created user with. When specified, the user will be created with created_by_partner_id set and an auto-accepted partner invite.

Required for sub-operator admins (must be a partner belonging to the sub-operator with allow_partner_to_create_users enabled).
Optional for operator admins (must belong to the operator's partners) and global admins.
Ignored for partner admins (their own partner is used automatically).

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-*