Start a password reset for an end-user by email (sends the branded email and returns the token).

POSThttps://staging.softsolz.uk/api/v1/services/customer-auth/password-resets

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

emailstring

Email of the end-user to reset.

send_emailboolean

When false, the token is returned but no email is sent.

reset_link_templatestring

Optional URL template; "{token}" is substituted.

Response

Response Body

sentbooleanWhether a reset was started.

tokenstring | nullRaw password-reset token (single-use, 1h TTL).

expires_atstring | nullToken expiry.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.customerAuth.createPasswordReset({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "sent": true,
    "token": "string",
    "expires_at": "string"
  }
}