Skip to content

by Startups.Studio

Message.create

POST /{namespace}/messages

Creates a Message.

Noun: Message
Mode: do
Event: Message.created

You, to your agent

Add a message to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/messages \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email","direction":"inbound","body":"Example body"}'

import { $ } from 'startup-builder'

const message = await $.Message.create({ medium: 'email', direction: 'inbound', body: 'Example body' })

npx startup-builder do Message.create --json '{"medium":"email","direction":"inbound","body":"Example body"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Message.create({ medium: 'email', direction: 'inbound', body: 'Example body' })"
  }
}

Create makes a new Message from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`medium`	`string`	required	One of `email`, `sms`, `voice`, or `chat`.
`direction`	`string`	required	One of `inbound` or `outbound`.
`body`	`text`	required	What it says.
`from`	`string`		The sender: an address, a number, or a Channel id.
`to`	`string`		The recipient: an address, a number, or a Person id.
`subject`	`string`		The subject line, for email.
`purpose`	`string`		Why it goes out, such as onboarding; consent and suppression rules read it.
`sequence`	Sequence		A Sequence sends Messages, each at its own step and wait.
`channel`	Channel		Every Message flows through one Channel.
`thread`	Thread		A Thread groups Messages that reply to one another.

Outputs

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

Effects

Emits Message.created.
Two-way: try, send, do.

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

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

Previous Page

Message.delete

Next Page