PUT api/v1/candidates/{candidateUid}/changeemailaddress/{emailAddress}

Changes the candidate email address.

Request Information

URI Parameters

Name	Description	Type	Additional information
candidateUid	The candidate UID.	globally unique identifier	Required
emailAddress	The email address.	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns response message.

UserConfirmationViewModel

Name	Description	Type	Additional information
User	The user.	UserViewModel	None.
Email	The email.	string	None.
RequestGuid	The request GUID.	globally unique identifier	None.
CandidateReference	The candidate reference number, if the user is a candidate and one has been set	string	None.

Response Formats

application/json, text/json

Sample:

{
  "User": {
    "Logon": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "OtherNames": "sample string 4",
    "IsConfirmed": true,
    "CandidateReference": "sample string 6",
    "SecretKey2FA": "sample string 7",
    "Is2FASiteWide": true,
    "Uid": "cf301ac1-c203-4d58-9f6a-7315932a2b1a",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T13:57:43.1957879+00:00",
    "UpdatedBy": "sample string 10"
  },
  "Email": "sample string 1",
  "RequestGuid": "9429b53f-f5c5-4caa-bcc1-495563d9f2cf",
  "CandidateReference": "sample string 3"
}

application/xml, text/xml

Sample:

<UserConfirmationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <CandidateReference>sample string 3</CandidateReference>
  <Email>sample string 1</Email>
  <RequestGuid>9429b53f-f5c5-4caa-bcc1-495563d9f2cf</RequestGuid>
  <User>
    <DateUpdated>2025-10-27T13:57:43.1957879+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>cf301ac1-c203-4d58-9f6a-7315932a2b1a</Uid>
    <UpdatedBy>sample string 10</UpdatedBy>
    <CandidateReference>sample string 6</CandidateReference>
    <Forename>sample string 2</Forename>
    <Is2FASiteWide>true</Is2FASiteWide>
    <IsConfirmed>true</IsConfirmed>
    <Logon>sample string 1</Logon>
    <OtherNames>sample string 4</OtherNames>
    <SecretKey2FA>sample string 7</SecretKey2FA>
    <Surname>sample string 3</Surname>
  </User>
</UserConfirmationViewModel>