Skip to navigation
CargoExtra Gateway API CopyuserForgot Password

Forgot User Password

View as Markdown

Starts password reset and queues an OTP email.

Required body fields: email.

Response fields: message confirms OTP dispatch.

Possible errors:

  • 404: No Account found with this email address - email is not registered.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error