Skip to main content
POST
Send a push notification

Authorizations

Authorization
string
header
required

An admin session, company API token, droplet token or bot token.

Headers

Idempotency-Key
string

Use this or idempotency_key in the body.

Body

application/json

A push notification to the member's signed-in phones.

member_id
string<uuid>
required

A member's uuid.

body
string
required
Required string length: 1 - 2000
message_type
enum<string>
default:transactional

marketing needs the recipient's marketing consent for the channel.

Available options:
transactional,
marketing
idempotency_key
string

A key you choose. Sending again with the same key answers with the first message instead of sending twice. You can send it as the Idempotency-Key header instead.

Maximum string length: 200
title
string
Maximum string length: 200
url
string

Where tapping the notification takes the member in the app.

data
object

Extra data for the app.

no_queue
boolean
default:false

A marketing message asked for during the recipient's quiet hours (21:00 to 08:00 in their time zone by default) waits and goes out when they end. Pass true to have it refused as quiet_hours with send_at instead.

Response

A repeat of an earlier request with the same idempotency key; the first message is returned and nothing is sent again.

message
object
required

A message sent through this API. The address itself is never returned.

status
integer
required
meta
object
required

Response metadata.