communications_update_preferences
Update contact communication preferences to manage email subscription status and legal consent settings for marketing communications.
Instructions
Update communication preferences for a contact
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| contactId | Yes | ||
| subscriptionId | Yes | ||
| preferences | Yes |
Input Schema (JSON Schema)
{
"properties": {
"contactId": {
"type": "string"
},
"preferences": {
"additionalProperties": {},
"properties": {
"legalBasis": {
"enum": [
"LEGITIMATE_INTEREST_CLIENT",
"LEGITIMATE_INTEREST_PUB",
"PERFORMANCE_OF_CONTRACT",
"CONSENT_WITH_NOTICE",
"CONSENT_WITH_NOTICE_AND_OPT_OUT"
],
"type": "string"
},
"legalBasisExplanation": {
"type": "string"
},
"status": {
"enum": [
"SUBSCRIBED",
"UNSUBSCRIBED",
"NOT_OPTED"
],
"type": "string"
},
"subscriptionId": {
"type": "string"
}
},
"required": [
"subscriptionId",
"status"
],
"type": "object"
},
"subscriptionId": {
"type": "string"
}
},
"required": [
"contactId",
"subscriptionId",
"preferences"
],
"type": "object"
}