The POST /users/{userId}/forgotPassword endpoint sends a Password Reset email to the user matching the provided user ID.
...
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:write | Entire endpoint |
Parameters
The endpoint accepts the following path parameter:
...
Type | Required | Example |
|---|---|---|
| String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The user ID of the user to send the email to.
Requests
Send password reset email for a user
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X POST "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/forgotPassword" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Successful response
Successful requests return a 200 Success code.