Docs

Send a Single Push Notification

Sends a single push notification with Routee.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Body

Arguments
stringrequired

There should be an implementation with the particular id that belongs to the accountId. Not blank.

objectrequired

Device token. It is used to identify a specific device.

stringrequired

Device token type: ANDROID, APPLE, WEB.

stringrequired

Not blank.

object

The notification's body which contains the following fields: title, text, forceLocale.

object

The notification's title. Map: (Key) not blank, language - ISO 639-1; (Value) not blank.

object

The notification's text. Map: (Key) not blank, language - ISO 639-1; (Value) not blank.

string

Localization settings. Switches body.title and body.text to the selected language; body.title and body.text should contain an entry with forceLocale as their key. Not null, language - ISO 639-1.

string

URL that should begin with https://

object

Device-specific parameters (Android).

string

The action associated with a user click on the notification.

string

The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest.

string

The key to the title string in the app's string resources to use to localize the title text to the user's current localization. Example: NOTIFICATION_TITLE.

string

The key to the body string in the app's string resources to use to localize the body text to the user's current localization. Example: NOTIFICATION_MESSAGE.

number

In seconds. Min: 0. Max: 2.419.200. Default: same as Firebase (current: 2.419.200).

object

Device-specific parameters (iOS).

string

The key for a localized title string. Specify this key instead of the title key to retrieve the title from your app's Localizable.strings files. The value must contain the name of a key in your strings file.

string

The key for a localized message string. Use this key, instead of the body key, to retrieve the message text from your app's Localizable.strings file. The value must contain the name of a key in your strings file.

number

In seconds. Min: 0. Max: 2.419.200. Default: same as Firebase (current: 2.419.200).

object

Device-specific parameters (web).

string

URL that should begin with https://

string

URL that should begin with https://

object

This parameter specifies the custom key-value pairs of the message's payload. For example, with data:{"score":"3x1"}: On Apple platforms, if the message is sent via APNs, it represents the custom data fields. If it is sent via FCM, it would be represented as key value dictionary in AppDelegate application:didReceiveRemoteNotification:. On Android, this would result in an intent extra named score with the string value 3x1. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm"). Values should be string type.

string

Not blank.

string

Not blank.

string

URL that should begin with https://

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.