API Reference
Log In
API Reference

Send notification

Send a push notification to targeted users.

Body Params

Notification payload containing title, body and action details.

Request payload for sending a notification.

string
required

Title of the notification.

string
required

Body text of the notification.

string
enum
required

Type of action to perform when the notification is interacted with.

Allowed:
string

URL to open when the action type is OPEN_URL.

string

Phone number to call when the action type is PHONE_CALL.

string

Target user type for the notification. Cannot be combined with email or custom fields.

string

Email address of the target user. Cannot be combined with userType or custom fields.

string

Key of the custom field. Must be provided with customFieldValue and cannot be combined with email or userType.

string

Value for the custom field. Must be provided with customFieldKey and cannot be combined with email or userType.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json