AppBanner1

Channel_Events2

Channel_segments6

Channel_tags9

Channel_topics3

Channels18

Chat2

Class_definitions1

Deep_Links5

Email3

Email_accounts4

Email_templates3

Link_Statistics1

Notification_groups2

Notification_templates4

Notifications16

Projects4

Shortlinks3

SMS_providers4

Subscriptions19

Survey1

Teams2

WebBanner6

Whatsapp1

Notifications

SendNotification

Create notification

post/notification/send

Request body

channelIdstring required

The channel ID.

titlestring

The notification title (subject for email channels).

textstring

The notification text (HTML body for email channels). For custom HTML newsletters, embed AD SLOT placeholders as merge tags: <code>{{adSlot_<slotId>}}</code> where <code>slotId</code> is the EmailAdSlots document ID (e.g. <code>{{adSlot_xYz123AbC}}</code>). Placeholders are resolved with configured ad campaign content at send time.

urlstring

The notification URL.

iconUrlstring

The notification's icon.

mediaUrlstring

The notification's large media/image.

fetchMediaUrlboolean

Fetches a mediaUrl from the provided url if no mediaUrl is provided.

scheduledAtnumber

A unix timestamp for scheduling notifications (must be in the future).

expiresAtHoursnumber

Hours after the notification will expire.

expiresAtMinutesnumber

Alternatively: Minutes after the notification will expire.

balancedDeliveryTypestring

Evenly distribute delivery type, can be 'balancedDeliveryMinutes' or 'balancedDeliverySendings'

balancedDeliveryMinutesnumber

Evenly distribute delivery in these minutes instead of sending to all subscriptions instantly.

balancedDeliverySendingsnumber

Distribute delivery in specified number per minute instead of sending to all subscriptions instantly.

customDataobject

Custom data payload which will be sent to the devices.

subscriptionIdstring

The subscription ID(s) (string or alternatively an array of strings). Will broadcast to all subscriptions if not given. If an array is provided, the maximum amount of items in this array is 50000.

testSubscriptionsboolean

If true, will ignore other targeting settings and only send to defined test subscriptions.

customAttributesobject

Targeting: An object of custom attributes to filter subscriptions (e.g.: { user_id: 123 } OR { user_id: [123, 124] }). Will broadcast to all subscriptions if not given.

tagsstring[]

Targeting: array of tag IDs.

tagsLogicstring

One of: 'and', 'or', default: 'or'

excludeTagsstring[]

Targeting: array of tag IDs.

externalTagsstring[]

Targeting: array of tag IDs.

excludeExternalTagsstring[]

Targeting: array of tag IDs.

topicsstring[]

Targeting: array of topic IDs.

topicsLogicstring

One of: 'and', 'or', default: 'or'

excludeTopicsstring[]

Targeting: array of topic IDs.

excludeTopicsLogicstring

One of: 'and', 'or', default: 'or'

segmentsstring[]

Targeting: array of segment IDs.

segmentsLogicstring

One of: 'and', 'or', default: 'or'

excludeSegmentsstring[]

Targeting: array of segment IDs.

excludeSegmentsLogicstring

One of: 'and', 'or', default: 'or'

platformstring[]

Targeting: array of platform names (case-sensitive, e.g. "Android", "Mac OS", ..).

platformLogicstring

One of: 'include', 'exclude', default: 'include'

browserstring[]

Targeting: array of browser names (case-sensitive, e.g. "Chrome", "Firefox", ..).

browserLogicstring

One of: 'include', 'exclude', default: 'include'

countrystring[]

Targeting: array of country IDs (e.g. "US", "DE", ..).

countryLogicstring

One of: 'include', 'exclude', default: 'include'

languagestring[]

Targeting: array of language IDs (e.g. "en", "de", ..).

languageLogicstring

One of: 'include', 'exclude', default: 'include'

actionsstring[]

Array of action objects: { title, url, [icon] }.

groupsstring[]

Array of notification group ids. Used for e.g. tracking similar notifications.

clickAssignTagsstring[]

Array of notification tag ids, which are automatically assigned to subscriptions when the notification has been clicked.

clickAssignTopicsstring[]

Array of notification topic ids, which are automatically assigned to subscriptions when the notification has been clicked.

socialSharingActionsboolean

Use pre-defined social sharing actions. Hint: 'actions' will be ignored if 'socialSharingActions' is given.

autoHideboolean

Automatically hide notification after approx. 20 seconds (only available for Web Push)

bounceUrlstring

Set a bounce URL for this notification

campaignIdstring

Campaign id for later analysis

externalCampaignIdstring

External campaign id. If provided, will find or create a NotificationCampaign by externalId and channel. If campaign exists, its _id will be used as campaignId. If not, a new campaign will be created with the provided campaignName (or externalCampaignId as fallback).

campaignNamestring

Campaign name for later analysis

categorystring

Android Notification Category ID

transactionalboolean

Tags the notification as transactional message, just used for filtering in the backoffice

breakingNewsboolean

Marks the notification as breaking news (bypasses daily/hourly per-subscription push limits, higher queue priority on Enterprise). Requires a plan with breaking news enabled. Ignored otherwise.

translationsEnabledboolean

Enable per-language notification content. With A/B testing, translations belong on each variant (Notification → A/B variant → translations).

abTestingboolean

Optionally enable A/B testing

abTestingAutoCompareboolean

Optionally compares the best notification after 30 minutes and sends the best result to the rest

abTestingPercentnumber

A/B test percentage (0 to 100)

machineLearningboolean

Optionally enable machine learning (available for Enterprise plans).

machineLearningMinimumPercentagenumber

Minimum percentage of total subscriptions to send to if the ML algorithm does not find enough subscriptions (rest of the subscriptions are filled up).

walletPassstring

Optionally set Wallet Pass ID

silentboolean

Set this to true if you want to send a silent notification (only available for App Push)

soundFilenamestring

Optionally set iOS sound filename

soundVolumenumber

Optionally set iOS sound volume (0.0 to 1.0)

soundCriticalboolean

Optionally set iOS sound critical (warning: only for pre-approved apps, see: https://developer.apple.com/contact/request/notifications-critical-alerts-entitlement/)

bestDeliveryTimeboolean

Enables the optimal delivery time for this message (will deliver 7 days by default, set bestDeliveryTime24Hours: true to send for 24 hours only)

bestDeliveryTime24Hoursboolean

Enables the optimal delivery time for 24 hours (bestDeliveryTime needs to be true for this to work)

prioritystring

Optionally set priority. Possible values: "high" or "normal". Defaults to "high".

templateIdstring

Set the Notification / Email Template ID instead of using "text" for specifiy the content

additionalAttributesobject

Provide additional attributes for each subscription, that will be replaced as placeholders automatically (e.g. { "XXXXXXX1": { "first_name": "John" }, "XXXXXXX2": { "first_name": "Sam" } }). The keys of this object represent the Subscription ID's by default. You can also use an indexed custom attribute for this (e.g. "user_id"), by specifying the parameter "additionalAttributesKey". Only available for transactional notifications. Max. subscriptions per request: 5000.

additionalAttributesKeystring

When using "additionalAttributes", the keys of this object represent the Subscription ID's by default. You can specify a indexed custom attribute for this here (e.g. "user_id"). Only available for transactional notifications.

emailNewsletterboolean

Optionally set this to true to send email newsletters. Use "title" for the email subject and "text" for the HTML content.

emailContentTypestring

Email content type for custom HTML newsletters. Use <code>"html"</code> when sending custom HTML via <code>text</code>.

emailAccountstring

Set the Email Account ID

emailSenderNamestring

Set the Email Sender Name

emailRecipientstring

Transactional Emails: Specify the recipient's email address(es) (string or alternatively an array of strings) instead of using a subscriptionId

smsProviderstring

Set the SMS Provider ID

phoneNumberstring

Transactional SMS: Specify the recipient's phone number(s) (string or alternatively an array of strings) in E.164 format instead of using a subscriptionId

subscriptionAttributesobject

Transactional Emails/SMS: When using Emails with templateId: Specify the subscription's custom attributes which will be replaced as variables in the template fields.

collapseKeystring

Multiple notifications with the same collapse key will be automatically replaced.

threadIdstring

Multiple notifications with the same thread ID will be automatically grouped together. (Supported only for iOS right now)

interruptionLevelstring

Interruption levels indicate the priority and delivery timing of a notification, to 'interrupt' the user. Up until iOS 15, Apple primarily focused on Critical notifications. Now they have expanded this to include the following four levels: ['active', 'passive', 'time-sensitive', 'critical'].

relevanceScorestring

A Relevance Score is a score to be set per notification to indicate how it should be displayed when grouped. The system uses the relevance score, a value between 0 and 1, to sort the notifications from your app. The highest score gets featured in the notification summary. This was introduced in iOS15+. Expected values [0, 0.75, 0.5, 0.25, 1]

whatsappTemplateNamestring

Name of the WhatsApp Template (required when channel type is Whatsapp)

externalIdstring

Used for checking for API notification duplicates internally when the corresponding setting is enabled in the channel settings.

iosCategoryobject

iOS notification category, which is available as categoryIdentifier in the app. It will not work together with the <code>actions</code> field, as the SDK will then dynamically generate a fitting category to display the notification buttons.

iosLiveActivityContentStateobject

iOS Live Activity Content state

iosLiveActivityEventstring

iOS Live Activity Event ("update", "end")

typestring

Notification type ("iosLiveActivity")

iosLiveActivityDismissalDatestring

ios Live Activity Dismissal Date (Use Epoch Timestamp in string)

appBannerIdstring

App Banner ID If silent:true and the appBannerId is provided, then after the subscriber receives the notification and opens the app, it will show the appbanner

autoHandleDeepLinkboolean

Used for automatic handling of Deep Links (only available for App Push)

chatNotificationboolean

Used for defining notifications as "Chat notification" which will be shown in the ChatView, if used (only available for Web / App Push)

chatMessagestring

Used for defining the message to be shown in the ChatView, if used (only available for Web / App Push)

testSubscriptionsConsiderTargetingboolean

Test subscriptions will be considered

Response

Error-Response:

errorstring

successboolean required

notificationIdstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.