HOC SiteDokümantasyon

save_chrome

Save site header or footer. Pass content (sparse merge, or contentMode replace) OR ops (block-id patch: set/reset/insert/remove/move/pinDefaults)—not both. contentByLocale writes several locales in one call (same rules as save_page). Omitted keys stay. null deletes a key. Block arrays match by id; unlisted blocks stay; a new id is appended; {id, props:null} removes that block. A block without props.id receives one on save. remove with blockId root and path content.N splices that top-level block. Reordering stays an ops move. A non-block array replaces that array. Do not send a summary response as content. remove {blockId,path?} deletes a prop when path is set, otherwise the block. An op may omit op: block + parentBlockId is read as insert, path as set. Ops default to slim response {changedBlockIds,contentLocale,hasWarnings}. response=full returns the compact document. The response includes revisionId, revisionNo, baseRevisionId, settingKeys, and a render report. dryRun does not save. Errors: design.block_not_found, design.op_bad_path, design.ops_or_content, design.json_parse. set value and insert block are JSON-parsed when the string starts with {, [, or a quote. A {{bind:…}}, {{var:…}}, or {{icon:…}} token is stored as that text. A quoted JSON string unwraps to the token. Any other string starting with { or [ that is not JSON fails with design.json_parse at ops[n].value.

save_chrome · Grup: design

Save site header or footer. Pass content (sparse merge, or contentMode replace) OR ops (block-id patch: set/reset/insert/remove/move/pinDefaults)—not both. contentByLocale writes several locales in one call (same rules as save_page). Omitted keys stay. null deletes a key. Block arrays match by id; unlisted blocks stay; a new id is appended; {id, props:null} removes that block. A block without props.id receives one on save. remove with blockId root and path content.N splices that top-level block. Reordering stays an ops move. A non-block array replaces that array. Do not send a summary response as content. remove {blockId,path?} deletes a prop when path is set, otherwise the block. An op may omit op: block + parentBlockId is read as insert, path as set. Ops default to slim response {changedBlockIds,contentLocale,hasWarnings}. response=full returns the compact document. The response includes revisionId, revisionNo, baseRevisionId, settingKeys, and a render report. dryRun does not save. Errors: design.block_not_found, design.op_bad_path, design.ops_or_content, design.json_parse. set value and insert block are JSON-parsed when the string starts with {, [, or a quote. A {{bind:…}}, {{var:…}}, or {{icon:…}} token is stored as that text. A quoted JSON string unwraps to the token. Any other string starting with { or [ that is not JSON fails with design.json_parse at ops[n].value.

Girdiler

FieldRequiredNotes
websiteIdrequired
kindrequired
channeloptionalwebsite (default) writes the site header/footer. email writes the email template header/footer, which accepts content only.
contentoptional
contentModeoptionalmerge (default) updates listed blocks by id and keeps the rest. replace writes this content as the whole document.
opsoptional[{op,blockId|parentBlockId,path?,value?,index?,block?,slot?}]
contentByLocaleoptional{ "en-GB": { content|ops }, "tr-TR": { content|ops } }
contentLocaleoptional
responseoptionalfull | slim
dryRunoptional
previewTokenoptional

Eşlendiği uçlar

  • PUT /api/v1/{locale}/{websiteId}/chrome/header → API
  • PUT /api/v1/{locale}/{websiteId}/chrome/footer → API
  • PUT /api/v1/{locale}/{websiteId}/email-chrome/header → API
  • PUT /api/v1/{locale}/{websiteId}/email-chrome/footer → API

İlgili