edit member email group
/groups/{group}/members/{member}/email [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
6.2000 | 6.2000 | json, xml |
Description
Edit member email with token and use email notification template for group.
This service requires a change-email token to authorize the request.
The change-email
token is issued when users change their email address in their personal details. It is sent along with the change-email-confirm email so that they can confirm their new email is correct.
After the email is changed the change-email email is sent to the new and previous email addresses to alert the user.
Parameters
Name | Description | Required | Type | Default value |
---|---|---|---|---|
token | The change email token for the member | no | string |
Permission
The user must provide a valid change-email
token as a parameter that is associated with the member in the request.
Response
The XML returned is always:
<member-modification> <member id="[member id]" firstname="[first name]" surname="[surname]" username="[username]" email="[email]" status="[activated|unactivated|set-password]"> <fullname>[full name]</fullname> </member> </member-modification>
Error handling
0x1004 | If the email is already in use. |
---|---|
0x102A | If the token is invalid or has expired |