NameDescriptionTypeAdditional information
PhoneType

Name of the Phone Type to which the PhoneNumber is associated.

string

If PhoneType is not accompanied by a PhoneNumber or a FilterId, all preferences for all PhoneNumbers associated with the PhoneType are deactivated across all phone Filters. If PhoneType is accompanied by a PhoneNumber, all preferences associated with the PhoneNumber for the specified Type are deactivated across all phone Filters. If PhoneType is accompanied by PhoneNumber and FilterId, all preferences associated with the PhoneType and PhoneNumber are deactivated from the specified FilterId.

PhoneNumber

PhoneNumber on the Profile for which you want to deactivate preferences.

string

If PhoneNumber is not accompanied by a PhoneType or a FilterId, all preferences associated with the PhoneNumber across all PhoneTypes are deactivated from all phone Filters.

PhoneNumberNumeric

A read-only field that stores the numeric version of the PhoneNumber.

integer

Read-Only

FilterId

Id of the Filter in which preference is stored.

string
Reason_Code

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

string

This value will be stored with the reserved attribute “$Reason_Code” on the deactivated preference. If not included, the global “Reason_Code” is applied, if specified in the request.