Send Password Reset email to a user

The POST /users/{userId}/forgotPassword endpoint sends a password reset email to the user matching the provided user ID.

In this page

Most URLs in the example code use the following values:

***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL
EMEA emea https://emea.api.cc.vonage.com
USA nam https://nam.api.cc.vonage.com
APAC apac https://apac.api.cc.vonage.com
<ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.

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:

`userId`

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

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.

Try it out

For information, see Trying out Vonage Contact Center APIs.

Region	URL subdomain	Base URL
EMEA	emea	https://emea.api.cc.vonage.com
USA	nam	https://nam.api.cc.vonage.com
APAC	apac	https://apac.api.cc.vonage.com