Deskhero Developer Hub
Back to deskhero.com
Account

Cognito forgot password init

Starts a password reset by sending a verification code to the given email address. Throttled per IP, and the confirm step is throttled per email address.

POST /api/sys/v{version:apiVersion}/account/cognito_forgot_password_init
Authorisation
No authentication needed

Request arguments

Name Type Source
inputDTO_cognito_forgot_password_initBody
Request body example

Response

Status
200 (OK)
Type
DTO_acknowledgement
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 429 (TooManyRequests)
Response body example
DTO_cognito_forgot_password_init
NameTypeReadOnlyDescription
emailStringEmail
DTO_acknowledgement
NameTypeReadOnlyDescription
messageStringMessage

Generated Aug 4, 2026 18:37