Updating communication preferences for a contact
The API provides feature to update the communication preferences for a contact, in order to update the communication preference for a contact pass the email preference, mail preference and phone call preference along with the contact Id in related to id field.
Request Information
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
pass the Communication object.
Name | Description | Type | Additional information |
---|---|---|---|
PhoneCallPreference |
Phone Call Preferences |
boolean |
None. |
MailPreference |
Mail Preference |
boolean |
None. |
EmailPreference |
Email Preference |
boolean |
None. |
Id | integer |
None. |
|
RelatedToId | integer |
None. |
|
MergedWith_Or_Secondary_Id | integer |
None. |
|
MergeType | string |
None. |
|
SortOrder | integer |
None. |
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
{ "PhoneCallPreference": true, "MailPreference": true, "EmailPreference": true, "Id": 1, "RelatedToId": 1, "MergedWith_Or_Secondary_Id": 1, "MergeType": "String Parameter 2", "SortOrder": 1 }
Updating communication preference
In order to update the communication preference pass the contact id along with the true or false for all the preferences, below is the sample shows updating the preferences for contact:
{ "PhoneCallPreference": true, "MailPreference": true, "EmailPreference": true, "RelatedToId": 9831292 }
Response Information
Resource Description
A Wrapped response object with Result as True if communication preferences were updated properly
ITypedResponseOfNullableOfBooleanName | Description | Type | Additional information |
---|---|---|---|
Result | boolean |
None. |
|
Category | string |
None. |
Response Formats
Sample not available.