Support

Send a password reset email

POST /auth/forgot-password

Sends a reset link if the email matches an account. Returns a generic message.

Parameters

email string Required

No description.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

POST /auth/forgot-password

curl -X POST "https://heimdall.qa.zoniqx.com/auth/forgot-password" \
  -H "Content-Type: application/json" \
  -d '{
      "email": "user@example.com"
    }'

const response = await fetch("https://heimdall.qa.zoniqx.com/auth/forgot-password", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "user@example.com"
  }),
});

const data = await response.json();

type AuthController_forgotPasswordResponse = Record<string, unknown>;

const response = await fetch("https://heimdall.qa.zoniqx.com/auth/forgot-password", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "user@example.com"
  }),
});

const data: AuthController_forgotPasswordResponse = await response.json();

import requests

url = "https://heimdall.qa.zoniqx.com/auth/forgot-password"

payload = {
    "email": "user@example.com"
}

response = requests.post(url, json=payload)
data = response.json()

Response · 201

{
  "message": "string"
}