HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Users / Update

Update user

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Query Params
array of strings
include
Body Params
string
string | null

ISO 8601 formatted date

string
length ≥ 6
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.

string
string
string
string
string
string | null

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

string
string
string
string
array of integers
userGroupIds
string | null

Third party identifier of the user

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

object
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

422

The payload you provided is invalid

Language
Credentials
API Token
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json