POST api/visitor/forget

Logs a "Forget Me" request for the visitor. A confirmation code is returned to notify that the request has been recieved. This does not consitute a confirmation that the visitor has been forgotten or that the request will be approved. Processing of the request must be confirmed separately.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Forget Visitor Info
NameDescriptionTypeAdditional information
cookieId

The Id stored in the Visitor Cookie

string

Required if customerUniqueId is not provided

customerUniqueId

A unique id assigned to the visitor by the site owner that was passed to SiteWit to track the user

string

Required if cookieId is not provided

Request Formats

application/json, text/json

Sample:
{
  "cookieId": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
  "customerUniqueId": "a-124324553"
}

application/xml, text/xml

Sample:
<ForgetVisitorInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <cookieId>aaaaaaaa-bbbb-cccc-dddd-111111111111</cookieId>
  <customerUniqueId>a-124324553</customerUniqueId>
</ForgetVisitorInfo>

Response Information

Successful Response:

Resource Description

Confirmation
NameDescriptionTypeAdditional information
id

The Confirmation Id for the request

string

 

type

The type of request to which the Confirmation Id belongs

string

 

Response Formats

application/json, text/json

Sample:
{
  "id": "11111111-1111-1111-1111-11111111111",
  "type": "ForgetUser"
}

application/xml, text/xml

Sample:
<Confirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <id>11111111-1111-1111-1111-11111111111</id>
  <type>ForgetUser</type>
</Confirmation>