Skip to main content
POST
/
notifications
Create notification
curl --request POST \
  --url https://api.whop.com/api/v1/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "company_id": "biz_xxxxxxxxxxxxxx",
  "user_ids": [
    "<string>"
  ],
  "content": "<string>",
  "icon_user_id": "<string>",
  "subtitle": "<string>",
  "title": "<string>",
  "rest_path": "<string>"
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Body

application/json
  • SendNotificationV2InputWithCompanyId
  • SendNotificationV2InputWithExperienceId

Parameters for SendNotificationV2 Autogenerated input type of SendNotificationV2

​
company_id
string
required

The id of the company to target. Only team members of this company will receive the notification. When clicked will take the user to your dashboard app view.

Example:

"biz_xxxxxxxxxxxxxx"

​
content
string
required

The content of the notification

​
title
string
required

The title of the notification

​
user_ids
string[] | null

If provided, this will only send to these users if they are also in the main scope (experience or company)

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.

​
icon_user_id
string | null

Optional: ID of a Whop user whose profile picture will be used as the notification icon. If not provided, defaults to the experience or company avatar.

​
subtitle
string | null

The subtitle of the notification

​
rest_path
string | null

The rest path to append to the generated deep link that opens your app. Use [restPath] in your app path in the dashboard to read this parameter.

Response

A successful response

Response from queuing a notification

​
success
boolean
required

Whether the notification was successfully queued for delivery