post
https://production-api.shoutaboutus.com/api/v1/users/change/password
Start an authenticated password change: verifies the current password, then emails a change_password OTP rather than changing the password directly. (Completion happens via verify/email/otp + users/reset/password.)
Auth: Both — authentication, inside the users/ prefix of the authenticated group. Target is the caller only: it checks and acts on (no id param, no company scoping). The OTP email is branded using the caller's person.company_id. Any authenticated role may change their own password.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
current_password | string | yes | Must match the caller's current password, else 400 with a current_password error. |
password | string | yes | New password. Rules: confirmed (requires password_confirmation), different:current_password, plus regex requiring 1 special char and forbidding ", ', \, whitespace, control chars. Note: not persisted here — only validated; the OTP is sent. |
password_confirmation | string | yes | Required by the confirmed rule on password; must equal password. |
Response — { data. } envelope. No token returned (password is not yet changed).
status(string) —success.response(string) —Otp has been sent successfully!
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…