send activation
/members/sendactivation [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9100 | 6.0000 | json, xml |
Description
Send the activation notification email to a member who has not activated their account.
Email templates
This service uses the default PageSeeder templates.
To use customized emails, use the globalTemplate global property.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| The member’s email address (required if username is not specified) | maybe | string | ||
| member-username | The member’s username (required if email address is not specified) | maybe | string | |
| notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
Permission
This service is public: anybody can invoke it.
Response
The response returns the email address the activation email was sent to
<member-activation email="[email]" />
Or in JSON
{ "email": string }Error Handling
| Code | Cause / Description |
|---|---|
| 0x1008 | At least one of email/password must be specified |
| 0x1002 | If the email address is invalid |
| 0x100E | No matching member |
| 0x100F | When no email can be sent because the user has no email address |
| 0x1010 | Member is already activated |
| 0x6001 | When the activation email could not be sent because an email failure or a template error |