Update a user's password

  • Updated on Jul 16, 2024
  • 1 minute(s) read
Prev Next
Get
/UpdateUserPassword

Allows you to update a user's password.

Security
API Key
Header parameter nameapi_key
Query parameters
id
integer (int32) Required

The user's ID

password
stringRequired

The new password

forcePasswordChange
boolean

An optional parameter to force the user to change their password on the next login

Responses
200

OK Response

object
status
integer (int32)

Indicates the status of the API request.

  • 0 = Success
  • 10 = Error
  • 20 = Not found
  • 30 = Invalid integration key
Example10
error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).