Reset password

Overview

Reset the authenticated user's password to the supplied value, revoke all of their existing tokens, and return a fresh access token.

Prerequisites

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

Base URL

Endpoint

POST /api/v1/users/reset/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 implicitly the caller: it operates on only (no id param, no company scoping).

• So any authenticated user resets their own password.

• Typically called with the short-lived token returned by verify/email/otp (type=forgot_password).

Rate limit

• No rate limit.

Request body

• Body:

{
  "password": "<new-password>"
}

Response

• data.status (string) — success.
• data.response (string) — Password has been updated successfully.
• data.token (string) — a newly issued Passport access token.

200 OK · 200

{
  "data": {
    "status": "success",
    "response": "Password has been updated successfully",
    "token": "<access-token>"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/users/reset/password" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"password": "<new-password>"}'