Request password reset

Use this API to initiate the password reset flow, so that your customer can define a new password. Using this endpoint will trigger an email to the customer. The email contains a link which directs the customer to a password reset page on the web.

post/customers/request_password_reset

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/customers/request_password_reset
  • Auth
    API key in header X-Publisher-Token

Headers

Content-Typestring

Request body

customerIdinteger

Customer identifier at Cleeng. Required conditionally if customerEmail is not provided.

customerEmailstring

The email address of the customer. Required conditionally if customerId is not provided.

resetUrlstring required

Information where reset password form will be kept.

Response

200

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.