Change password

Changes the user's password.

put

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This is the change password by the authorized user.

oldPasswordstring · min: 1Required

The old password of the user.

Example: OldPassword

newPasswordstring · min: 1Required

The new password of the user.

Example: NewPassword

confirmPasswordstring · min: 1Required

The confirm password of the user.

Example: NewPassword

Responses

200

The request was successful.

application/json

400

The password is not in the correct format.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/users/change-password HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "oldPassword": "OldPassword",
  "newPassword": "NewPassword",
  "confirmPassword": "NewPassword"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}