Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Body

to
Required string length: 1 - 256
topic
string
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
segment
string
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
where
object
channel
enum<string>
Available options:
push,
email
ttlSeconds
integer
Required range: 60 <= x <= 2419200
schedule
object
idempotencyKey
string
Required string length: 1 - 255
title
string
Maximum string length: 500
body
string
Maximum string length: 4000
subtitle
string
Maximum string length: 500
badge
integer
Required range: x >= 0
sound
string
Maximum string length: 100
imageUrl
string<uri>
Maximum string length: 2048
data
object
collapseId
string
Maximum string length: 64
priority
enum<string>
Available options:
high,
normal
threadId
string
Maximum string length: 64
category
string
Maximum string length: 64
interruptionLevel
enum<string>
Available options:
passive,
active,
timeSensitive,
critical
relevanceScore
number
Required range: 0 <= x <= 1
targetContentId
string
Maximum string length: 64
Maximum string length: 2000
action
object
policy
enum<string>
Available options:
ignore
actions
object[]
Required array length: 1 - 4 elements
apns
object
fcm
object

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required