Change password

Overview

Start an authenticated password change. It 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.)

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

POST /api/v1/users/change/password

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Authentication runs inside the users/ prefix of the authenticated group.

• The 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

• Body:

{
  "current_password": "OldP@ss123",
  "password": "<new-password>",
  "password_confirmation": "NewP@ss456"
}

Response

• data.status (string) — success.
• data.response (string) — Otp has been sent successfully!

200 OK · 200

{ "data": { "status": "success", "response": "Otp has been sent successfully!" } }

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/users/change/password" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"current_password": "OldP@ss123", "password": "<new-password>", "password_confirmation": "NewP@ss456"}'