PUT {clientId}/Profile/Preferences/{profileId}/Archive

This method deactivates and archives preferences associated with the Profile or Contact Elements on a profile across one or more Filters. To deactivate all preferences across all Contact Elements and Filters on a profile, simply set the GlobalDeactivate parameter to true. Archived preferences are no longer returned via the MyPrefererences standard API. You can create a Segment to retrieve archived preferences using the MyPreferences Bulk Export API.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences account Id.	string	Required
profileId	Id associated with the profile.	integer	Required

Body Parameters

Name	Description	Type
GlobalDeactivate	If set to true, deactivates and archives all preferences associated with the Profile and all its contact elements.	boolean
Reason_Code	Optional parameter that can be used to store the reason for deactivation.	string
PhoneNumbers	A collection of phone preferences associated with the User Profile that you want to deactivate. All deactivated phone preferences are archived.	Collection of ArchivePhoneNumberPreference
Addresses	A collection of mail preferences associated with the User Profile that you want to deactivate. All deactivated address preferences are archived.	Collection of ArchiveAddressPreference
Emails	A collection of email preferences associated with the User Profile that you want to deactivate. All deactivated email preferences are archived.	Collection of ArchiveEmailPreference
ProfilePreferences	A collection of preferences associated with the User Profile that you want to deactivate. All deactivated profile preferences are archived.	Collection of ArchiveProfilePreference

Request Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "GlobalDeactivate": true,
  "Reason_Code": "sample string 2",
  "PhoneNumbers": [
    {
      "PhoneType": "sample string 1",
      "PhoneNumber": "sample string 2",
      "PhoneNumberNumeric": 3,
      "FilterId": "sample string 4",
      "Reason_Code": "sample string 5"
    },
    {
      "PhoneType": "sample string 1",
      "PhoneNumber": "sample string 2",
      "PhoneNumberNumeric": 3,
      "FilterId": "sample string 4",
      "Reason_Code": "sample string 5"
    }
  ],
  "Addresses": [
    {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "CountryCode_Numeric": "sample string 5",
      "CountryCode_Alpha2": "sample string 6",
      "CountryCode_Alpha3": "sample string 7",
      "PostalCode": "sample string 8",
      "AddressType": "sample string 9",
      "FilterId": "sample string 10",
      "Reason_Code": "sample string 11"
    },
    {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "CountryCode_Numeric": "sample string 5",
      "CountryCode_Alpha2": "sample string 6",
      "CountryCode_Alpha3": "sample string 7",
      "PostalCode": "sample string 8",
      "AddressType": "sample string 9",
      "FilterId": "sample string 10",
      "Reason_Code": "sample string 11"
    }
  ],
  "Emails": [
    {
      "EmailAddressType": "sample string 1",
      "EmailAddress": "sample string 2",
      "FilterId": "sample string 3",
      "Reason_Code": "sample string 4"
    },
    {
      "EmailAddressType": "sample string 1",
      "EmailAddress": "sample string 2",
      "FilterId": "sample string 3",
      "Reason_Code": "sample string 4"
    }
  ],
  "ProfilePreferences": [
    {
      "CustomerType": "sample string 1",
      "FilterId": "sample string 2",
      "Reason_Code": "sample string 3"
    },
    {
      "CustomerType": "sample string 1",
      "FilterId": "sample string 2",
      "Reason_Code": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ArchivePreferences xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <Addresses>
    <ArchiveAddressPreference>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <AddressType>sample string 9</AddressType>
      <City>sample string 3</City>
      <CountryCode_Alpha2>sample string 6</CountryCode_Alpha2>
      <CountryCode_Alpha3>sample string 7</CountryCode_Alpha3>
      <CountryCode_Numeric>sample string 5</CountryCode_Numeric>
      <FilterId>sample string 10</FilterId>
      <PostalCode>sample string 8</PostalCode>
      <Reason_Code>sample string 11</Reason_Code>
      <StateProvince>sample string 4</StateProvince>
    </ArchiveAddressPreference>
    <ArchiveAddressPreference>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <AddressType>sample string 9</AddressType>
      <City>sample string 3</City>
      <CountryCode_Alpha2>sample string 6</CountryCode_Alpha2>
      <CountryCode_Alpha3>sample string 7</CountryCode_Alpha3>
      <CountryCode_Numeric>sample string 5</CountryCode_Numeric>
      <FilterId>sample string 10</FilterId>
      <PostalCode>sample string 8</PostalCode>
      <Reason_Code>sample string 11</Reason_Code>
      <StateProvince>sample string 4</StateProvince>
    </ArchiveAddressPreference>
  </Addresses>
  <Emails>
    <ArchiveEmailPreference>
      <EmailAddress>sample string 2</EmailAddress>
      <EmailAddressType>sample string 1</EmailAddressType>
      <FilterId>sample string 3</FilterId>
      <Reason_Code>sample string 4</Reason_Code>
    </ArchiveEmailPreference>
    <ArchiveEmailPreference>
      <EmailAddress>sample string 2</EmailAddress>
      <EmailAddressType>sample string 1</EmailAddressType>
      <FilterId>sample string 3</FilterId>
      <Reason_Code>sample string 4</Reason_Code>
    </ArchiveEmailPreference>
  </Emails>
  <GlobalDeactivate>true</GlobalDeactivate>
  <PhoneNumbers>
    <ArchivePhoneNumberPreference>
      <FilterId>sample string 4</FilterId>
      <PhoneNumber>sample string 2</PhoneNumber>
      <PhoneNumberNumeric>3</PhoneNumberNumeric>
      <PhoneType>sample string 1</PhoneType>
      <Reason_Code>sample string 5</Reason_Code>
    </ArchivePhoneNumberPreference>
    <ArchivePhoneNumberPreference>
      <FilterId>sample string 4</FilterId>
      <PhoneNumber>sample string 2</PhoneNumber>
      <PhoneNumberNumeric>3</PhoneNumberNumeric>
      <PhoneType>sample string 1</PhoneType>
      <Reason_Code>sample string 5</Reason_Code>
    </ArchivePhoneNumberPreference>
  </PhoneNumbers>
  <ProfilePreferences>
    <ArchiveProfilePreference>
      <CustomerType>sample string 1</CustomerType>
      <FilterId>sample string 2</FilterId>
      <Reason_Code>sample string 3</Reason_Code>
    </ArchiveProfilePreference>
    <ArchiveProfilePreference>
      <CustomerType>sample string 1</CustomerType>
      <FilterId>sample string 2</FilterId>
      <Reason_Code>sample string 3</Reason_Code>
    </ArchiveProfilePreference>
  </ProfilePreferences>
  <Reason_Code>sample string 2</Reason_Code>
</ArchivePreferences>

Response Information

Response Codes

HTTP Status Code	Text	Description
204	No Content	The request was successfully processed but there is no content to return.
400	Bad Request	The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404	Not Found	The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

None.