Message methods: broadcast, schedule
The Message Verbs broadcast, schedule as typed SDK methods, with inputs, result, refusals and an example.
Reference for Message, one group of Message methods.
Message.broadcast
Broadcast sends one Message to an Audience, now or at a set time, split by Variant when an Experiment runs. Verb page.
interface MessageVerbs {
broadcast(input: MessageBroadcastInput, options?: SB.CallOptions): SB.Call<MessageBroadcastOutput>
}Emits Message.broadcasted.
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. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
messages | list of Message | required | One sent Message per Contact. |
message | Message | required | The Message broadcast. |
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. | None. |
Example
import { $ } from 'startup-builder'
const { messages, message } = await $.Message.broadcast({ message: 'message_3Dg8ysSOyQ', audience: 'audience_vmVkEYrXCN' })Message.schedule
Schedule holds a Message until a set time and sends it then, unless it is canceled first. Verb page.
interface MessageVerbs {
schedule(input: MessageScheduleInput, options?: SB.CallOptions): SB.Call<Message>
}Emits Message.scheduled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
message | Message | required | The Message to hold. |
at | datetime | required | When it goes out. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
message | Message | required | The scheduled Message. |
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. | None. |
Example
import { $ } from 'startup-builder'
const message = await $.Message.schedule({ message: 'message_3Dg8ysSOyQ', at: '2026-10-22T12: