Create Email Confirmation¶
Description¶
A confirmation email message includes a special link the user clicks to confirm their email address. When the link is clicked and the link is not expired, the user status changes from EMAIL_CONFIRMATION_PENDING to ENABLED. The email message delivered to the user is created from the Confirmation template located in Messaging > Emails in Backendless Console. There are scenarios when the link needs to be generated in your application logic, for instance, if you need to send it out via text message or if you need to generate the confirmation email dynamically.
Method¶
POST
Endpoint URL¶
The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.
https://xxxx.backendless.app/api/users/createEmailConfirmationURL/<identity>
where:
| Argument | Description |
|---|---|
<identity> |
Value in a column marked as identity in the Users table. By default a Backendless application has email as the identity column. In that case the parameter for the API should be the email address of a user. |
Request Headers¶
None.
Request Body¶
None.
Response Body¶
A JSON object containing confirmation URL.
Example¶
The example below creates a new confirmation email and sends it to the alice@yourmail.com.
curl --location --request POST 'https://xxxx.backendless.app/api/users/createEmailConfirmationURL/alice@yourmail.com'