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>"
}
'import requests
url = "https://staging-api.puppetvendors.com/portal/auth/forgot-password"
payload = {
"email": "<string>",
"shopDomain": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', shopDomain: '<string>'})
};
fetch('https://staging-api.puppetvendors.com/portal/auth/forgot-password', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/portal/auth/forgot-password",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'shopDomain' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging-api.puppetvendors.com/portal/auth/forgot-password"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging-api.puppetvendors.com/portal/auth/forgot-password")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-api.puppetvendors.com/portal/auth/forgot-password")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyVendor Portal Auth
Forgot Password
Send a password reset link to a vendor’s email
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>"
}
'import requests
url = "https://staging-api.puppetvendors.com/portal/auth/forgot-password"
payload = {
"email": "<string>",
"shopDomain": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', shopDomain: '<string>'})
};
fetch('https://staging-api.puppetvendors.com/portal/auth/forgot-password', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/portal/auth/forgot-password",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'shopDomain' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging-api.puppetvendors.com/portal/auth/forgot-password"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging-api.puppetvendors.com/portal/auth/forgot-password")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-api.puppetvendors.com/portal/auth/forgot-password")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyV2 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
The vendor’s registered email address.
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"
}'
Was this page helpful?
⌘I