POST api/v1/email/unsubscribeEmail/{ValidationKey}

This can be called in the scenario user clicks on the 'Unsubscribe' link in marketting e-mails.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ValidationKey

Unique key to validate the email address

 string

Required

Body Parameters

None.

Response Information

Resource Description

0 if success or -2 for already validated

UnsubscribeEmailInfoResult
NameDescriptionTypeAdditional information
EmailID

string

None.
ResultCode

integer

None.
ResultData

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "EmailID": "sample string 1",
  "ResultCode": 2,
  "ResultData": "sample string 3"
}

application/xml, text/xml

Sample: 
<UnsubscribeEmailInfoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <EmailID>sample string 1</EmailID>
</UnsubscribeEmailInfoResult>