API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Archive preferences

This method allows you to deactivate preferences on a profile across one or more Filters. You can deactivate preferences that are simply tied to the profile or preferences that are associated with contact elements.

To deactivate all preferences across all filters on a profile, simply set the GlobalDeactivate parameter to true. Deactivated preferences are archived and are no longer returned via the MyPreferences API.

You can create a segment to retrieve archived preferences using the MyPreferences Bulk Export API.

Header Parameters

Authorizationstring Required

Authorization token

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

profileIdinteger Required

Id associated with the profile.

Body Parameters

GlobalDeactivateboolean

If set to true, deactivates and archives all preferences associated with the Profile and all its contact elements.

Reason_Codestring

Optional parameter that can be used to store the reason for deactivation.

PhoneNumbersarray

A collection of phone preferences associated with the User Profile that you want to deactivate. All deactivated phone preferences are archived.

Show child attributes

Addressesarray

Collection of addresses associated with the profile.

Show child attributes

Emailsarray

A collection of email preferences associated with the User Profile that you want to deactivate. All deactivated email preferences are archived.

Show child attributes

ProfilePreferencesarray

A collection of preferences associated with the User Profile that you want to deactivate. All deactivated profile preferences are archived.

Show child attributes

Response

204
Object
The request was successful; however, it does not return any content.
400
Object
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
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
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
Object
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.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?