POST /api/users/{UserID}/sendEmailChangeCode

Initiates sending of email notifications to old and new email addresses when a user initiates change of email address on the account, or when a Site Admin initiates email address change for the user's account.

Authorization Roles/Permissions: Must be logged in. A user can change his/her email address; a Site Admin can change the email address of another user. However, the Site Admin cannot change the email address of another Site Admin or Business Admin.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

POST

URL

https://{hostname}/api/users/{UserID}/sendEmailChangeCode

Sample Request

The example below shows a request to change the email address for the specified user, to the address shown in the request body.

Sample Request URL

https://{hostname}/api/users/0b1f57b0-7c48-4c75-b4d4-da2f44885cdb.acmepaymentscorp/sendEmailChangeCode

Sample request headers

Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

The message is encoded, so the @ sign in the email address is encoded to %40.

newEmailAddress=jmead%40acmepaymentscorp.com

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	application/x-www-form-urlencoded
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
newEmailAddress	Form	string	Required	The new email address for the user's account.

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Date: Thu, 18 Apr 2019 18:27:46 GMT

Sample response body

None.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body