Skip to content

Update notification settings

Turns notification types on or off, for the notifications list and browser push alike.

Needs the profile:write scope.

Call

  • Tool: update_notification_settings
  • Scope: profile:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
types object Yes Each type to turn on (true) or off (false); a type left out keeps its setting.
{
  "type": "object",
  "properties": {
    "types": {
      "description": "Each type to turn on (true) or off (false); a type left out keeps its setting.",
      "type": "object",
      "properties": {
        "portfolio_trade": {
          "type": "boolean"
        },
        "new_lesson": {
          "type": "boolean"
        },
        "new_episode": {
          "type": "boolean"
        },
        "new_post": {
          "type": "boolean"
        },
        "new_file": {
          "type": "boolean"
        },
        "new_product": {
          "type": "boolean"
        },
        "new_discount": {
          "type": "boolean"
        },
        "event_reminder": {
          "type": "boolean"
        },
        "event_follow_up": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "types"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
types array of object Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close