Skip to content

by Startups.Studio

Message.broadcast

POST /{namespace}/messages/{message}/broadcast

Broadcast sends one Message to an Audience, now or at a set time, split by Variant when an Experiment runs.

Noun: Message
Mode: do
Event: Message.broadcasted

You, to your agent

Broadcast the latest message with an audience.

curl -X POST https://api.sb/kilnbakery.com/messages/message_1/broadcast \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audience":"audience_1"}'

import { $ } from 'startup-builder'

const { messages, message } = await $.Message.broadcast({ message: 'message_1', audience: 'audience_1' })

npx startup-builder do Message.broadcast --json '{"message":"message_1","audience":"audience_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Message.broadcast({ message: 'message_1', audience: 'audience_1' })"
  }
}

Inputs

Input	Type	Required	Description
`message`	Message	required	The Message to send.
`audience`	Audience	required	Who receives it.
`at`	`datetime`		When it goes out; omitted, now.

Outputs

Output	Type	Required	Description
`messages`	list of Message	required	One sent Message per Contact.
`message`	Message	required	The Message broadcast.

Effects

Emits Message.broadcasted.
Performed by the Marketing Lead.
One-way (brand, customer): it waits out its delay window, and runs in the send and do modes.
Skips every Contact without Consent for the topic or on a Suppression.
Sends from the broadcast stream, never the Domain receipts use.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Message.broadcast

When it waits

Gate	Default
Decision class	High: one-way, broad (brand, customer)
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Message

Previous Page

Message.create

Next Page