Notification Preferences Api Service

Toggle the global email opt-out flag

put/v2/settings/users/{userId}/notification-preferences/email-global

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/settings/users/{userId}/notification-preferences/email-global
  • Auth: none declared

Path parameters

userIdinteger required

Authenticated user id

Request body

emailGloballyOffboolean required

When true, all EMAIL channel notifications are disabled regardless of per-event overrides

Example request

{
  "emailGloballyOff": true
}

Response

Resolved notification preferences matrix after the update

metadataobject

Example response

{
  "data": {
    "events": [
      {
        "event": "postError",
        "channels": [
          {
            "channel": "email",
            "enabled": true
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.