The Open API specification for Synapse is now available for download!

Download Open API Spec

POST /email

This service completes the email validation process for adding a new email address to an existing account. The client must provide the validation token which was sent by email. The request will be rejected if the validation token is missing or invalid, if the email address is already used or if the user making the request is not the one who initiated the email validation process.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/email

Parameters
setAsNotificationEmail

optional

if true then the newly added email address becomes the address used by the system for sending messages to the user.
Resource Information
Authentication Required
Required OAuth Scopes modify
HTTP Method POST
Request Object EmailValidationSignedToken
(application/json)
Response Object None