Send a password reset email
curl --request POST \
--url https://web-api.dev.soxai.site/api/resetPasswordimport requests
url = "https://web-api.dev.soxai.site/api/resetPassword"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://web-api.dev.soxai.site/api/resetPassword', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"email": "member@example.com"
}{
"error": "bad-request",
"error_msg": "Invalid input: <reason>"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Authentication
Send a password reset email
Not part of the Sandbox
A Sandbox key does not authenticate this endpoint and a Sandbox identity cannot complete it, because it would send or resolve a real email. It is published here because the Sandbox runs the same build. See Sandbox.
Ask SOXAI Authentication to send a password reset email, in Japanese, to the given address.
Parameters
email(query, required) - the address to send to.
Response
200returns SOXAI Authentication’s answer unchanged. An address that belongs to no account is reported in that body.
Errors
- None specific to this endpoint. An address that belongs to no account is reported
inside the
200body, not as a status.
Authorization
- No authentication. A caller who has lost their password cannot hold a token.
POST
/
api
/
resetPassword
Send a password reset email
curl --request POST \
--url https://web-api.dev.soxai.site/api/resetPasswordimport requests
url = "https://web-api.dev.soxai.site/api/resetPassword"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://web-api.dev.soxai.site/api/resetPassword', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"email": "member@example.com"
}{
"error": "bad-request",
"error_msg": "Invalid input: <reason>"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}