> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mycargoextra.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mycargoextra.com/_mcp/server. # Forgot User Password POST http://localhost:9000/api/v1/user/forgot-password Content-Type: application/json 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. Reference: https://docs.mycargoextra.com/cargo-extra-gateway-api-copy/user/forgot-password/forgot-user-password ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/user/forgot-password: post: operationId: forgot-user-password summary: Forgot User Password description: >- 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. tags: - subpackage_user.subpackage_user/forgotPassword responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/user_forgot-password_Forgot User Password_Response_200 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/PostApiV1UserForgot-passwordRequestBadRequestError '403': description: Forbidden content: application/json: schema: $ref: >- #/components/schemas/PostApiV1UserForgot-passwordRequestForbiddenError '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/PostApiV1UserForgot-passwordRequestNotFoundError '429': description: Too Many Requests content: application/json: schema: $ref: >- #/components/schemas/PostApiV1UserForgot-passwordRequestTooManyRequestsError '500': description: Internal Server Error content: application/json: schema: $ref: >- #/components/schemas/PostApiV1UserForgot-passwordRequestInternalServerError requestBody: content: application/json: schema: type: object properties: email: type: string format: email required: - email servers: - url: http://localhost:9000 description: http://localhost:9000 components: schemas: user_forgot-password_Forgot User Password_Response_200: type: object properties: key_0: type: integer key_1: type: string key_2: type: number format: double key_3: type: string key_4: type: boolean required: - key_0 - key_1 - key_2 - key_3 - key_4 title: user_forgot-password_Forgot User Password_Response_200 PostApiV1UserForgot-passwordRequestBadRequestError: type: object properties: message: type: string required: - message title: PostApiV1UserForgot-passwordRequestBadRequestError PostApiV1UserForgot-passwordRequestForbiddenError: type: object properties: message: type: string required: - message title: PostApiV1UserForgot-passwordRequestForbiddenError PostApiV1UserForgot-passwordRequestNotFoundError: type: object properties: message: type: string required: - message title: PostApiV1UserForgot-passwordRequestNotFoundError PostApiV1UserForgot-passwordRequestTooManyRequestsError: type: object properties: message: type: string required: - message title: PostApiV1UserForgot-passwordRequestTooManyRequestsError PostApiV1UserForgot-passwordRequestInternalServerError: type: object properties: message: type: string required: - message title: PostApiV1UserForgot-passwordRequestInternalServerError ``` ## Examples **Request** ```json { "email": "ada.lovelace@example.com" } ``` **Response** ```json { "key_0": 1234, "key_1": "OTP email queued successfully", "key_2": 0, "key_3": "Please check your email for the OTP to reset your password.", "key_4": true } ``` **SDK Code** ```python user_forgot-password_Forgot User Password_example import requests url = "http://localhost:9000/api/v1/user/forgot-password" payload = { "email": "ada.lovelace@example.com" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript user_forgot-password_Forgot User Password_example const url = 'http://localhost:9000/api/v1/user/forgot-password'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"email":"ada.lovelace@example.com"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go user_forgot-password_Forgot User Password_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:9000/api/v1/user/forgot-password" payload := strings.NewReader("{\n \"email\": \"ada.lovelace@example.com\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby user_forgot-password_Forgot User Password_example require 'uri' require 'net/http' url = URI("http://localhost:9000/api/v1/user/forgot-password") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"email\": \"ada.lovelace@example.com\"\n}" response = http.request(request) puts response.read_body ``` ```java user_forgot-password_Forgot User Password_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://localhost:9000/api/v1/user/forgot-password") .header("Content-Type", "application/json") .body("{\n \"email\": \"ada.lovelace@example.com\"\n}") .asString(); ``` ```php user_forgot-password_Forgot User Password_example request('POST', 'http://localhost:9000/api/v1/user/forgot-password', [ 'body' => '{ "email": "ada.lovelace@example.com" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp user_forgot-password_Forgot User Password_example using RestSharp; var client = new RestClient("http://localhost:9000/api/v1/user/forgot-password"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"email\": \"ada.lovelace@example.com\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift user_forgot-password_Forgot User Password_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = ["email": "ada.lovelace@example.com"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:9000/api/v1/user/forgot-password")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```