> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Create notification

> Send a push notification to users in an experience or company team. The notification is processed asynchronously and supports targeting specific users.

> [!NOTE]
>
> This page documents the Legacy API. For new integrations, use [Send Notification](https://docs.whop.com/api-reference/notifications/send-notification.md) in the Current API.

Required permissions:

* `notification:create`


## OpenAPI

````yaml /openapi/api-v1-stable.json post /notifications
openapi: 3.1.0
info:
  description: >-
    The Whop REST API. Please see
    https://docs.whop.com/developer/api/getting-started for more details.
  termsOfService: https://whop.com/tos-developer-api/
  title: Whop API
  version: 1.0.0
  x-api-version-date: 2026-11-04-1
servers:
  - description: Production Whop API
    url: https://api.whop.com/api/v1
  - description: Sandbox Whop API
    url: https://sandbox-api.whop.com/api/v1
security: []
tags:
  - description: Products
    name: Products
  - description: Payments
    name: Payments
  - description: Refunds
    name: Refunds
  - description: Disputes
    name: Disputes
  - description: Dispute alerts
    name: Dispute alerts
  - description: Resolution center cases
    name: Resolution center cases
  - description: Checkout configurations
    name: Checkout configurations
  - description: Setup intents
    name: Setup intents
  - description: Payment methods
    name: Payment methods
  - description: Invoices
    name: Invoices
  - description: Promo codes
    name: Promo codes
  - description: Card transactions
    name: Card transactions
  - description: Ledger accounts
    name: Ledger accounts
  - description: Withdrawals
    name: Withdrawals
  - description: Payout methods
    name: Payout methods
  - description: Verifications
    name: Verifications
  - description: Identity profiles
    name: Identity profiles
  - description: Payout accounts
    name: Payout accounts
  - description: Topups
    name: Topups
  - description: Companies
    name: Companies
  - description: Authorized users
    name: Authorized users
  - description: Fee markups
    name: Fee markups
  - description: Members
    name: Members
  - description: Memberships
    name: Memberships
  - description: Leads
    name: Leads
  - description: Entries
    name: Entries
  - description: Shipments
    name: Shipments
  - description: Reviews
    name: Reviews
  - description: Company token transactions
    name: Company token transactions
  - description: Affiliates
    name: Affiliates
  - description: Experiences
    name: Experiences
  - description: Forums
    name: Forums
  - description: Forum posts
    name: Forum posts
  - description: Chat channels
    name: Chat channels
  - description: Support channels
    name: Support channels
  - description: Messages
    name: Messages
  - description: Reactions
    name: Reactions
  - description: Dm members
    name: Dm members
  - description: Dm channels
    name: Dm channels
  - description: Notifications
    name: Notifications
  - description: Courses
    name: Courses
  - description: Course chapters
    name: Course chapters
  - description: Course lessons
    name: Course lessons
  - description: Course students
    name: Course students
  - description: Course lesson interactions
    name: Course lesson interactions
  - description: Apps
    name: Apps
  - description: Webhooks
    name: Webhooks
  - description: App builds
    name: App builds
  - description: Access tokens
    name: Access tokens
  - description: Account links
    name: Account links
  - description: Files
    name: Files
  - description: Ai chats
    name: Ai chats
  - description: Bounties
    name: Bounties
  - description: Stats
    name: Stats
  - description: Conversions
    name: Conversions
  - description: Ad reports
    name: Ad reports
paths:
  /notifications:
    post:
      tags:
        - Notifications
      summary: Create notification
      description: >-
        Send a push notification to users in an experience or company team. The
        notification is processed asynchronously and supports targeting specific
        users.


        Required permissions:
         - `notification:create`
      operationId: createNotification
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              description: Parameters for SendNotificationV2
              oneOf:
                - description: Autogenerated input type of SendNotificationV2
                  properties:
                    account_id:
                      description: >-
                        The unique identifier of the company to target. Only
                        team members of this company will receive the
                        notification. Clicking the notification opens your
                        dashboard app view.
                      example: biz_xxxxxxxxxxxxxx
                      type: string
                    content:
                      description: >-
                        The main body text of the notification displayed to the
                        user.
                      type: string
                    icon_user_id:
                      description: >-
                        The unique identifier of a user whose profile picture
                        will be used as the notification icon. Defaults to the
                        experience or company avatar when not provided.
                      type:
                        - string
                        - 'null'
                    rest_path:
                      description: >-
                        A path segment appended to the generated deep link that
                        opens your app. Use [restPath] in your app path
                        configuration to read this parameter. For example,
                        '/settings/billing'.
                      type:
                        - string
                        - 'null'
                    subtitle:
                      description: >-
                        An optional secondary line of text displayed below the
                        title in the notification.
                      type:
                        - string
                        - 'null'
                    title:
                      description: >-
                        The headline text of the notification, displayed
                        prominently to the user.
                      type: string
                    user_ids:
                      description: >-
                        An optional list of user IDs to narrow the audience.
                        When provided, only these users receive the
                        notification, provided they are in the targeted
                        experience or company.
                      items:
                        description: >-
                          Represents a unique identifier that is Base64
                          obfuscated. It is often used to refetch an object or
                          as key for a cache. The ID type appears in a JSON
                          response as a String; however, it is not intended to
                          be human-readable. When expected as an input type, any
                          string (such as `"VXNlci0xMA=="`) or integer (such as
                          `4`) input value will be accepted as an ID.
                        type: string
                      type:
                        - array
                        - 'null'
                  required:
                    - content
                    - title
                    - account_id
                  title: SendNotificationV2InputWithCompanyId
                  type: object
                - description: Autogenerated input type of SendNotificationV2
                  properties:
                    content:
                      description: >-
                        The main body text of the notification displayed to the
                        user.
                      type: string
                    experience_id:
                      description: >-
                        The unique identifier of the experience to target. All
                        users with access to this experience will receive the
                        notification. Clicking the notification opens the
                        experience view.
                      example: exp_xxxxxxxxxxxxxx
                      type: string
                    icon_user_id:
                      description: >-
                        The unique identifier of a user whose profile picture
                        will be used as the notification icon. Defaults to the
                        experience or company avatar when not provided.
                      type:
                        - string
                        - 'null'
                    rest_path:
                      description: >-
                        A path segment appended to the generated deep link that
                        opens your app. Use [restPath] in your app path
                        configuration to read this parameter. For example,
                        '/settings/billing'.
                      type:
                        - string
                        - 'null'
                    subtitle:
                      description: >-
                        An optional secondary line of text displayed below the
                        title in the notification.
                      type:
                        - string
                        - 'null'
                    title:
                      description: >-
                        The headline text of the notification, displayed
                        prominently to the user.
                      type: string
                    user_ids:
                      description: >-
                        An optional list of user IDs to narrow the audience.
                        When provided, only these users receive the
                        notification, provided they are in the targeted
                        experience or company.
                      items:
                        description: >-
                          Represents a unique identifier that is Base64
                          obfuscated. It is often used to refetch an object or
                          as key for a cache. The ID type appears in a JSON
                          response as a String; however, it is not intended to
                          be human-readable. When expected as an input type, any
                          string (such as `"VXNlci0xMA=="`) or integer (such as
                          `4`) input value will be accepted as an ID.
                        type: string
                      type:
                        - array
                        - 'null'
                  required:
                    - content
                    - title
                    - experience_id
                  title: SendNotificationV2InputWithExperienceId
                  type: object
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                description: Response from queuing a notification
                properties:
                  success:
                    description: >-
                      Whether the notification was successfully queued for
                      delivery
                    type: boolean
                required:
                  - success
                type: object
          description: A successful response
        '400':
          content:
            application/json:
              example:
                error:
                  code: parameter_missing
                  message: 'Missing required parameter: amount.'
                  param: amount
                  type: invalid_request_error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Bad request
        '401':
          content:
            application/json:
              example:
                error:
                  message: Invalid or missing API key
                  type: unauthorized
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                error:
                  message: You do not have permission to access this resource
                  type: forbidden
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                error:
                  message: Resource not found
                  type: not_found
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Not found
        '422':
          content:
            application/json:
              example:
                error: null
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Verification required
        '429':
          content:
            application/json:
              example:
                error: null
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Too many requests
        '500':
          content:
            application/json:
              example:
                error:
                  message: An unexpected error occurred
                  type: internal_server_error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                        type:
                          - string
                          - 'null'
                      message:
                        type: string
                      param:
                        description: The parameter that caused the error, if applicable
                        type:
                          - string
                          - 'null'
                      type:
                        type: string
                    required:
                      - type
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Internal server error
      security:
        - bearerAuth:
            - notification:create
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: auth-scheme
      description: >-
        An Account API key, account-scoped JWT, App API key, or user OAuth
        token. Prepend the key or token with `Bearer`, for example `Bearer
        ***************************`.
      scheme: bearer
      type: http

````

## Related topics

- [Create Webhook](https://docs.whop.com/api-reference/webhooks/create-webhook.md)
- [Push Notifications](https://docs.whop.com/developer/guides/notifications.md)
- [Notification](https://docs.whop.com/api-reference/notifications/notification.md)
