Skip to main content
POST
/
portal
/
auth
/
forgot-password
Forgot Password
curl --request POST \
  --url https://staging-api.puppetvendors.com/portal/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "email": "<string>",
  "shopDomain": "<string>"
}
'
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Send a password reset email to the vendor. For security, the response is always the same whether or not the email exists. Rate limited to 3 requests per 15 minutes per IP.

​
Use Cases

  • Vendor portal “Forgot password?” link — Let vendors request a reset email from the login screen
  • Automated password recovery flows — Trigger a reset on behalf of a vendor from your own UI

​
Request Body

​
email
string
required
The vendor’s registered email address.
​
shopDomain
string
required
The Shopify shop domain the vendor belongs to (e.g. my-store.myshopify.com).

​
Response

200
{
  "success": true,
  "data": {
    "message": "If the email exists, a reset link has been sent"
  }
}

​
Error Responses

400
{ "success": false, "error": { "message": "\"email\" must be a valid email", "code": "VALIDATION_ERROR" } }
429
{ "success": false, "error": { "message": "Too many requests", "code": "RATE_LIMITED" } }

​
Example

curl -X POST "https://staging-api.puppetvendors.com/portal/auth/forgot-password" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "vendor@example.com",
    "shopDomain": "my-store.myshopify.com"
  }'