DokumentationEngagement Platform API
Sign inGet started
Guides
API

Programmable Push Notifications

Sending push notifications

In order to send a push notification, you must have an active Push Notifications channel installed in your workspace with valid credentials for the gateway(s) you intend to use (Firebase Cloud Messaging for Android, APNs for iOS, or VAPID for Web Push). Send a push by performing an HTTP request to the channel's messages endpoint with a valid access key.

Send a message

POST
/workspaces/{workspaceId}/channels/{channelId}/messages
Send a message to a channel
Anfrage-Payload
sender
object
Untergeordnete Parameter anzeigen
sender.connector
object
erforderlich
The sender of the message. For email messages, the sender is used to override the default sender username.
Untergeordnete Parameter anzeigen
sender.connector.identifierValue
string
erforderlich
The identifier value of the sender.
sender.connector.annotations
object
Annotations are used to add additional information to a message. For email messages, it can be used to specify a custom sender name.
Untergeordnete Parameter anzeigen
sender.connector.annotations.name
string
receiver
object
erforderlich
Untergeordnete Parameter anzeigen
receiver.contacts
array of object
Untergeordnete Parameter anzeigen
receiver.contacts.id
string
The ID of the receiver. This is a reference to a contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact. For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID without needing to know the channel's portfolio ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.type
string
The type of the receiver.
Possible values: cc, bcc, to
receiver.contacts.identifiers
array of object
Untergeordnete Parameter anzeigen
receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The value that is used to send the message to the platform.
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address (e.g. phone number or email address) from a contact. This is an optional override for the default resolution logic (i.e. sending to the first identifier key-value pair for the relevant platform).
reference
string
A reference to the message. This can be used to identify the message in the channel.
template
object
erforderlich
Untergeordnete Parameter anzeigen
template.name
string
The platform name of the template.
template.projectId
string
the ID of the project from the project from Studio
template.version
string
The version of the template.
template.locale
string
template.attachments
array of object
Untergeordnete Parameter anzeigen
template.attachments.mediaUrl
string
erforderlich
The URL of the attachment.
template.attachments.filename
string
erforderlich
The filename of the attachment.
template.attachments.inline
boolean
template.shortLinks
object
SMS link shortening options.
Untergeordnete Parameter anzeigen
template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Untergeordnete Parameter anzeigen
template.variables.default
string
template.utmParameters
array of object
The list of UTM parameters.
Untergeordnete Parameter anzeigen
template.utmParameters.key
string
erforderlich
The name of the parameter in the query string.
template.utmParameters.value
string
erforderlich
The static value of the parameter. Mutually exclusive with Reference.
template.parameters
array of object
Untergeordnete Parameter anzeigen
template.parameters.type
string
erforderlich
Possible values: string
template.parameters.key
string
erforderlich
template.parameters.value
string
template.settings
object
Untergeordnete Parameter anzeigen
template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
meta
object
Untergeordnete Parameter anzeigen
meta.extraInformation
object
Free-form metadata. The useCase key (marketing, otp, transactional, or conversation) classifies the message and affects handling such as routing, frequency capping, email deliverability, and the messaging type/tag used on Meta channels (Messenger, Instagram).
meta.referral
object
Untergeordnete Parameter anzeigen
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Untergeordnete Parameter anzeigen
meta.referral.metadata.source_id
string
meta.referral.metadata.source_url
string
meta.referral.metadata.media_url
string
meta.referral.metadata.tracking_id
string
meta.order
object
The order object contains information about the purchase order.
Untergeordnete Parameter anzeigen
meta.order.products
array of object
Untergeordnete Parameter anzeigen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
The platform-specific product ID.
meta.order.products.quantity
integer
The number of items purchased.
meta.order.products.price
object
The price of the product.
Untergeordnete Parameter anzeigen
meta.order.products.price.amount
integer
meta.order.products.price.exponent
integer
meta.order.products.price.currencyCode
string
meta.referredProduct
object
Referred product in an incoming message.
Untergeordnete Parameter anzeigen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Untergeordnete Parameter anzeigen
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Untergeordnete Parameter anzeigen
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Untergeordnete Parameter anzeigen
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.pushNotifications
object
Untergeordnete Parameter anzeigen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Untergeordnete Parameter anzeigen
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Untergeordnete Parameter anzeigen
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Untergeordnete Parameter anzeigen
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Untergeordnete Parameter anzeigen
replyTo.id
string
erforderlich
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
erforderlich
Possible values: message, click, referrals
notification
object
Untergeordnete Parameter anzeigen
notification.url
string
A custom webhook url to send events to. Note: you should have a created webhook subscription. Refer to the Notifications API to learn how to create a webhook subscription.
capFrequency
boolean
If set to true, the frequency capping settings of the platform will be used to either allow or reject the message to a contact. Can only be set to true if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTracking
boolean
If set to true, UTM parameters will be appended to the links in the message. For SMS channels, the shortLinks property must also be included in the request to enable link tracking.
ignoreQuietHours
boolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldout
boolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tags
array of string
Tags to associate with the message. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per message.
shortLinks
object
SMS link shortening options. Must be included in the request for SMS channels when enableLinkTracking is set to true. When using templates, please refer to the template level shortLinks instead.
Untergeordnete Parameter anzeigen
shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
scheduledFor
string
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When set, the message status will be scheduled until it's sent. Messages scheduled for a time in the past or within 10 minutes of the request may be sent immediately. Messages scheduled farther than 35 days will be rejected.
validity
integer
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it. A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
Antwort-Payload
body
object
Untergeordnete Attribute anzeigen
body.text
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions
array of object
Untergeordnete Attribute anzeigen
body.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description.label
string
erforderlich
body.text.actions.link.text
string
erforderlich
body.text.actions.link.url
string
erforderlich
body.text.actions.type
string
erforderlich
Possible values: link
body.text.attachments
array of object
Untergeordnete Attribute anzeigen
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
erforderlich
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
erforderlich
body.text.metadata
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items.emojiId
string
erforderlich
body.text.metadata.line.emoji.items.index
integer
erforderlich
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
erforderlich
body.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
body.text.metadata.paymentDetails.amount
string
erforderlich
body.text.metadata.paymentDetails.currency
string
erforderlich
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
erforderlich
body.text.metadata.subject
string
body.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
erforderlich
body.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
erforderlich
body.type
string
erforderlich
Possible values: text
bodyId
string
bodyStorage
object
Untergeordnete Attribute anzeigen
bodyStorage.type
string
erforderlich
Possible values: s3
bodyStorage.s3
object
erforderlich
Untergeordnete Attribute anzeigen
bodyStorage.s3.bucketArn
string
erforderlich
bodyStorage.s3.encryptionKey
string
erforderlich
bodyStorage.s3.key
string
erforderlich
channelId
string
erforderlich
chargeableUnits
integer
context
object
Untergeordnete Attribute anzeigen
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
erforderlich
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Untergeordnete Attribute anzeigen
failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
failure.description
string
human readable description of the error
failure.source
object
Untergeordnete Attribute anzeigen
failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
id
string
erforderlich
ignorePersistedEventhooks
boolean
lastStatusAt
string
erforderlich
meta
object
Untergeordnete Attribute anzeigen
meta.campaign
object
Untergeordnete Attribute anzeigen
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Untergeordnete Attribute anzeigen
meta.email.from
object
Untergeordnete Attribute anzeigen
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Untergeordnete Attribute anzeigen
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Untergeordnete Attribute anzeigen
meta.formResponse.id
string
erforderlich
meta.formResponse.jsonResponse
string
erforderlich
meta.formResponse.requestIdentifier
string
erforderlich
meta.formResponse.selections
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items.identifier
string
erforderlich
meta.formResponse.selections.items.title
string
erforderlich
meta.formResponse.selections.items.type
string
erforderlich
meta.formResponse.selections.items.value
string
erforderlich
meta.formResponse.selections.pageIdentifier
string
erforderlich
meta.formResponse.selections.subtitle
string
erforderlich
meta.formResponse.selections.title
string
erforderlich
meta.formResponse.sessionIdentifier
string
erforderlich
meta.formResponse.template
string
erforderlich
meta.formResponse.version
string
erforderlich
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Untergeordnete Attribute anzeigen
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Untergeordnete Attribute anzeigen
meta.order.products
array of object
Untergeordnete Attribute anzeigen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
erforderlich
The platform-specific product ID.
meta.order.products.price
object
erforderlich
Untergeordnete Attribute anzeigen
meta.order.products.price.amount
integer
erforderlich
meta.order.products.price.currencyCode
string
erforderlich
meta.order.products.price.exponent
integer
erforderlich
meta.order.products.quantity
integer
erforderlich
The number of items purchased.
meta.pushNotifications
object
Untergeordnete Attribute anzeigen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Untergeordnete Attribute anzeigen
meta.referral.group
string
meta.referral.metadata
object
Untergeordnete Attribute anzeigen
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
erforderlich
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
erforderlich
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Untergeordnete Attribute anzeigen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
erforderlich
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Untergeordnete Attribute anzeigen
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments
array of object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments.id
string
erforderlich
meta.sms.smpp.segments.registeredDelivery
string
erforderlich
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
erforderlich
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Untergeordnete Attribute anzeigen
parts.id
string
parts.order
integer
parts.platformReferenceId
string
parts.platformStatusAt
string
parts.rawBody
string
parts.reason
string
parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
parts.statusAt
string
platformId
string
platformReferenceId
string
previousMessages
array of object
Untergeordnete Attribute anzeigen
previousMessages.id
string
erforderlich
previousMessages.useCaseType
string
erforderlich
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
erforderlich
Untergeordnete Attribute anzeigen
receiver.connector
object
Untergeordnete Attribute anzeigen
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.connector.annotations.name
string
receiver.connector.id
string
erforderlich
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Untergeordnete Attribute anzeigen
receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
receiver.device.id
string
erforderlich
receiver.device.identifierValue
string
erforderlich
receiver.inbox
object
Untergeordnete Attribute anzeigen
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
erforderlich
receiver.inbox.identifierKey
string
erforderlich
receiver.inbox.identifierValue
string
erforderlich
receiver.inbox.type
string
erforderlich
Possible values: user, group
receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
receiver.userContacts.id
string
erforderlich
receiver.userContacts.identifierKey
string
erforderlich
receiver.userContacts.identifierValue
string
erforderlich
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Untergeordnete Attribute anzeigen
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Untergeordnete Attribute anzeigen
schedule.reason
string
erforderlich
schedule.scheduledAt
string
erforderlich
scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
sendAt
string
sender
object
erforderlich
Untergeordnete Attribute anzeigen
sender.connector
object
Untergeordnete Attribute anzeigen
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.connector.annotations.name
string
sender.connector.id
string
erforderlich
sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
sender.connector.types
array of string
sender.contact
object
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation.name
string
sender.contact.countryCode
string
sender.contact.id
string
The ID of the contact.
sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
sender.contact.identifierValue
string
The identifier value for finding the contact.
sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
sender.contact.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
sender.contact.receiverExpression
string
sender.contact.receiverValue
string
sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
sender.inbox
object
Untergeordnete Attribute anzeigen
sender.inbox.emailRecipientType
string
sender.inbox.id
string
erforderlich
sender.inbox.identifierKey
string
erforderlich
sender.inbox.identifierValue
string
erforderlich
sender.inbox.type
string
erforderlich
Possible values: user, group
sender.userContact
object
Untergeordnete Attribute anzeigen
sender.userContact.id
string
erforderlich
sender.userContact.identifierKey
string
erforderlich
sender.userContact.identifierValue
string
erforderlich
sender.userContact.type
string
shortLinks
object
Untergeordnete Attribute anzeigen
shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
erforderlich
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
tagIds
array of string
tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
template
object
Untergeordnete Attribute anzeigen
template.attachments
array of object
Untergeordnete Attribute anzeigen
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
erforderlich
template.attachments.inline
boolean
erforderlich
template.attachments.mediaUrl
string
erforderlich
template.deployment
object
template.locale
string
erforderlich
template.name
string
The platform name of the template.
template.parameters
array of object
Untergeordnete Attribute anzeigen
template.parameters.key
string
erforderlich
template.parameters.sourceUrl
object
Untergeordnete Attribute anzeigen
template.parameters.sourceUrl.fullyReplaced
boolean
erforderlich
template.parameters.sourceUrl.value
string
erforderlich
template.parameters.type
string
erforderlich
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
erforderlich
template.projectId
string
erforderlich
The ID of the project from Studio.
template.settings
object
Untergeordnete Attribute anzeigen
template.settings.disallowMmLite
boolean
template.shortLinks
object
Untergeordnete Attribute anzeigen
template.shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
erforderlich
Enables link shortening for SMS messages.
template.templateBody
object
Untergeordnete Attribute anzeigen
template.templateBody.text
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description.label
string
erforderlich
template.templateBody.text.actions.link.text
string
erforderlich
template.templateBody.text.actions.link.url
string
erforderlich
template.templateBody.text.actions.type
string
erforderlich
Possible values: link
template.templateBody.text.attachments
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
erforderlich
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
erforderlich
template.templateBody.text.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items.emojiId
string
erforderlich
template.templateBody.text.metadata.line.emoji.items.index
integer
erforderlich
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
erforderlich
template.templateBody.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.paymentDetails.amount
string
erforderlich
template.templateBody.text.metadata.paymentDetails.currency
string
erforderlich
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
erforderlich
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
erforderlich
template.templateBody.type
string
erforderlich
Possible values: text
template.utmParameters
array of object
Untergeordnete Attribute anzeigen
template.utmParameters.key
string
erforderlich
template.utmParameters.value
string
erforderlich
template.variables
object
template.version
string
erforderlich
The version of the template.
updatedAt
string
erforderlich
Codebeispiel
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Receiver identifier

Push notifications use a channel-scoped identifier key and a gateway-prefixed identifier value. This differs from SMS/WhatsApp where the identifier key is phonenumber and the value is a raw E.164 number.
  • identifierKey must be push-{channelId} — the literal string push- followed by the UUID of the push channel you are sending through. This is the same channel UUID that appears in the request URL.
  • identifierValue must be {gateway}:{deviceToken} where {gateway} is one of:
    • firebase — for Android devices registered with Firebase Cloud Messaging (FCM v1)
    • apns — for iOS devices registered with Apple Push Notification service
    • web — for browsers registered with the Web Push protocol via VAPID
A bare device token without the gateway prefix is rejected.
Example receiver block:
Codebeispiel
{
  "receiver": {
    "contacts": [
      {
        "identifierKey":   "push-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identifierValue": "firebase:fK3xLp9aQ8m...:APA91bF..."
      }
    ]
  }
}
Note: FCM tokens contain : characters internally — only the first colon (separating the gateway from the token) is parsed by Bird. The rest of the value is treated as one opaque token string.

Push notification body

Push messages use body.type: "list" with title and text fields. The text body type used by SMS, WhatsApp, and email is not supported by the push platform.
FieldDescription
body.typeMust be "list".
body.list.titleThe notification title that appears in bold at the top of the system notification.
body.list.textThe notification body text below the title.
Example:
Codebeispiel
{
  "body": {
    "type": "list",
    "list": {
      "title": "New message",
      "text":  "Hello from your app"
    }
  }
}

Full request examples

Send to an Android device (Firebase)

Codebeispiel
{
  "receiver": {
    "contacts": [
      {
        "identifierKey":   "push-{channelId}",
        "identifierValue": "firebase:{fcm_device_token}"
      }
    ]
  },
  "body": {
    "type": "list",
    "list": {
      "title": "New message",
      "text":  "Hello from your app"
    }
  }
}

Send to an iOS device (APNs)

Codebeispiel
{
  "receiver": {
    "contacts": [
      {
        "identifierKey":   "push-{channelId}",
        "identifierValue": "apns:{apns_device_token}"
      }
    ]
  },
  "body": {
    "type": "list",
    "list": {
      "title": "New message",
      "text":  "Hello from your app"
    }
  }
}

Send to a browser (Web Push)

Codebeispiel
{
  "receiver": {
    "contacts": [
      {
        "identifierKey":   "push-{channelId}",
        "identifierValue": "web:{web_push_subscription_token}"
      }
    ]
  },
  "body": {
    "type": "list",
    "list": {
      "title": "New message",
      "text":  "Hello from your app"
    }
  }
}

Troubleshooting

If a send fails, the failure.reason field on the message contains the underlying error. Fetch the message via GET /workspaces/{workspaceId}/channels/{channelId}/messages/{messageId} and check that field.
The three most common failure modes are payload-shape mismatches. Match the symptom to the fix:
failure.reason containsFix
invalid identifier value format, missing gateway type prefixThe identifierValue is missing the gateway prefix. Prepend firebase:, apns:, or web: to the device token.
PlatformAddress does not match any selector (visible in worker logs) / message stuck in sending_failed with no token-shaped valueThe identifierKey is wrong. It must be push-{channelId}, not pushtoken, user_id, emailaddress, etc.
message body is emptyThe body.type is something other than list (most commonly text). Switch to list with list.title and list.text.
Other failures (expired device tokens, FCM/APNs auth errors, throttling) are surfaced from the gateway response and should be self-explanatory.