Skip to main content
PUT
/
api
/
v1
/
users
/
{user_id}
/
password
Reset user password
curl --request PUT \
  --url https://api.example.com/api/v1/users/{user_id}/password \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_password": "<string>",
  "send_reset_link": false
}
'
{}

Headers

authorization
string | null

Path Parameters

user_id
string
required

Body

application/json

Request schema for resetting a user's password.

Used by superadmins to reset user passwords.

new_password
string<password> | null

New password

Minimum string length: 1

Whether to send a password reset link instead of setting password directly

Response

Successful Response

{key}
string