Update communication preferences

Required Scopes: COMMUNICATION_PREFERENCES_WRITE

Update communication preferences for a customer

SecurityApiKeyAuth

Request

customerId

required

integer <int64>

The ID of the customer

Array

messageCategory

string

The message category of the communication preference

Enum:	Description
APPOINTMENT	The message category is appointment related
NEWSLETTER	The message category is newsletter related
CONTRACT	The message category is contract related
LOYALTY_PROGRAM	The message category is loyalty program related
GENERAL	The message category is general

Array of objects (CommunicationChannelWrapper)

The communication channels related to the message category of the communication preference

Responses

200

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

put/v1/communications/{customerId}/communication-preferences

Request samples

application/json

[{"messageCategory": "CONTRACT",
"channels": [{"communicationChannel": "EMAIL",
"customerOverridable": true,
"active": true
}
]
}
]

Response samples

application/json

[{"messageCategory": "CONTRACT",
"channels": [{"communicationChannel": "EMAIL",
"customerOverridable": true,
"active": true
}
]
}
]