Message programs: broadcast, schedule

Reference for Message, one group of Message programs.

Message.broadcast

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

Text

do: return await $.Message.broadcast(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return 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.