Notifications
Send a Notification
- Overview
Companies
Experiences
Memberships
Products
Payments
Reviews
Notifications
Line Items
App Connections
Users
Billing Usages
- GETRetrieve the current app
- GETCheck Access
- Overview
Memberships
Products
Payments
Reviews
Experiences
Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Apps
Me
Notifications
Send a Notification
Sends a notification to a user
POST
/
v5
/
app
/
notifications
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
object
*
topic_identifier
string
*
topic_identifier
Required
string
deep_link
string
deep_link
string
target_app_view
string
target_app_view
string
targets
array
*
targets
Required
array
notification_data
object
*
notification_data
Required
object
in_app
object
in_app
object
subject
string
*
subject
Required
string
content
string
*
content
Required
string
mobile
object
mobile
object
subject
string
*
subject
Required
string
content
string
*
content
Required
string
all
object
all
object
subject
string
*
subject
Required
string
content
string
*
content
Required
string
curl --request POST \
--url https://api.whop.com/api/v5/app/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"topic_identifier": "<string>",
"deep_link": "<string>",
"target_app_view": "<string>",
"targets": [
{
"users": [
"<string>"
],
"experiences": [
"<string>"
],
"products": [
"<string>"
],
"companies": [
"<string>"
]
}
],
"notification_data": {
"in_app": {
"subject": "<string>",
"content": "<string>"
},
"mobile": {
"subject": "<string>",
"content": "<string>"
},
"all": {
"subject": "<string>",
"content": "<string>"
}
}
}'
{
"status": "created",
"message": "We will attempt to send out your notification. This is processed in a background job, so we cannot confirm how many notifications were sent in this request."
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
topic_identifier
string
requireddeep_link
string
target_app_view
string
default: customer_product_viewtargets
object[]
requiredtargets.users
string[]
targets.experiences
string[]
targets.products
string[]
targets.companies
string[]
notification_data
object
requirednotification_data.in_app
object
notification_data.in_app.subject
string
requirednotification_data.in_app.content
string
requirednotification_data.mobile
object
notification_data.mobile.subject
string
requirednotification_data.mobile.content
string
requirednotification_data.all
object
notification_data.all.subject
string
requirednotification_data.all.content
string
requiredResponse
201 - application/json
status
string
message
string
Was this page helpful?
curl --request POST \
--url https://api.whop.com/api/v5/app/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"topic_identifier": "<string>",
"deep_link": "<string>",
"target_app_view": "<string>",
"targets": [
{
"users": [
"<string>"
],
"experiences": [
"<string>"
],
"products": [
"<string>"
],
"companies": [
"<string>"
]
}
],
"notification_data": {
"in_app": {
"subject": "<string>",
"content": "<string>"
},
"mobile": {
"subject": "<string>",
"content": "<string>"
},
"all": {
"subject": "<string>",
"content": "<string>"
}
}
}'
{
"status": "created",
"message": "We will attempt to send out your notification. This is processed in a background job, so we cannot confirm how many notifications were sent in this request."
}