Difference between revisions of "Forgot Password"
Ashley DeBon (talk | contribs) (Created page with "== Forgot Password == === Base URL === https://apimobile.callproof.com === Endpoint === /api/forgot-password === Purpose === Starts a password reset for a user account. Whe...") |
Ashley DeBon (talk | contribs) (→Forgot Password) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Forgot Password == | + | == [[Mobile_API]] »Forgot Password == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
| email || string || Yes || Email address of the account requesting a password reset (must be a valid email format) | | email || string || Yes || Email address of the account requesting a password reset (must be a valid email format) | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/forgot-password' \ --header 'Content-Type: application/json' \ --data '{ "email": "YOUR_EMAIL@EXAMPLE.COM" }' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/forgot-password' \ --header 'Content-Type: application/json' \ --data '{ "email": "YOUR_EMAIL@EXAMPLE.COM" }' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:03, 21 July 2026
Contents
Mobile_API »Forgot Password
Base URL
https://apimobile.callproof.com
Endpoint
/api/forgot-password
Purpose
Starts a password reset for a user account. When a matching email is found, a password reset link is queued/emailed to that address.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Content-Type | Yes | application/x-www-form-urlencoded or application/json
|
Security
- No – Public endpoint; Bearer Token is not required for this request (a public route is also registered for this path).
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Email address of the account requesting a password reset (must be a valid email format) |
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/forgot-password' \ --header 'Content-Type: application/json' \ --data '{ "email": "YOUR_EMAIL@EXAMPLE.COM" }'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/forgot-password' \ --header 'Content-Type: application/json' \ --data '{ "email": "YOUR_EMAIL@EXAMPLE.COM" }'
Successful Response (200)
Indicates that a reset email was prepared for a matching account.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| message | string | Confirmation message (for example, "A password reset link has been emailed if this user exists.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Validation failed – response body uses clientStatusCode 401 with the first validation error message
|
| 400 | Bad Request – password reset could not be completed |
| 401 | Unauthorized – if this request is matched by the authenticated route registration and no valid token is provided |
- Validation (HTTP 200, clientStatusCode 401) – Missing
emailor invalid email format. - 400 – User not found / reset could not proceed (may return "A password reset link has been emailed if this user exists."), reset error ("Error while resetting the password"), or method not permitted ("Not permitted").
- 401 – Authentication required when the authenticated route variant is used.
