POST api/user/forget

Logs a "Forget Me" request for the user. User must not be the owner of any active accounts. A confirmation code is returned to notify that the request has been recieved. This does not consitute a confirmation that the account 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 User Info

Name	Description	Type	Additional information
userToken	User token supplied when user was created	string	Required

Request Formats

application/json, text/json

Sample:

{
  "userToken": "uuuuuuuuuUuuuuuuuuuu"
}

application/xml, text/xml

Sample:

<ForgetUserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <userToken>uuuuuuuuuUuuuuuuuuuu</userToken>
</ForgetUserInfo>

Response Information

Successful Response:

Resource Description

Confirmation

Name	Description	Type	Additional 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>