Users

Password reset request. It sends an email or SMS (depends on login type) with pin code to reset password.

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": "geoffrey.mcglynn+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/"7ba9ce723b8989b0c2016e8032989344"
cache-control: max-age=0, private, must-revalidate
x-request-id: ac8a8815-4ba6-45a0-ab30-8e2e9788ade9
x-runtime: 0.021666
content-length: 275

Body

{
  "user": {
    "id": 1857,
    "company": null,
    "contact_phone_number": null,
    "email": "geoffrey.mcglynn+operator@example.com",
    "first_name": "Geoffrey",
    "job_position": null,
    "last_name": "McGlynn",
    "phone_number": null,
    "pin_valid_to": "2025-10-20T08:59:38.850Z",
    "profile_id": null,
    "role": "operator"
  }
}