POST /api/users/validateEmailChangeCode

Validates the email change code that a user provides. The code is generated, and sent to the user, in response to a request to change the email address on the account, whether initiated by the user or the Site Admin.

Authorization Roles/Permissions: Must be logged in.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/users/validateEmailChangeCode

Sample Request

The example below shows a request to validate the email change code and therefore change the email address for the user. The change code is issued by the system in response to the POST /api/users/{UserID}/sendEmailChangeCode operation.

Sample Request URL

https://{hostname}/api/users/validateEmailChangeCode

Sample request headers

POST /api/users/validateEmailChangeCode
Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "changeCode":"pKhdsgdTvdL6DwI7gWgRCZrK8AUzc1I4sH6W9pCRslY6NkcMscqpzapHV5rIxbKnfKuq51EOIhqVTWsigIerWx_hdTy8iwiNq6gvKRdpK6OIlw-HaZ-jk1D4FTZctoiLLzrFl0mkKqlNrCy4iM91Xg65Zppp6dYSuWQHeZSHvx6dF4Pp0",
  "newEmailAddress":"jmead@acmepaymentscorp.com"
}

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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
EmailChangeRequest	Body	EmailChangeRequest	Required	Contains information needed to complete a request to change the email address on a user account.

Response

If successful, this operation returns HTTP status code 200, with confirmation that the email address for the specified user has been changed.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Content-Type: application/json
Date: Thu, 18 Apr 2019 17:51:15 GMT

Sample response body

{
  "newEmailAddress":"jmead@acmepaymentscorp.com",
  "userName":"JaneMead",
  "changeStatus":true
}

Response Headers

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

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

Response Body

Name	Type	Description
EmailChangeResponse	EmailChangeResponse	Contains information about a completed request to change the email address on a user account.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics