Content

Change where a shared section shows

Move it between the pages where it appears and every page (one slot in the layout), or hide it on some pages of an every-page section and show it there again. The hide marker lives in each page's <dotsy-config>, so it moves with the page. All pages of a call change together or none do. Over the per-call cap, move to every page in slices with keys: the first call also places it in the layout and takes the inline copy of every page it doesn't hide, a page not moved yet keeps its own reference (and shows it once). Pages kept out are hidden with the first move, or before it (hide without scope, in as many calls as needed). Staged as a draft; dryRun reports without writing.

post/api/v1/sites/{slug}/shared-sections/{name}/placement

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/shared-sections/{name}/placement
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

namestring required
Example:booking-banner

The section name.

Request body

scope'where_found' | 'every_page'

Move the section between where_found and every_page, in one all-or-nothing change.

keysstring[]

every_page in slices, for a move over the per-call cap: the pages that place it whose own tag this call removes (default all of them). The first call also puts it in the layout; pages not moved yet keep their tag and still show it once. Call again with the next slice until every page is moved.

hidestring[]

Pages that should stop showing this every-page section (a marker in each page's <dotsy-config>). Moving to every page, pages kept out (they keep their own copy) go with the first move or ahead of it (hide without scope, before any move).

showstring[]

Pages that should show it again (removes their marker).

dryRunboolean

Report what would change; write nothing.

Response

Placed (staged as a draft), or what would change on a dry run.

namestring required
keystring required
scope'where_found' | 'every_page' required
pagesinteger required
hiddeninteger required
writtenstring[] required

Every content key this call staged (or, on a dry run, would stage): the section file, pages, the layout. Staged as a draft; in live publishing mode the dashboard then publishes exactly these keys.

dryRunboolean required
alreadyAppliedboolean required
eventIdstring nullable required

The activity event of this change — undo with POST …/activity/{eventId}/revert. Null on a dry run, when nothing was written, or when the audit insert failed.

Changes

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