Send notification

post

https://api.stowlog.com/public/notifications

Send a push notification to targeted users.

Body Params

Notification payload containing title, body and action details.

Request payload for sending a notification.

title

string

required

Title of the notification.

body

string

required

Body text of the notification.

actionType

string

enum

required

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

Allowed:

actionUrl

string

URL to open when the action type is OPEN_URL.

actionPhoneNumber

string

Phone number to call when the action type is PHONE_CALL.

userType

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.

customFieldKey

string

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

customFieldValue

string

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

username

string

Username of the target user. Cannot be combined with email or custom fields.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Notification sent successfully.

400The request parameters are invalid.

401Unauthorized access.

403Insufficient permissions to perform this operation.

429Rate limit exceeded.