Skip to content

Edit a site

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

Change the draft with typed ops, all applied or none; or rename the address. There is no custom code: a value outside a list is refused with the list.

Path parameters#

  • idstringrequired
    The site id.

Body#

  • opsobject[]
    Up to 50 ops: setTheme, setHeader, setNav, setFooter, setSettings, addPage, updatePage, removePage, movePage, addSection, updateSection, removeSection, moveSection. See the guide.
  • revinteger
    The rev you read; a write over a newer draft is refused.
  • prefixstring
    Instead of ops: a new address. The old one forwards for 30 days and stays yours until then.

Response#

Returns 200.

Response fields#

  • siteobject
    The site after the change.
  • resultsobject[]
    With ops: one per op, with sectionId for a new section.
  • heldobject
    With prefix: the old prefix and until when it is held.

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.
400invalid_requestAn op was refused (a value outside its list, over a cap, markup, an unsafe link, a video or picture that is not the account's own). The message names the op; nothing was changed.
402plan_requiredInteractive sites are not on this plan, or not switched on for this account or the API.
409conflictrev is older than the draft, or the new prefix is taken or refused.