User / Update

patch deprecated

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

Update user

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user

integer

required

Query Params

include

array of strings

include

Allowed:

Body Params

string

emailVerified

string | null

ISO 8601 formatted date

password

string

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

company_name

string | null

userGroupIds

array of integers

userGroupIds

externalId

string | null

Third party identifier of the user

options

object

receiveNewsAndPromotions

boolean

Updates the user's preference for receiving news and promotions. To change their preference, update this field to 'true' to opt in, or 'false' to opt out.

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. It's a part of the response only if request is called with include.externalAppData query parameter.

Responses

200User updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found

422The payload you provided is invalid

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