Skip to content

by Startups.Studio

Product What you sell Offer

Offer.publish

POST /{namespace}/offers/{offer}/publish

Publish makes an Offer available for parties to accept.

Noun: Offer
Mode: do
Event: Offer.published

You, to your agent

Publish the offer “RouteWise API”.

curl -X POST https://api.sb/routewise.dev/offers/offer_1/publish \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const offer = await $.Offer.publish({ offer: 'offer_1' })

npx startup-builder do Offer.publish --json '{"offer":"offer_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.publish({ offer: 'offer_1' })"
  }
}

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer to publish.

Outputs

Output	Type	Required	Description
`offer`	Offer	required	The Offer, now open to accept.

Effects

Emits Offer.published.
Performed by the Product Lead.

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.	Offer.publish
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Offer.publish
The median Customer’s Cost leaves less than the Startup’s target margin at this Price.	`below-contribution-floor`	Raise the Price to the floor the error names, or grant fewer Entitlements.	Offer.update

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, 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`.

An Agent publishes a $0 Offer for an API key, and any party can accept it from then on.

Offer.list

Previous Page

Offer.subscribe

Next Page