Users

Set

Changed on

Sets the authenticated user's notification preferences, each addressed by scope rather than by ID. The batch is applied in one transaction: if any entry is rejected, none are written. Experience levels are applied before topic overrides, because setting a level replaces every topic preference for that experience, so an override sent alongside a level wins. The response reports what each scope now resolves to, in the order the entries were sent.

patch/users/me/preferences/notifications

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/users/me/preferences/notifications
  • Auth: HTTP bearer

Request body

Example request

{
  "preferences": [
    {
      "level": "nothing",
      "scope": {
        "account_id": "biz_xxxxxxxxxxxxxx",
        "channel": "in_app",
        "experience_id": "exp_xxxxxxxxxxxxxx",
        "team_account_id": "biz_xxxxxxxxxxxxxx",
        "topic_id": "topic_xxxxxxxxxxxxxx"
      }
    }
  ]
}

Response

preferences set

Example response

{
  "data": [
    {
      "level": "nothing",
      "object": "notification_preference",
      "scope": {
        "account_id": "biz_xxxxxxxxxxxxxx",
        "channel": "in_app",
        "experience_id": "exp_xxxxxxxxxxxxxx",
        "team_account_id": "biz_xxxxxxxxxxxxxx",
        "topic_id": "topic_xxxxxxxxxxxxxx"
      }
    }
  ]
}

Changes

  • f1020c3ecda4Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • bdd0e2c70d58Revision changes
    • info

      the security scope user:notifications:update was added to the endpoint's security scheme bearerAuth