edit member email
/members/{member}/email [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.8900 | 5.9500 | json, xml |
Description
Edit member email with a token.
When the member is not authenticated, 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.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| token | The change email token for the member | yes, if not authenticated | string |
Permission
The user must be authenticated or provide a valid change-email token as a parameter that is associated with the member in the request.
Response
This service returns the <member> element wrapped in a <member-modification> element. The email attribute has the new email address as a value.
<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
| Code | Cause / Description |
|---|---|
| 0x1004 | If the email is already in use |
| 0x102A | If the token is invalid or has expired |