User
Communication Preferences
What Cloudflare is allowed to email the authenticated user about, and in which language.
What Cloudflare is allowed to email the authenticated user about, and in which language.
Get
Get the communication preferences of the authenticated user.
Includes email verification status, marketing opt-in state and the language locale.
php
$response = $client->user()->communicationPreferences()->get();
Update
Update the communication preferences of the authenticated user.
Only the preferences named are changed, and email verification settings are not touched by this endpoint at all.
$client->user()->communicationPreferences()->update([
'preferences' => ['marketing' => true],
'language-locale' => 'en-US',
]);
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
values | array | Yes | `preferences`, a map of preference key to subscription state, and `language-locale`, one of `en-US`, `es-ES`, `de-DE`, `fr-FR`, `it-IT`, `ja-JP`, `ko-KR`, `pt-BR`, `zh-CN` or `zh-TW`. Omitting the locale leaves it unchanged. |
php
$response = $client->user()->communicationPreferences()->update([]);