design.md

Update design.md

Changed on

Saves an edited design.md. Only values that differ from the current document are written. A frontmatter value left exactly as returned is not written and keeps its current behavior; a changed buttons.radius, cornerRadius or fonts.heading is pinned so layout defaults no longer override it; a changed layout token is written into the design direction ahead of its prose. A key or section you remove is left unchanged, and an empty Voice or Design direction section clears that field (an empty direction returns to brand-derived defaults). Other level-2 sections are kept as part of the design direction. The Reference email section is read-only. Requires company_profile:manage, including for dry runs.

put/design-md

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/design-md
  • Auth
    HTTP bearer

Request body

markdownstring required

The full design.md document, usually the markdown from GET /design-md with your edits.

expectedVersionstring

Version from GET /design-md. When it no longer matches, the save fails with 409 and nothing is written. Recommended.

dryRunboolean

true validates the document and reports changes and warnings without saving.

Response

design.md saved, unchanged, or validated (dry run)

successboolean
messagestring
savedboolean

True when this request wrote changes.

dryRunboolean
changesstring[]

Changed fields in document terms, such as colors.primary, fonts.heading, buttons.radius, cornerRadius, logo, voice, designDirection or layout.spine.

markdownstring

The document as it reads after the save, or would read for a dry run.

versionstring

The current version. Unchanged for a dry run or when nothing changed.

Example response

{
  "success": true,
  "message": "Saved design.md: changed colors.primary, voice.",
  "changes": [
    "colors.primary",
    "voice"
  ],
  "warnings": [
    {
      "message": "Unknown key \"shadows\" was ignored.",
      "line": 2
    }
  ],
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1
    }
  }
}

Changes