Sequenzy Email Design System API

The Email Design System API from Sequenzy — 1 operation(s) for email design system.

Operations 2

GET /email-design-system Get email design system #
PATCH /email-design-system Update email design system #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/sequenzy:sequenzy-email-design-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sequenzy-email-design-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sequenzy Email Design System API
  description: Sequenzy API for managing subscribers, tags, events, sequences, and transactional emails
  version: 1.0.0
servers:
- url: https://api.sequenzy.com/api/v1
  description: Production server
- url: https://api.sequenzy.com/v1
  description: Legacy production server alias
security:
- bearerAuth: []
tags:
- name: Email Design System
paths:
  /email-design-system:
    get:
      operationId: getEmailDesignSystem
      summary: Get email design system
      description: Returns the company's effective email design system - the visual identity every AI-generated email (campaigns and sequence steps) renders inside. The identity is stored as the company's emailDesignPrompt direction text; tokens are parsed from that text, with unstated tokens derived deterministically from brand context. isDefault is true while the identity is purely derived.
      tags:
      - Email Design System
      responses:
        '200':
          description: Email design system returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  designSystem:
                    $ref: '#/components/schemas/EmailDesignSystem'
                  directionText:
                    type:
                    - string
                    - 'null'
                    description: The raw design direction text the tokens were parsed from; null when the company has none yet.
                  isDefault:
                    type: boolean
                    description: True while the identity is purely derived from brand context.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          $ref: '#/components/responses/TransientDatabaseUnavailable'
    patch:
      operationId: updateEmailDesignSystem
      summary: Update email design system
      description: 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.
      tags:
      - Email Design System
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                designCode:
                  type: object
                  additionalProperties: false
                  description: Partial visual-grammar adjustment; omitted tokens keep their current value.
                  properties:
                    kickerStyle:
                      type: string
                      enum:
                      - chip
                      - letterspaced
                      - none
                      description: How eyebrows above titles render.
                    titleAlignment:
                      type: string
                      enum:
                      - left
                      - center
                    buttonShape:
                      type: string
                      enum:
                      - rounded
                      - pill
                    dividerStyle:
                      type: string
                      enum:
                      - line
                      - space
                    density:
                      type: string
                      enum:
                      - airy
                      - compact
                    openerTreatments:
                      type: array
                      description: The opener treatments this company's emails may use, primary first.
                      items:
                        type: string
                        enum:
                        - hero-image
                        - hero-color
                        - header-hero
                        - editorial-masthead
                        - title-led
                compositionSpine:
                  type: string
                  enum:
                  - hero-led
                  - editorial
                  - product-spec
                  description: Which worked-example skeleton anchors generation.
                reset:
                  type: boolean
                  description: true clears the direction text and returns to brand-derived defaults. Cannot be combined with designCode or compositionSpine.
            examples:
              editorial-identity:
                summary: Switch to a typography-first editorial identity
                value:
                  compositionSpine: editorial
                  designCode:
                    kickerStyle: letterspaced
                    openerTreatments:
                    - editorial-masthead
                    - title-led
              reset:
                summary: Return to the brand-derived identity
                value:
                  reset: true
      responses:
        '200':
          description: Email design system updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Updated the email design system and rewrote the design direction text to match.
                  designSystem:
                    $ref: '#/components/schemas/EmailDesignSystem'
                  directionText:
                    type:
                    - string
                    - 'null'
                    description: The rewritten direction text now stored on the company; null after a reset.
                  isDefault:
                    type: boolean
        '400':
          description: Invalid design system value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The design system was modified concurrently by another request; retry the update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          $ref: '#/components/responses/TransientDatabaseUnavailable'
components:
  headers:
    RetryAfter:
      description: Number of seconds to wait before retrying the request.
      schema:
        type: integer
        minimum: 1
        example: 1
  responses:
    TransientDatabaseUnavailable:
      description: The database was temporarily unavailable. The request may be retried after the delay in Retry-After.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: The service could not reach its database for a moment. Retry the request.
            code: SERVICE_UNAVAILABLE
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Error message
        code:
          type: string
          description: Optional stable machine-readable error discriminator when available.
          example: COMPANY_CREATE_REQUIRES_PERSONAL_KEY
        retryable:
          type: boolean
          description: Whether retrying the request can recover from the error.
        issues:
          type: array
          description: Field-level problems with the request, when the endpoint reports them. Up to ten entries; `error` summarizes the first three.
          items:
            $ref: '#/components/schemas/InputIssue'
      required:
      - error
    InputIssue:
      type: object
      properties:
        path:
          type: string
          description: Dotted field path, such as `audience.subscriberIds[0]`. Empty when the problem is with the request body itself.
          example: kind
        message:
          type: string
          description: What is wrong with the field.
          example: must be "add_tags"
        allowedValues:
          type: array
          description: Accepted values when the field only takes a fixed set of values.
          items: {}
          example:
          - add_tags
      required:
      - path
      - message
    EmailDesignSystem:
      type: object
      description: The visual identity every AI-generated email renders inside, parsed from the company's design direction text.
      required:
      - version
      - designCode
      - compositionSpine
      - source
      properties:
        version:
          type: integer
          example: 1
        designCode:
          type: object
          description: The locked visual grammar applied to every generated email.
          required:
          - version
          - kickerStyle
          - titleAlignment
          - buttonShape
          - dividerStyle
          - density
          - openerTreatments
          properties:
            version:
              type: integer
              example: 1
            kickerStyle:
              type: string
              enum:
              - chip
              - letterspaced
              - none
            titleAlignment:
              type: string
              enum:
              - left
              - center
            buttonShape:
              type: string
              enum:
              - rounded
              - pill
            dividerStyle:
              type: string
              enum:
              - line
              - space
            density:
              type: string
              enum:
              - airy
              - compact
            openerTreatments:
              type: array
              items:
                type: string
                enum:
                - hero-image
                - hero-color
                - header-hero
                - editorial-masthead
                - title-led
        compositionSpine:
          type: string
          enum:
          - hero-led
          - editorial
          - product-spec
          description: Which worked-example skeleton anchors email composition.
        source:
          type: string
          enum:
          - derived
          - custom
          description: derived when every token comes from brand derivation; custom when the direction text carries the identity.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key passed as Bearer token