Open a review room on a preview build

What the marklayer_share_preview tool calls. Creates the room at the id you chose and never overwrites one.

post/{id}/preview

Request

  • Base URL: https://marklayer.app/api
  • URL: https://marklayer.app/api/{id}/preview
  • Auth: none declared

Path parameters

idstring required

Unguessable share id you choose — it is the access token. Creating a new one takes at least 12 characters of [A-Za-z0-9_-]; a nanoid() or uuid is ideal.

Example:dsWPMrdw6EZ8jkkhxvFKS

Request body

urlstring uri required

Absolute http(s) URL of the page to review

titlestring required

What this is, shown to reviewers

repostring
branchstring
shastring
notestring

What changed and what to look at

previousstring

A room you hold (link or id). With the same repo and branch, the new room becomes its next version. Naming it is the proof you hold it: rooms are never chained by repo and branch alone.

agentstring

Who is asking, shown as the author of any polls

Response

Created

idstring required
urlstring required
versionnumber nullable required
previousstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.