POST

Send Set Password Email


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sends a site member an email with a link to set their password.

The set password link is valid for 3 hours, and it can be used only once. If the link expires, the original password remains.

Permissions
Manage Members
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v1/auth/members/send-set-password-email

Body Params
emailstringRequired

Login email of the member whose password will be set.


requestedByMemberboolean

Deprecated: This field has been replaced with hideIgnoreMessage and will be removed on June 30, 2022. If your app uses this field, we recommend updating your code as soon as possible.

Whether the email is being sent by member request.

If true, the email tells the member they can safely ignore if they did not request the password change.

Defaults to false.


hideIgnoreMessageboolean

Whether to hide the ignore this email message .

If true, the email tells the member they can safely ignore if they did not request the password change.

Defaults to false.

Response Object
acceptedboolean

Indicates if the request was successfully received.

Send set password email to member
Request
cURL
curl -L -X POST 'https://www.wixapis.com/members/v1/auth/members/send-set-password-email' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "email": "member@email.com", "hideIgnoreMessage": false }'
Response
JSON
{ "accepted": true }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?