Create Password Recovery

POST

/account/recovery

account

Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the PUT /account/recovery endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://appwrite.io/v1/account/recovery' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "url": "string"
}'

Response Example

{
    "$id": "string",
    "expire": 0,
    "secret": "string",
    "userId": "string"
}

Request

Body Params application/json

string

required

User email.

url

string

required

URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

Examples

Responses

🟢201Token

application/json

Body

Token

$id

string

required

Token ID.

expire

integer <int32>

required

Token expiration date in Unix timestamp.

secret

string

required

Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.

userId

string

required

User ID.

Modified at 2023-08-16 07:28:13

Update Account Preferences

Complete Password Recovery