Update design.md - Sequenzy

PUT

api

design-md

Update design.md

curl --request PUT \
  --url https://api.sequenzy.com/api/v1/design-md \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "markdown": "<string>",
  "expectedVersion": "<string>",
  "dryRun": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/design-md"

payload = {
    "markdown": "<string>",
    "expectedVersion": "<string>",
    "dryRun": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({markdown: '<string>', expectedVersion: '<string>', dryRun: true})
};

fetch('https://api.sequenzy.com/api/v1/design-md', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/design-md",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'markdown' => '<string>',
    'expectedVersion' => '<string>',
    'dryRun' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/design-md"

	payload := strings.NewReader("{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sequenzy.com/api/v1/design-md")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/design-md")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Saved design.md: changed colors.primary, voice.",
  "saved": true,
  "dryRun": false,
  "changes": ["colors.primary", "voice"],
  "warnings": [],
  "markdown": "---\n...\n",
  "version": "9b1e04c7d2a35f68",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{
  "success": false,
  "error": "design.md has 1 error: line 3: colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
  "code": "DESIGN_MD_BAD_REQUEST",
  "issues": [
    {
      "message": "colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
      "line": 3
    }
  ]
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "API key is missing required scope: company_profile:manage"
}

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

{
  "success": false,
  "error": "design.md changed since you read it. Get the current design.md and reapply your edits.",
  "code": "DESIGN_MD_CONFLICT",
  "howToFix": "GET /api/v1/design-md, reapply your edits to the returned markdown, then retry with its version as expectedVersion. Do not retry the stale document unchanged."
}

Save an edited design.md. Start from the markdown returned by Get design.md, change what you want, and send the whole document back. Only values that differ from the current document are saved:

A frontmatter value you leave exactly as returned is not written, so it keeps working as it does now. Saving the document unchanged writes nothing.
A changed buttons.radius, cornerRadius or fonts.heading is pinned, so layout defaults stop adjusting it.
A changed layout token is written into the design direction ahead of your prose, so it wins over older wording.
A changed colors.primary also becomes your brand primary color.
A key or section you remove is left unchanged. An empty ## Voice or ## Design direction section clears it. An empty design direction returns to the defaults derived from your brand.
Other ## sections, and text before the first section, are kept as part of the design direction.
Edits to ## Reference email are not saved and come back as a warning.

If you have saved an email as your AI style, designed AI emails copy that email’s look, so new colors, fonts and button values reach them only after you clear the style. The response warns you when this applies.

Request

string

required

The full design.md document, up to 100,000 characters.

string

The version from your last read. When design.md changed since then, the save fails with 409 and nothing is written. Recommended.

boolean

true validates the document and returns the changes and warnings a save would produce, without saving.

curl -X PUT "https://api.sequenzy.com/api/v1/design-md" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "markdown": "---\ncolors:\n  primary: \"#1f4fff\"\n---\n\n## Voice\n\nPlain and direct. Setup steps first.\n",
    "expectedVersion": "3f9a2c1d8e7b6a50"
  }'

Requires the company_profile:manage scope, including for dry runs. Personal API keys also need an owner or admin role in the workspace.

Response fields

boolean

true when this request wrote changes.

boolean

true when you asked for a dry run.

string[]

What changed, in document terms: logo, colors.<key>, fonts.body, fonts.heading, buttons.style, buttons.radius, cornerRadius, voice, designDirection, or layout.<token>.

object[]

Notes that did not block the save, each with a message and, when it maps to one, a line: unknown keys that were ignored, edits to the read-only Reference email section, and theme values a saved AI style overrides.

string

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

string

The current version. It only changes when something was saved.

object

The layout tokens in effect after the save.

Errors and retries

400 with code: DESIGN_MD_BAD_REQUEST: the document has errors, listed in issues with line numbers. Typical causes are invalid YAML, an unquoted hex color (# starts a YAML comment), or an unknown layout value. Nothing is saved.
409 with code: DESIGN_MD_CONFLICT: design.md changed after the read your expectedVersion came from. Get it again, reapply your edits and save with the new version. Do not resend the stale document unchanged.
422: the body is missing markdown, or it is longer than 100,000 characters.
A save either applies every change or none, so retrying a failed request is safe.

Responses

{
  "success": true,
  "message": "Saved design.md: changed colors.primary, voice.",
  "saved": true,
  "dryRun": false,
  "changes": ["colors.primary", "voice"],
  "warnings": [],
  "markdown": "---\n...\n",
  "version": "9b1e04c7d2a35f68",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{
  "success": false,
  "error": "design.md has 1 error: line 3: colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
  "code": "DESIGN_MD_BAD_REQUEST",
  "issues": [
    {
      "message": "colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
      "line": 3
    }
  ]
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "API key is missing required scope: company_profile:manage"
}

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

{
  "success": false,
  "error": "design.md changed since you read it. Get the current design.md and reapply your edits.",
  "code": "DESIGN_MD_CONFLICT",
  "howToFix": "GET /api/v1/design-md, reapply your edits to the returned markdown, then retry with its version as expectedVersion. Do not retry the stale document unchanged."
}

Update design.md

curl --request PUT \
  --url https://api.sequenzy.com/api/v1/design-md \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "markdown": "<string>",
  "expectedVersion": "<string>",
  "dryRun": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/design-md"

payload = {
    "markdown": "<string>",
    "expectedVersion": "<string>",
    "dryRun": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({markdown: '<string>', expectedVersion: '<string>', dryRun: true})
};

fetch('https://api.sequenzy.com/api/v1/design-md', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/design-md",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'markdown' => '<string>',
    'expectedVersion' => '<string>',
    'dryRun' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/design-md"

	payload := strings.NewReader("{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sequenzy.com/api/v1/design-md")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/design-md")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"markdown\": \"<string>\",\n  \"expectedVersion\": \"<string>\",\n  \"dryRun\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Saved design.md: changed colors.primary, voice.",
  "saved": true,
  "dryRun": false,
  "changes": ["colors.primary", "voice"],
  "warnings": [],
  "markdown": "---\n...\n",
  "version": "9b1e04c7d2a35f68",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{
  "success": false,
  "error": "design.md has 1 error: line 3: colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
  "code": "DESIGN_MD_BAD_REQUEST",
  "issues": [
    {
      "message": "colors.primary must be a hex color such as \"#1f4fff\". Quote it: # starts a YAML comment.",
      "line": 3
    }
  ]
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "API key is missing required scope: company_profile:manage"
}

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

{
  "success": false,
  "error": "design.md changed since you read it. Get the current design.md and reapply your edits.",
  "code": "DESIGN_MD_CONFLICT",
  "howToFix": "GET /api/v1/design-md, reapply your edits to the returned markdown, then retry with its version as expectedVersion. Do not retry the stale document unchanged."
}

​Request

​Response fields

​Errors and retries

​Responses

Request

Response fields

Errors and retries

Responses