PUT /user/communication_preferences
Set one or more communication preferences for the authenticated user. Supply a map of preference keys to subscription states, and an optional language locale. This endpoint does not modify email verification settings. Callers authenticate with standard Cloudflare API tokens or keys.
Servers
- https://api.cloudflare.com/client/v4
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
language-locale |
String | No |
The user's preferred language locale for communications. If omitted, the language locale does not change. Valid values:
|
preferences |
Object | No |
Preference keys mapped to subscription states to update. Only the preferences in this map change; others remain unchanged. |
preferences.name |
Object | No | |
preferences.name.subscribed |
Boolean | Yes |
Whether to subscribe or unsubscribe from this communication type. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.