Reset password

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

Auth: Both — authentication, inside the users/ prefix of the authenticated group. 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:
FieldTypeRequiredNotes
passwordstringyesplus a regex requiring at least 1 special character and forbidding ", ', \, whitespace, and control characters.

Response{ data. } envelope.

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

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json