VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Analytics
Event capture
Create Notification

Create Notification

POST
/api/v1/notifications

Header Parameters

idempotency-key?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId?string|null
personIds?array<string>|null
distinctIds?array<string>|null
title*string
Length1 <= length
body*string
Length1 <= length
data?|null
sound?string|null
badge?number||null
priority?|null
ttl?number||null
channelId?string|null
collapseId?string|null
idempotencyKey?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/notifications" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "body": "string"  }'
{  "pushNotificationSendId": "string",  "deviceCount": 0,  "status": "pending",  "unresolvedDistinctIds": [    "string"  ]}
{  "_tag": "Api/PushDeviceValidationError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/PushSendNotEnabledError",  "message": "string"}
{  "_tag": "Api/AuthServiceError",  "cause": "string",  "message": "string"}
PreviousList Notification Send DeliveriesNextCreate Organization