API Reference
Log In
API Reference

Triggers the forgot password workflow for a user (first step in the forgot password process).

post
https://sandbox.datamotion.com/SMCApi/v3/account/password/forgot

***If a user does not require security questions to be answered when resetting their password,
only the actionTaken and actionTakenCode are returned:

{
"actionTaken": "string",
"actionTakenCode": "string"
}

HTTP Status Code 400 Error Codes (error property):

MissingPropertyValue - Missing property value(s).

HTTP Status Code 403 Error Codes (error property):

InvalidAccountTypeDirectoryServices - The account type of the specified user does not contain a password and therefore; does not allow resetting a password.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Information required when attempting to reset your password after forgetting your password.

Information about a user who has triggered the forgot password workflow.

string

The email address of a user who has forgotten their password and needs to start the forgot password workflow.

string

(Optional) The preferred cobrand of the current user.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated about 1 year ago

Did this page help you?