design.md

Returns the company's design.md, its email design brief as one Markdown document. YAML frontmatter holds the exact values AI-generated emails use (logo, colors, fonts, buttons, cornerRadius, layout tokens), shown as the values emails actually get. The body holds the Voice and Design direction sections the AI writer follows, plus a read-only Reference email section naming the saved AI style. design.md is a view over existing company fields, not a separate store.

get/design-md

Request

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

Response

design.md returned

successboolean
markdownstring

The full design.md document.

versionstring

Content version. Pass it as expectedVersion when saving so a concurrent change fails instead of being overwritten.

Example response

{
  "success": true,
  "version": "3f9a2c1d8e7b6a50",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1
    }
  }
}

Changes