Email Design System

Update email design system

Changed on

Adjusts the company's email design system. This is a partial update - only the passed fields change - and it affects every future AI email generation and sequence enrichment. The adjustment is written into the company's emailDesignPrompt direction text (the single source of truth) - the new identity's sentences are prepended and custom prose the text carried is preserved below them. Pass reset true to clear the direction text and return to the brand-derived defaults.

patch/email-design-system

Request

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

Request body

compositionSpine'hero-led' | 'editorial' | 'product-spec'

Which worked-example skeleton anchors generation.

resetboolean

true clears the direction text and returns to brand-derived defaults. Cannot be combined with designCode or compositionSpine.

Response

Email design system updated

successboolean
messagestring
directionTextstring nullable

The rewritten direction text now stored on the company; null after a reset.

isDefaultboolean

Example response

{
  "success": true,
  "message": "Updated the email design system and rewrote the design direction text to match.",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1
    }
  }
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e1667306c303Revision changes
    • info

      endpoint added