Skip to content

by Startups.Studio

Message.schedule

POST /{namespace}/messages/{message}/schedule

Schedule holds a Message until a set time and sends it then, unless it is canceled first.

Noun: Message
Mode: do
Event: Message.scheduled

You, to your agent

Schedule the latest message.

curl -X POST https://api.sb/tutorloop.com/messages/message_1/schedule \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"at":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const message = await $.Message.schedule({ message: 'message_1', at: '2026-10-22T12:00:00Z' })

npx startup-builder do Message.schedule --json '{"message":"message_1","at":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Message.schedule({ message: 'message_1', at: '2026-10-22T12:00:00Z' })"
  }
}

Inputs

Input	Type	Required	Description
`message`	Message	required	The Message to hold.
`at`	`datetime`	required	When it goes out.

Outputs

Output	Type	Required	Description
`message`	Message	required	The scheduled Message.

Effects

Emits Message.scheduled.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.

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.schedule

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
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.list

Previous Page

Message.update

Next Page