Reset user password
curl --request POST \
--url https://dashboard.brandblast.ai/api/v1/resetUserPassword \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_email": "user@example.com",
"new_password": "newSecurePassword123"
}
'import requests
url = "https://dashboard.brandblast.ai/api/v1/resetUserPassword"
payload = {
"user_email": "user@example.com",
"new_password": "newSecurePassword123"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_email: 'user@example.com', new_password: 'newSecurePassword123'})
};
fetch('https://dashboard.brandblast.ai/api/v1/resetUserPassword', 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://dashboard.brandblast.ai/api/v1/resetUserPassword",
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([
'user_email' => 'user@example.com',
'new_password' => 'newSecurePassword123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://dashboard.brandblast.ai/api/v1/resetUserPassword"
payload := strings.NewReader("{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://dashboard.brandblast.ai/api/v1/resetUserPassword")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.brandblast.ai/api/v1/resetUserPassword")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Password reset successfully."
}{
"message": "Missing required parameters."
}{
"message": "Unauthorized: Invalid or unauthorized API key."
}{
"message": "Unauthorized: Cannot reset password for a white label user."
}{
"message": "User not found."
}{
"message": "Failed to reset password."
}Endpoint Examples
Reset User Password
Reset the password for a specified user. This does not notify the user in any way.
POST
/
v1
/
resetUserPassword
Reset user password
curl --request POST \
--url https://dashboard.brandblast.ai/api/v1/resetUserPassword \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_email": "user@example.com",
"new_password": "newSecurePassword123"
}
'import requests
url = "https://dashboard.brandblast.ai/api/v1/resetUserPassword"
payload = {
"user_email": "user@example.com",
"new_password": "newSecurePassword123"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_email: 'user@example.com', new_password: 'newSecurePassword123'})
};
fetch('https://dashboard.brandblast.ai/api/v1/resetUserPassword', 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://dashboard.brandblast.ai/api/v1/resetUserPassword",
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([
'user_email' => 'user@example.com',
'new_password' => 'newSecurePassword123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://dashboard.brandblast.ai/api/v1/resetUserPassword"
payload := strings.NewReader("{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://dashboard.brandblast.ai/api/v1/resetUserPassword")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.brandblast.ai/api/v1/resetUserPassword")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_email\": \"user@example.com\",\n \"new_password\": \"newSecurePassword123\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Password reset successfully."
}{
"message": "Missing required parameters."
}{
"message": "Unauthorized: Invalid or unauthorized API key."
}{
"message": "Unauthorized: Cannot reset password for a white label user."
}{
"message": "User not found."
}{
"message": "Failed to reset password."
}⌘I