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

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

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

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

Body Params

emailstringrequired

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

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/customer-auth/password-resets \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "send_email": false,
  "reset_link_template": "https://app.example.com/reset?t={token}"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "sent": true,
    "token": "tok_example",
    "expires_at": "2026-01-01T01:00:00.000Z"
  }
}