Notifications
Create a Notification Request
API Documentation
Apps
- Overview
- Companies
- Experiences
- Members
- Memberships
- Products
- Payments
- Reviews
- Notifications
- Line Items
- App Connections
- Users
- Feed Content Items
- Inbound Webhooks
- Inbound Webhook Filters
- GETRetrieve the current app
- GETCheck Access
Company
- Overview
- Memberships
- Products
- Payments
- Reviews
- Users
- GETRetrieve the current company
Me
- Overview
- Memberships
- Products
- Payments
- Reviews
- Experiences
- Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Chat
- Webhooks
Notifications
Create a Notification Request
Send a notification to a set of targets
POST
/
v5
/
app
/
notification_requests
curl --request POST \
--url https://{defaultHost}/v5/app/notification_requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"body": {
"title": "<string>",
"subtitle": "<string>",
"content": "<string>"
},
"topics": [
{
"topic_identifier": "<string>",
"users": [
"<string>"
]
}
],
"sender_user_id": "<string>",
"external_id": "<string>",
"link": "<string>",
"rest_path": "<string>",
"target": {
"experience": "<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
App API key for /v5/app and /v5/company endpoints
Body
application/json
Response
201
application/json
notification request created
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://{defaultHost}/v5/app/notification_requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"body": {
"title": "<string>",
"subtitle": "<string>",
"content": "<string>"
},
"topics": [
{
"topic_identifier": "<string>",
"users": [
"<string>"
]
}
],
"sender_user_id": "<string>",
"external_id": "<string>",
"link": "<string>",
"rest_path": "<string>",
"target": {
"experience": "<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."
}