> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onlyform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a form

> Replaces provided definition sections and preserves omitted sections. Requires forms:write. Send If-Match with the ETag from GET to prevent lost updates.



## OpenAPI

````yaml /openapi.json patch /v1/forms/{formId}
openapi: 3.1.0
info:
  title: Onlyform Public API
  version: '2026-08-01'
  summary: >-
    Programmatic access to Onlyform workspaces, forms, submissions, analytics,
    and webhooks.
  description: >-
    The Onlyform Public API uses stable resource IDs, cursor pagination, scoped
    API keys, and structured errors. API keys are created in the Onlyform
    profile and must be sent in the X-API-Key header. Keys are shown once and
    cannot be recovered.
servers:
  - url: https://api.onlyform.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Inspect the API key owner and effective scopes.
  - name: Workspaces
    description: List and manage accessible workspaces.
  - name: Forms
    description: Create and manage forms and their block definitions.
  - name: Submissions
    description: Read and remove completed form submissions.
  - name: Analytics
    description: Read aggregate form funnel metrics.
  - name: Webhooks
    description: Manage response-completed webhooks and inspect deliveries.
paths:
  /v1/forms/{formId}:
    parameters:
      - $ref: '#/components/parameters/FormId'
    patch:
      tags:
        - Forms
      summary: Update a form
      description: >-
        Replaces provided definition sections and preserves omitted sections.
        Requires forms:write. Send If-Match with the ETag from GET to prevent
        lost updates.
      operationId: updateForm
      parameters:
        - name: If-Match
          in: header
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormUpdate'
      responses:
        '200':
          description: Updated form.
          headers:
            ETag:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    FormId:
      name: formId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ObjectId'
  schemas:
    FormUpdate:
      type: object
      minProperties: 1
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        definition:
          $ref: '#/components/schemas/FormDefinitionUpdate'
    Form:
      allOf:
        - $ref: '#/components/schemas/FormSummary'
        - type: object
          required:
            - definition
          properties:
            definition:
              $ref: '#/components/schemas/FormDefinition'
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      examples:
        - 507f1f77bcf86cd799439011
    FormDefinitionUpdate:
      type: object
      minProperties: 1
      additionalProperties: false
      properties:
        blocks:
          type: array
          description: >-
            Complete ordered top-level block collection. When supplied, it
            replaces the current collection.
          items:
            $ref: '#/components/schemas/Block'
        settings:
          $ref: '#/components/schemas/FormSettings'
        theme:
          $ref: '#/components/schemas/CustomTheme'
    FormSummary:
      type: object
      required:
        - id
        - public_id
        - workspace_id
        - name
        - status
        - is_closed
        - created_at
        - updated_at
        - links
        - type
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        public_id:
          type: string
        workspace_id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
        status:
          $ref: '#/components/schemas/FormStatus'
        is_closed:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        links:
          type: object
          required:
            - self
            - submissions
          properties:
            self:
              type: string
            submissions:
              type: string
        type:
          $ref: '#/components/schemas/FormType'
    FormDefinition:
      type: object
      required:
        - blocks
        - settings
        - theme
      properties:
        blocks:
          type: array
          items:
            $ref: '#/components/schemas/Block'
        settings:
          $ref: '#/components/schemas/FormSettings'
        theme:
          $ref: '#/components/schemas/CustomTheme'
    Error:
      type: object
      required:
        - type
        - code
        - message
        - status
        - request_id
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        status:
          type: integer
        request_id:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
    Block:
      type: object
      required:
        - id
        - type
        - label
        - description
        - required
        - properties
      properties:
        id:
          type: string
          description: Stable caller-supplied block ID.
        type:
          $ref: '#/components/schemas/BlockType'
        label:
          type: string
        description:
          type: string
        required:
          type: boolean
        part_of:
          type: string
        row_id:
          type: string
        choices:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
        children:
          type: array
          items:
            $ref: '#/components/schemas/Block'
        properties:
          $ref: '#/components/schemas/BlockProperties'
        matrix_columns:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
        matrix_rows:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
    FormSettings:
      type: object
      description: >-
        Form behavior stored in the backend settings object. Unknown supported
        product settings are preserved.
      additionalProperties: true
      properties:
        branding:
          type: boolean
          description: Show Onlyform branding.
        navigation:
          type: boolean
          description: Show form navigation controls.
        progressBar:
          type: boolean
          description: Show form progress.
        singlePage:
          type: boolean
          readOnly: true
          description: >-
            Derived from the top-level form type. Use type instead of writing
            this compatibility field.
        inlineFields:
          type: boolean
          description: Allow compatible fields to render inline.
        borderRadius:
          type: number
          description: Legacy form corner radius setting.
        numberedQuestions:
          type: boolean
          description: Prefix questions with numbers.
        responseLimit:
          type: integer
          minimum: -1
          description: Maximum responses; -1 means unlimited.
        darkMode:
          type: boolean
          description: Use the dark theme palette.
        closed:
          type: boolean
          description: Stop accepting new responses.
        utm:
          $ref: '#/components/schemas/UtmSettings'
        showTitle:
          type: boolean
          description: Show the form title.
        closeAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Automatically close the form at this time.
        closedMessage:
          type: string
          description: Message shown when the form is closed.
        duplicateField:
          type:
            - string
            - 'null'
          description: Block ID used to reject duplicate responses.
        redirectUrl:
          type: string
          format: uri
          description: Redirect after completion. Pro.
        submitLabel:
          type: string
          description: Custom submit button label.
        cover:
          type: object
          additionalProperties: false
          properties:
            color:
              type: string
              description: CSS fallback color.
            image:
              $ref: '#/components/schemas/ThemeAsset'
            position:
              type: object
              additionalProperties: false
              properties:
                x:
                  type: number
                'y':
                  type: number
    CustomTheme:
      type: object
      description: Colors, typography, layout, and visual styling for a form.
      additionalProperties: true
      properties:
        logo:
          anyOf:
            - $ref: '#/components/schemas/ThemeAsset'
            - type: 'null'
        background:
          type: object
          additionalProperties: false
          properties:
            brightness:
              type: number
              minimum: 0
              maximum: 100
            layout:
              type: string
              enum:
                - fullscreen
                - right
                - left
                - split
            image:
              anyOf:
                - $ref: '#/components/schemas/ThemeAsset'
                - type: 'null'
        colors:
          $ref: '#/components/schemas/ThemeColors'
        alignment:
          type: object
          additionalProperties: false
          properties:
            welcomeAndEndings:
              type: integer
              enum:
                - 0
                - 1
                - 2
            questions:
              type: integer
              enum:
                - 0
                - 1
                - 2
            logo:
              type: integer
              enum:
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
        size:
          type: object
          additionalProperties: false
          properties:
            welcomeAndEndings:
              type: integer
              enum:
                - 0
                - 1
                - 2
            questions:
              type: integer
              enum:
                - 0
                - 1
                - 2
        font:
          type: string
          examples:
            - Inter
        corners:
          type: integer
          enum:
            - 0
            - 1
            - 2
        logoPlacement:
          type: object
          additionalProperties: false
          properties:
            align:
              type: string
              enum:
                - left
                - center
                - right
            vertical:
              type: string
              enum:
                - inside
                - overlap
                - below
        layout:
          type: object
          additionalProperties: false
          properties:
            pageWidth:
              type: string
              description: CSS width.
            baseFontSize:
              type: string
              description: CSS font size.
        logoSize:
          type: object
          additionalProperties: true
          properties:
            width:
              type: number
            height:
              type: number
            radius:
              type: number
        coverHeight:
          type: string
        inputs:
          type: object
          additionalProperties: false
          properties:
            width:
              type: string
              description: CSS width.
            height:
              type: string
              description: CSS height.
            background:
              type: string
              description: CSS color.
            placeholder:
              type: string
              description: CSS color.
            border:
              type: string
              description: CSS color.
            borderWidth:
              type: number
              description: Border width in pixels.
            radius:
              type: number
              description: Corner radius in pixels.
            marginBottom:
              type: number
              description: Bottom margin in pixels.
            paddingX:
              type: number
              description: Horizontal padding in pixels.
        buttons:
          type: object
          additionalProperties: false
          properties:
            width:
              type: string
              description: CSS width.
            height:
              type: string
              description: CSS height.
            alignment:
              type: string
              enum:
                - left
                - center
                - right
            fontSize:
              type: number
              description: Font size in pixels.
            radius:
              type: number
              description: Corner radius in pixels.
            background:
              type: string
              description: CSS color.
            text:
              type: string
              description: CSS color.
            marginY:
              type: number
              description: Vertical margin in pixels.
            paddingX:
              type: number
              description: Horizontal padding in pixels.
        customCss:
          type: string
          description: Custom CSS applied to the form. Pro.
        theme:
          type: string
          enum:
            - light
            - dark
          description: Initial color mode.
    FormStatus:
      type: string
      enum:
        - draft
        - published
        - deleted
    FormType:
      type: string
      enum:
        - SINGLE
        - MULTI
        - CONVERSATIONAL
      description: >-
        Form presentation model. CONVERSATIONAL is reserved for a future
        renderer and currently returns 422 UNSUPPORTED_FORM_TYPE when used for
        creation.
    ErrorDetail:
      type: object
      additionalProperties: true
    BlockType:
      type: string
      enum:
        - welcome
        - ending
        - date
        - file-upload
        - phone-number
        - email
        - website
        - payment
        - statement
        - group
        - short-text
        - long-text
        - ranking
        - opinion-scale
        - rating
        - matrix
        - number
        - multiple-choice
        - picture-choice
        - yes-no
        - dropdown
        - legal
        - address
        - contact-info
        - time
        - color
        - currency
        - slider
        - gate
        - signature
        - coordinates
        - captcha
        - video
        - pdf
        - text
        - divider
        - label
        - heading-1
        - heading-2
        - heading-3
        - page-break
        - logic
        - hidden-field
        - image
        - audio
        - checkboxes
    Choice:
      type: object
      required:
        - id
        - label
      properties:
        id:
          type: string
        label:
          type: string
        image: {}
        color:
          type: string
          description: Optional CSS color associated with the choice.
        row_id:
          type: string
          description: Optional row grouping identifier.
        alt:
          type: string
          description: Alternative text for a picture choice.
    BlockProperties:
      type: object
      additionalProperties: true
      description: >-
        Type-specific block settings. Unsupported combinations are ignored by
        the renderer.
      properties:
        buttonText:
          type: string
          description: Welcome or ending button label.
        buttonLink:
          type: string
          format: uri
          description: Ending button destination.
        shareButtons:
          type: boolean
          description: Show social sharing actions on a welcome or ending block.
        maxChars:
          type: integer
          minimum: -1
          description: Maximum text length; -1 disables the limit.
        min:
          type: number
          description: Minimum numeric value.
        max:
          type: number
          description: Maximum numeric value.
        minVal:
          type: boolean
          description: Enable the minimum numeric bound.
        maxVal:
          type: boolean
          description: Enable the maximum numeric bound.
        dateFormat:
          type: string
          enum:
            - DDMMYYYY
            - MMDDYYYY
            - YYYYMMDD
        dateSeparator:
          type: string
          description: Date separator such as /, -, or .
        disabledDays:
          type: integer
          minimum: 1
          maximum: 9
        beforeDate:
          type: string
          format: date-time
        afterDate:
          type: string
          format: date-time
        specificDates:
          type: array
          items:
            type: string
            format: date-time
        weekStartsOn:
          type: integer
          minimum: 1
          maximum: 7
        quotationMarks:
          type: boolean
          description: Wrap a statement in quotation marks.
        multiSelection:
          type: boolean
          description: Allow more than one choice.
        randomize:
          type: boolean
          description: Shuffle choices for each respondent.
        alphaOrder:
          type: boolean
          description: Sort choices alphabetically.
        defaultCountry:
          type: string
          description: ISO 3166-1 alpha-2 default country code.
        from:
          type: number
          description: Start of an opinion scale.
        to:
          type: number
          description: End of an opinion scale.
        scaleStep:
          type: number
          description: Step interval for a scale or slider.
        limit:
          type: integer
          minimum: 1
          description: Maximum number of uploaded files.
        currency:
          type: string
          description: ISO 4217 currency code.
        amount:
          type: string
          description: Payment amount represented as a decimal string.
        paymentGateway:
          type: string
          description: Configured payment gateway key, for example stripe.
        showFields:
          type: boolean
          description: Show split date fields.
        showDatePicker:
          type: boolean
          description: Show a date picker.
        showLabels:
          type: boolean
          description: Show picture-choice labels.
        superSize:
          type: boolean
          description: Use the large picture-choice layout.
        otherOption:
          type: boolean
          description: Add an Other choice.
        otherText:
          type: string
          description: Custom label for the Other choice.
        horizontalAlign:
          type: boolean
          description: Lay choices out horizontally.
        verticalAlign:
          type: boolean
          description: Stack choices vertically.
        perRow:
          type: integer
          minimum: 1
        imageAlign:
          type: string
          enum:
            - left
            - center
            - right
        altText:
          type: boolean
          description: Enable custom alternative text.
        imageAlt:
          type: string
          description: Alternative text for an image block.
        imageWidth:
          type: number
          description: Rendered image width.
        icon:
          type: string
          enum:
            - star
            - heart
        firstLabel:
          type: string
          description: Start label for an opinion scale.
        secondLabel:
          type: string
          description: Middle label for an opinion scale.
        thirdLabel:
          type: string
          description: End label for an opinion scale.
        leftLabel:
          type: boolean
          description: Show the left scale label.
        centerLabel:
          type: boolean
          description: Show the center scale label.
        rightLabel:
          type: boolean
          description: Show the right scale label.
        addressOrContact:
          type: object
          additionalProperties: false
          description: >-
            Per-part visibility and required state for address and contact-info
            blocks.
          properties:
            firstName:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            lastName:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            email:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            phone:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            company:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            address:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            address2:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            city:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            state:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            zip:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
            country:
              type: object
              additionalProperties: false
              properties:
                hide:
                  type: boolean
                required:
                  type: boolean
        legalText:
          type: string
          description: Legal copy or linked terms.
        legalType:
          type: integer
          enum:
            - 1
            - 2
          description: 1 = URL, 2 = inline text.
        legalStopFurther:
          type: boolean
          description: Prevent submission when consent is rejected.
        showSeconds:
          type: boolean
          description: Include seconds in a time input.
        showTimePicker:
          type: boolean
          description: Show the time picker UI.
        videoLink:
          type: string
          format: uri
        pdfLink:
          type: string
          format: uri
        embedLink:
          type: string
          format: uri
        captchaType:
          type: string
          enum:
            - turnstile
            - reCaptcha
            - hCaptcha
        placeholderText:
          type: string
          description: Placeholder shown by compatible input blocks.
        numberFormat:
          type: string
          description: Number formatting preset.
        allowedFiles:
          type: array
          items:
            type: string
          description: Allowed file extensions or MIME types.
        multipleFiles:
          type: boolean
          description: Allow multiple file uploads.
        maxFileSize:
          type: boolean
          description: Enable the configured maximum file-size restriction.
        hide:
          type: boolean
          description: Hide a hidden-field block from the visible form.
        showActions:
          type: boolean
          description: Show logic actions in the editor.
        badgeType:
          type: string
          enum:
            - 'off'
            - number
            - letter
        colorOption:
          type: boolean
          description: Enable per-choice colors.
        rule:
          type: object
          additionalProperties: true
          description: Logic rule definition for a logic block.
        image:
          type: object
          additionalProperties: true
          description: Optional block image and layout data.
    UtmSettings:
      type: object
      additionalProperties: false
      properties:
        campaign:
          type: boolean
          description: Capture utm_campaign.
        content:
          type: boolean
          description: Capture utm_content.
        medium:
          type: boolean
          description: Capture utm_medium.
        source:
          type: boolean
          description: Capture utm_source.
        term:
          type: boolean
          description: Capture utm_term.
    ThemeAsset:
      type: object
      additionalProperties: true
      description: Image asset used for a logo or background.
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
        width:
          type: number
          minimum: 0
        height:
          type: number
          minimum: 0
        base64:
          type: string
          description: Optional data URL or encoded preview.
    ThemeColors:
      type: object
      additionalProperties: true
      properties:
        background:
          type: string
          description: CSS color for background.
          examples:
            - '#3969D9'
        foreground:
          type: string
          description: CSS color for foreground.
          examples:
            - '#3969D9'
        card:
          type: string
          description: CSS color for card.
          examples:
            - '#3969D9'
        cardForeground:
          type: string
          description: CSS color for cardForeground.
          examples:
            - '#3969D9'
        popover:
          type: string
          description: CSS color for popover.
          examples:
            - '#3969D9'
        popoverForeground:
          type: string
          description: CSS color for popoverForeground.
          examples:
            - '#3969D9'
        primary:
          type: string
          description: CSS color for primary.
          examples:
            - '#3969D9'
        primaryForeground:
          type: string
          description: CSS color for primaryForeground.
          examples:
            - '#3969D9'
        secondary:
          type: string
          description: CSS color for secondary.
          examples:
            - '#3969D9'
        secondaryForeground:
          type: string
          description: CSS color for secondaryForeground.
          examples:
            - '#3969D9'
        muted:
          type: string
          description: CSS color for muted.
          examples:
            - '#3969D9'
        mutedForeground:
          type: string
          description: CSS color for mutedForeground.
          examples:
            - '#3969D9'
        accent:
          type: string
          description: CSS color for accent.
          examples:
            - '#3969D9'
        accentForeground:
          type: string
          description: CSS color for accentForeground.
          examples:
            - '#3969D9'
        destructive:
          type: string
          description: CSS color for destructive.
          examples:
            - '#3969D9'
        destructiveForeground:
          type: string
          description: CSS color for destructiveForeground.
          examples:
            - '#3969D9'
        border:
          type: string
          description: CSS color for border.
          examples:
            - '#3969D9'
        input:
          type: string
          description: CSS color for input.
          examples:
            - '#3969D9'
        ring:
          type: string
          description: CSS color for ring.
          examples:
            - '#3969D9'
        text:
          type: string
          description: CSS color for text.
          examples:
            - '#3969D9'
        chart1:
          type: string
          description: CSS color for chart1.
          examples:
            - '#3969D9'
        chart2:
          type: string
          description: CSS color for chart2.
          examples:
            - '#3969D9'
        chart3:
          type: string
          description: CSS color for chart3.
          examples:
            - '#3969D9'
        chart4:
          type: string
          description: CSS color for chart4.
          examples:
            - '#3969D9'
        chart5:
          type: string
          description: CSS color for chart5.
          examples:
            - '#3969D9'
        sidebar:
          type: string
          description: CSS color for sidebar.
          examples:
            - '#3969D9'
        sidebarForeground:
          type: string
          description: CSS color for sidebarForeground.
          examples:
            - '#3969D9'
        sidebarPrimary:
          type: string
          description: CSS color for sidebarPrimary.
          examples:
            - '#3969D9'
        sidebarPrimaryForeground:
          type: string
          description: CSS color for sidebarPrimaryForeground.
          examples:
            - '#3969D9'
        sidebarAccent:
          type: string
          description: CSS color for sidebarAccent.
          examples:
            - '#3969D9'
        sidebarAccentForeground:
          type: string
          description: CSS color for sidebarAccentForeground.
          examples:
            - '#3969D9'
        sidebarBorder:
          type: string
          description: CSS color for sidebarBorder.
          examples:
            - '#3969D9'
        sidebarRing:
          type: string
          description: CSS color for sidebarRing.
          examples:
            - '#3969D9'
        dark:
          $ref: '#/components/schemas/ThemePalette'
    ThemePalette:
      type: object
      additionalProperties:
        type: string
      properties:
        background:
          type: string
          description: CSS color for background.
          examples:
            - '#3969D9'
        foreground:
          type: string
          description: CSS color for foreground.
          examples:
            - '#3969D9'
        card:
          type: string
          description: CSS color for card.
          examples:
            - '#3969D9'
        cardForeground:
          type: string
          description: CSS color for cardForeground.
          examples:
            - '#3969D9'
        popover:
          type: string
          description: CSS color for popover.
          examples:
            - '#3969D9'
        popoverForeground:
          type: string
          description: CSS color for popoverForeground.
          examples:
            - '#3969D9'
        primary:
          type: string
          description: CSS color for primary.
          examples:
            - '#3969D9'
        primaryForeground:
          type: string
          description: CSS color for primaryForeground.
          examples:
            - '#3969D9'
        secondary:
          type: string
          description: CSS color for secondary.
          examples:
            - '#3969D9'
        secondaryForeground:
          type: string
          description: CSS color for secondaryForeground.
          examples:
            - '#3969D9'
        muted:
          type: string
          description: CSS color for muted.
          examples:
            - '#3969D9'
        mutedForeground:
          type: string
          description: CSS color for mutedForeground.
          examples:
            - '#3969D9'
        accent:
          type: string
          description: CSS color for accent.
          examples:
            - '#3969D9'
        accentForeground:
          type: string
          description: CSS color for accentForeground.
          examples:
            - '#3969D9'
        destructive:
          type: string
          description: CSS color for destructive.
          examples:
            - '#3969D9'
        destructiveForeground:
          type: string
          description: CSS color for destructiveForeground.
          examples:
            - '#3969D9'
        border:
          type: string
          description: CSS color for border.
          examples:
            - '#3969D9'
        input:
          type: string
          description: CSS color for input.
          examples:
            - '#3969D9'
        ring:
          type: string
          description: CSS color for ring.
          examples:
            - '#3969D9'
        text:
          type: string
          description: CSS color for text.
          examples:
            - '#3969D9'
        chart1:
          type: string
          description: CSS color for chart1.
          examples:
            - '#3969D9'
        chart2:
          type: string
          description: CSS color for chart2.
          examples:
            - '#3969D9'
        chart3:
          type: string
          description: CSS color for chart3.
          examples:
            - '#3969D9'
        chart4:
          type: string
          description: CSS color for chart4.
          examples:
            - '#3969D9'
        chart5:
          type: string
          description: CSS color for chart5.
          examples:
            - '#3969D9'
        sidebar:
          type: string
          description: CSS color for sidebar.
          examples:
            - '#3969D9'
        sidebarForeground:
          type: string
          description: CSS color for sidebarForeground.
          examples:
            - '#3969D9'
        sidebarPrimary:
          type: string
          description: CSS color for sidebarPrimary.
          examples:
            - '#3969D9'
        sidebarPrimaryForeground:
          type: string
          description: CSS color for sidebarPrimaryForeground.
          examples:
            - '#3969D9'
        sidebarAccent:
          type: string
          description: CSS color for sidebarAccent.
          examples:
            - '#3969D9'
        sidebarAccentForeground:
          type: string
          description: CSS color for sidebarAccentForeground.
          examples:
            - '#3969D9'
        sidebarBorder:
          type: string
          description: CSS color for sidebarBorder.
          examples:
            - '#3969D9'
        sidebarRing:
          type: string
          description: CSS color for sidebarRing.
          examples:
            - '#3969D9'
  responses:
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource does not exist or is not accessible.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PreconditionFailed:
      description: The If-Match value does not match the current form revision.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationFailed:
      description: The request body or query is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: The key exceeded 100 requests in one minute.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        A scoped key with the of_live_ prefix, generated from Profile > API
        keys.

````