< Back to home

ConsentPreference

A contact's Consent Preferences.

Properties

Name Type Description Required
ContactId Int32 The Contact's Id. Yes
ConsentCategoryId Int32 The Consent Category's Id. Yes
Mail Boolean Determines if the Contact would like to receive mail regarding this Consent Category. Yes
Email Boolean Determines if the Contact would like to receive emails regarding this Consent Category. Yes
Call Boolean Determines if the Contact would like to receive calls regarding this Consent Category. Yes
Sms Boolean Determines if the Contact would like to receive SMS messsages regarding this Consent Category. Yes
PreferredMergeTypeId Int32 (Nullable) The Id of the Contact's preferred Merge Type for this consent category. If not set, the either the preferred Merge type will not be updated, or the default merge type will be used. -1 - Do Not Send, 1 - Letter, 2 - Email, 3 - SMS. No

Endpoints

Url Actions Description
api/consentpreference/contact/{contactId} GET Lists all Consent Preferences for the Contact.
api/consentpreference POST Updates the Consent Preferences. 'ConsentPreferences' is an array of ConsentPreference items. 'ConsentDetails' is a ConsentDetails item.