PUT {clientId}/Preferences/Deactivate

Deactivate a preference in a specific Filter or across all Filters within a specific channel.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId		string	None.

Body Parameters

A single preference to submit.

DeactivatePreference

Name	Description	Type	Additional information
ChannelID	ID associated with the Channel for which you want to deactivate preferences. The supported values are Phone, Fax, Mail, Email, SMS, and Solicit. This field is required unless the Filter ID is provided. If the request contains a Channel ID, the preferences for that channel will be deactivated. If Filter ID is also specified, the Channel ID is validated against the channel type of the Filter. If they conflict, the request will be rejected and a 400 error is returned.	string	None.
FilterID	ID of the Filter in which preference is stored. This field is required unless the Channel ID is provided. If the request contains a Filter ID, the preferences for that filter will be deactivated. If a contact element is the only preference key provided, and it does not match the channel type of the Filter, the request will be rejected and a 400 error is returned.	string	None.
CID	Contains the customer id associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
Prefix	Contains the name prefix associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
FirstName	Contains the first name associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
MiddleName	Contains the middle name associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
LastName	Contains the last name associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
Suffix	Contains the name suffix associated with this preference. This value can be empty ("") or null if a contact element is provided.	string	None.
ContactElement	Contains the contact element information to submit with this preference. This field can be ommitted or null if a CID is provided.	ContactElement	None.
ReasonCode	This field is an option parameter to record reason for preference deactivation.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ChannelID": "sample string 1",
  "FilterID": "sample string 2",
  "CID": "sample string 3",
  "Prefix": "sample string 4",
  "FirstName": "sample string 5",
  "MiddleName": "sample string 6",
  "LastName": "sample string 7",
  "Suffix": "sample string 8",
  "ContactElement": {
    "Email": "sample string 1",
    "PFT": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "StateProvince": "sample string 6",
    "CountryCode": "sample string 7",
    "PostalCode": "sample string 8"
  },
  "ReasonCode": "sample string 9"
}

application/xml, text/xml

Sample:

<DeactivatePreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
  <CID>sample string 3</CID>
  <ChannelID>sample string 1</ChannelID>
  <ContactElement>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <City>sample string 5</City>
    <CountryCode>sample string 7</CountryCode>
    <Email>sample string 1</Email>
    <PFT>sample string 2</PFT>
    <PostalCode>sample string 8</PostalCode>
    <StateProvince>sample string 6</StateProvince>
  </ContactElement>
  <FilterID>sample string 2</FilterID>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 7</LastName>
  <MiddleName>sample string 6</MiddleName>
  <Prefix>sample string 4</Prefix>
  <ReasonCode>sample string 9</ReasonCode>
  <Suffix>sample string 8</Suffix>
</DeactivatePreference>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

NotFound (404)
BadRequest (400)
OK (200)
MethodNotAllowed (405)

Resource Description

HttpResponseMessage

Name	Type	Additional information
ReasonPhrase	string	None.
StatusCode	HttpStatusCode	None.
Content	HttpContent	None.
Version	Version	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.