Send Password Reset Email

POST

https://platform-api.convirza.com/v3/users/{id}/password-reset-email

Users

Last modified:2026-10-29 12:52:30

Emails the user a link to set a new password. The same email goes out automatically when a user is created; use this when it was missed, its link expired or the user forgot their password.

Behavior

A new link is issued each time and stays valid for 72 hours; earlier links keep working until they expire or are used.

Only active users can be sent the email — activate an inactive user first.

The email uses the account branding (white label) when one is configured.

No password is returned or changed by this call; the current password keeps working until the user sets a new one.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Password reset email sent

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request POST 'https://platform-api.convirza.com/v3/users/{id}/password-reset-email' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "user_id": 12346,
        "email": "jane.doe@example.com"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-10-29 12:52:30

Delete Webhook Subscription