API Reference

Change own password

PUT /api/users/me/password

Requires current password for verification.

Operation IDchangeOwnPassword

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject

2 properties

current_passwordstringrequired

new_passwordstringrequired

Minimum length: 8

Success response body

200Password changed

Password changed

Content typeapplication/json

responseobject

1 property

successboolean

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

401Current password incorrect

Current password incorrect

No response content schema is documented.

429Too many requests

Too many requests

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "RATE_LIMITED",
  "message": "Too many failed TOTP attempts. Try again later."
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/users/me/password' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "current_password": "string",
  "new_password": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/users/me/password", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "current_password": "string",
    "new_password": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);