Password reset request. It sends an email or SMS (depends on login type) with pin code to reset password.
Users
POST request password reset
Endpoint
POST /api/v1/users/password
Parameters
Name | Description |
---|---|
user[login] required | Email or phone number |
Request
Route
POST /api/v1/users/password
Headers
Accept: application/json
Content-Type: application/json
Host: example.org
Cookie:
Body
{
"user": {
"login": "jimmie.schinner+operator@example.com"
}
}
Response
Simulated Response
Status
200
Headers
x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"ae7a70d966899a8db7c12e2b89d750bd"
cache-control: max-age=0, private, must-revalidate
x-request-id: 6f639c9e-bbac-4c68-9716-cde5ef810412
x-runtime: 0.032507
content-length: 273
Body
{
"user": {
"id": 1878,
"company": null,
"contact_phone_number": null,
"email": "jimmie.schinner+operator@example.com",
"first_name": "Jimmie",
"job_position": null,
"last_name": "Schinner",
"phone_number": null,
"pin_valid_to": "2025-07-23T10:28:49.131Z",
"profile_id": null,
"role": "operator"
}
}