v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB

Users

Start a password reset

Starts a password reset.

IMPORTANT: To reset a user password, first is required to send a POST to request an email to be sent to the user’s email with a link for the user to click on, so as to verify that they requested this password change.

post/v4/users/reset

Request body

siteSlugstring required

The slug of the site where the user account is registered.

Example request

{
  "identifiers": {
    "email_address": "joe.blow@company.com"
  },
  "siteSlug": "my-site"
}

Response

OK - The password reset flow has been started successfully