Skip to content
SalesBuilder
Code
See my plan

Site.publish

Puts your Site’s current pages live on its Domain, under your Brand.

Action class
publish
Approval
Publishes on its own
Emits
Site.published
Price
Free
POST https://api.sb/{your-domain}/sites/{site}/publish

Its Inputs, Outputs, Effects and guards quote the hub’s Site.publish; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Sites and content.

Inputs

NameTypeDefaultMeaning
siteSiteRequiredThe Site to publish.

Outputs

FieldTypeWhat null means
siteSiteNever null: the Site, now live.

Effects

Action class

publish: an approval rule on publish can make it wait for your OK

Modes
  • try: Runs every check and returns what would go out, as it would go out; nothing is sent, posted or spent.
  • send: Returns a pending Action at once; Site.published fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Keeps the previous pages, so a revert restores them.

Emits

Site.published with { site }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

Standing approval

It goes out on its own, inside the Limits of your standing approval: a Mandate you grant once with Mandate.authorize. One approval rule makes it wait for your OK.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

GuardRefusesError
sibling-link-attributeIt refuses a page with a followed link to a sibling Domain that no cited fact justifies.refused

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Site.published delivers the result.

You, to your agent
Put the site live with the new pricing page.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Site.publish",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

Content.publish

Previous

Page.create

Next