API Docs
Voxbi Cockpit APIs
All endpoints

Reset Password

Resets the user's password using a valid reset token. Requires HPP API key authentication.

API Key: ApiKeyAuth
Parameter name
Authorization
Located in
header
Accept header · string

Request body

Request schema
token*string
The password reset token received by email.
password*string · password
The new password to set.

Responses

Response schema
messagestring
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
post https://cockpit.voxbi.com/api/v1/reset-password
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/reset-password' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"token":"abc123def456ghi789jkl012mno345pqr","password":"newStrongPassword123"}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/reset-password', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "token": "abc123def456ghi789jkl012mno345pqr",
    "password": "newStrongPassword123"
}),
});

const data = await response.json();
console.log(data);
import requests

response = requests.post('https://cockpit.voxbi.com/api/v1/reset-password',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "token": "abc123def456ghi789jkl012mno345pqr",
    "password": "newStrongPassword123"
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"token\": \"abc123def456ghi789jkl012mno345pqr\",
    \"password\": \"newStrongPassword123\"
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/reset-password', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"token": "abc123def456ghi789jkl012mno345pqr",
"password": "newStrongPassword123"
}
{ … }
"message": "Password has been reset successfully."
}
Host string
example: 0.0.0.0:8083
Date string
example: Thu, 12 Oct 2023 12:25:52 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Access-Control-Allow-Origin string
example: *
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}