Resend Email Confirmation¶

Description¶

This API resends the email confirmation email message to a user. It applies only to the apps which have the "Require email confirmation" option enabled. If the user status is "email confirmation pending", then an email with the confirmation link is resent, otherwise an error occurs.

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/resendconfirmation/<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¶

None. If the API request completes successfully, it means an email confirmation message has been sent to the user. Otherwise, an error will be returned.

Examples¶

The example below resends a new confirmation email to the alice@yourmail.com.

curl --location --request POST 'https://xxxx.backendless.app/api/users/resendconfirmation/alice@yourmail.com'

Errors¶

When the server-side reports an error, it returns a JSON object in the following format:

{  
  "message":error-message,  
  "code":error-code  
}

The API call may result in the following errors.

Error Code	Description
3102	User has already confirmed the email address. Email confirmation will not be sent.
3103	Unable to send email confirmation. The "Require Email Confirmation" option must be enabled in Backendless Console (see the Users > Registration screen)
3104	Unable to send email confirmation - user account with the email cannot be found.

Codeless Reference
¶