Skip to content

Publish a site

POSThttps://api.vidmoat.com/v1/interactive-sites/{id}/publish
Bearer tokenScope render.writeFreeTry it in the playground

Make the draft what the site's address shows to anyone, or take the site down.

Path parameters#

  • idstringrequired
    The site id.

Body#

  • publishbooleandefault true
    false takes it down; the published copy is kept.

Response#

Returns 200.

Response fields#

  • publishedboolean
    Whether the site is live now.
  • urlstring
    With publish: true: the site's address.
  • notestring
    When published but not shown yet (the plan or a restriction), why.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundNo such project, or it is not yours. The two are indistinguishable on purpose.
402plan_requiredNot on this plan, publishing is paused on the account, or the site was taken offline by Vidmoat.
409conflictA page is empty, or a video or picture is not the account's own published one (problems lists them).