Skip to main content

 Services

Web services from /about to /webhooks

edit member email

/members/{member}/email [POST]

com.pageseeder.member.EditEmail

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

NameDescriptionRequiredTypeDefault value
tokenThe change email token for the memberyes, if not authenticatedstring

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

CodeCause / Description
0x1004If the email is already in use
0x102AIf the token is invalid or has expired
Created on , last edited on