Skip to main content

Send a password reset email

POST 
/api/v1/domains/:domain_uuid/users/:user_uuid/password-reset

Emails a link that lets an existing local FS PBX user choose a new password. Use this after creating a user to set up their first password, or to help an existing user regain access. Returns confirmation that the email was sent.

No request body is needed. The email goes to the user's saved user_email and uses the existing password-reset email template. Passwords, reset tokens, and reset URLs are never returned. The current password stays valid until the user completes the reset; sending the email does not enable a disabled user.

Links are single-use and expire according to the password-reset configuration (60 minutes by default). Repeat requests for the same recipient are throttled according to that configuration (60 seconds by default), returning HTTP 429.

Requires domain access and user_edit. The user must belong to the domain in the URL. Non-superadmins cannot request resets for superadmins or users above their role level. Directory-managed users must reset their passwords through the connected directory.

Request​

Responses​