Skip to content

by Startups.Studio

Post.withdraw

POST /{namespace}/posts/{post}/withdraw

Withdraw takes a published Post down from its venue and keeps the record, its reach and its replies.

Noun: Post
Mode: do
Event: Post.withdrawn

You, to your agent

Withdraw the latest post.

curl -X POST https://api.sb/kilnbakery.com/posts/post_1/withdraw \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const post = await $.Post.withdraw({ post: 'post_1', reason: 'Example reason' })

npx startup-builder do Post.withdraw --json '{"post":"post_1","reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Post.withdraw({ post: 'post_1', reason: 'Example reason' })"
  }
}

Inputs

Input	Type	Required	Description
`post`	Post	required	The Post to take down.
`reason`	`text`	required	Why it comes down.

Outputs

Output	Type	Required	Description
`post`	Post	required	The withdrawn Post.

Effects

Emits Post.withdrawn.
Performed by the Content Lead.
One-way: it waits out its delay window, and runs in the 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.	Post.withdraw

When it waits

Gate	Default
Decision class	High: one-way, broad
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Post.update

Previous Page

Problem

Next Page