Post methods: publish, schedule, withdraw
The Post Verbs publish, schedule, withdraw as typed SDK methods, with inputs, result, refusals and an example.
Reference for Post, one group of Post methods.
Post.publish
Publish sends a Post out through its Handle once every claim it states resolves to a live record. Verb page.
interface PostVerbs {
publish(input: PostPublishInput, options?: SB.CallOptions): SB.Call<Post>
}Emits Post.published.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
post | Post | required | The Post to publish. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
post | Post | required | The published Post. |
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 post = await $.Post.publish({ post: 'post_HiXn57rBdP' })Post.schedule
Schedule puts a drafted Post on its Handle’s calendar for a set time. Verb page.
interface PostVerbs {
schedule(input: PostScheduleInput, options?: SB.CallOptions): SB.Call<Post>
}Emits Post.scheduled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
post | Post | required | The drafted Post. |
at | datetime | required | When it goes out. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
post | Post | required | The scheduled Post. |
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 post = await $.Post.schedule({ post: 'post_HiXn57rBdP', at: '2026-10-22T12:Post.withdraw
Withdraw takes a published Post down from its venue and keeps the record, its reach and its replies. Verb page.
interface PostVerbs {
withdraw(input: PostWithdrawInput, options?: SB.CallOptions): SB.Call<Post>
}Emits Post.withdrawn.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
post | Post | required | The Post to take down. |
reason | text | required | Why it comes down. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
post | Post | required | The withdrawn Post. |
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 post = await $.Post.withdraw({ post: 'post_HiXn57rBdP', reason: 'Example reason' })