YOyoobic
Users

Change Password

Changed on

Update user's password.
Note - dontSendMail / boolean / not required / if true no email is sent to the user. If false or not specified, an email is sent to the user to inform them about the change.

patch/public/api/users/{id}/password-change

Request

  • Base URL
    https://<base_url>
  • Auth
    HTTP bearer

Path parameters

idstring required

The id of the user

Headers

Acceptstring

e.g. application/json

Request body

passwordstring
dontSendMailboolean

Example request

{
  "password": "<the-new-password>",
  "dontSendMail": true
}

Response

OK

isPasswordUpdatedboolean
isEmailSentboolean

Example response

{
  "isPasswordUpdated": true,
  "isEmailSent": false
}

Changes