Users

Request a Password Reset

Requests a password reset email.

post/v2.0/users/requestpasswordreset

Request

Base URL
https://api-trial.cognigy.ai/testing
Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2
  Authorization code/auth/oauth2/authorize
  Password
  Token URL/auth/oauth2/token
TypeScript
https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/v2.0/users/requestpasswordreset/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

organisationIdstring

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

emailstring required

The E-Mail-Adress of the corresponding user account

Response

Successfully sent password reset Mail

Changes

No recorded changes to this operation across all 1 revision of this API.