Unlock a user

The POST /users/{userId}/unlock unlocks a user and resets the number of login attempts for the user matching the provided user ID.

In this page


Most URLs in the example code use the following values:

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Parameters

The endpoint accepts the following path parameter:

userId

Type

Required

Example

StringTrue8e22b1fe-d2ea-403d-8c03-50eb21188e79

The user ID of the user to reset login attempts for.

Requests

Unlock a user

curl -L -X POST "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/unlock" \
-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.