updateCommsPreferences
Update the comms preferences of the account user (the authenticated user).
Arguments
Returns
UpdateAccountUserCommsPreferencesMutationPayloadUpdate the comms preferences of the account user (the authenticated user).
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can edit customer marketing preferenceQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
updateCommsPreferences(input: $input) {
clientMutationId
commsPreferences {
...AccountUserCommsPreferencesFragment
}
emailFormat
errors {
...ErrorTypeFragment
}
fontSizeMultiplier
isOptedInMeterReadingConfirmations
isOptedInToClientMessages
isOptedInToOfferMessages
isOptedInToRecommendedMessages
isOptedInToSmsMessages
isOptedInToThirdPartyMessages
isOptedInToUpdateMessages
isUsingInvertedEmailColours
preferredHoldMusic
}
}
Variables
{
"input": UpdateAccountUserCommsPreferencesMutationInput
}
Response
{
"data": {
"updateCommsPreferences": {
"clientMutationId": "91249070",
"commsPreferences": AccountUserCommsPreferences,
"emailFormat": "recently-point-wide-toward-natural",
"errors": [ErrorType],
"fontSizeMultiplier": 551.25,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToSmsMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInToUpdateMessages": true,
"isUsingInvertedEmailColours": true,
"preferredHoldMusic": "Republican-movie-turn-audience-environment"
}
}
}