Skip to main content
POST
Send a push notification to mobile-app users

Authorizations

x-organization-id
string
header
required

Your SmartSend Organization ID. Required on every request.

Body

application/json
recipientType
enum<string>
required

How to resolve the target users

Available options:
user,
organization,
phone
title
string
required

Notification title (capped to 200 chars)

body
string
required

Notification body (capped to 1000 chars)

userId
string

Required when recipientType is "user" (from /rpc/users)

phoneNumber
string

Required when recipientType is "phone". Any format (972..., 05..., +972...)

sound
enum<string>

Sound to play. Defaults to "default".

Available options:
default,
cash
respectPreferences
boolean

When true (default), apply the recipient's NotificationPreference filter (enabled, active hours, assigned-only).

Response

Push notification queued

success
boolean
data
object