Generate account confirmation email

This API endpoint allows sending a new account confirmation email to the user's email address. The email contains a unique confirmation link that the user can click to confirm their account. Upon clicking the link, the server verifies the token and sets the account status to confirmed, allowing the user to log in. If the confirmation link is invalid or has expired, the server will show an error message.

Query Parameters

client_auth_token string required

Client API token

application/json

Request Body

user object

email email

user email

Responses

• 200
• 401
• 403
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

successful

already-confirmed

---

Schema

success boolean required

Default value: true

message string required

{
  "success": true,
  "message": "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
}

User create confirmation Link (success true)

{
  "success": true,
  "message": "Confirmation Link sent successfully"
}

User create confirmation Link (success false)

{
  "success": false,
  "message": "Email was already confirmed, please try signing in"
}

Unauthorized

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean
errors string[]

{
  "success": true,
  "errors": [
    "string"
  ]
}

{
  "success": false,
  "errors": [
    "You must provide an email address."
  ]
}

Forbidden, api key is missing or invalid

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean

Default value: false

message string
status integer

Default value: 401

{
  "success": false,
  "message": "string",
  "status": 401
}

{
  "success": false,
  "message": "You don't have permission!"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...