---
title: "Create a form"
method: POST
path: "/v1/forms"
tags: ["Forms"]
---

# Create a form

`POST /v1/forms`

## Request

- Base URL: `https://api.mailrith.com`
- URL: `https://api.mailrith.com/v1/forms`
- Auth: HTTP bearer

Creates a form in the authenticated workspace.

## Headers

- `Idempotency-Key` string

## Request body

- union
  - object
    - `name` string, required
    - `definition` FormDefinition, required
      - `display` FormDisplaySettings
        - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
        - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
        - `scrollPercentage` integer, nullable
        - `timingSeconds` integer, nullable
        - `triggerClassName` string
        - `triggerId` string
        - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
        - `slideInPosition` 'left' | 'right' | 'null', nullable
      - `builder` object, required
        - `definition` LandingPageDefinition, required
          - `blocks` LandingPageBlock[], required
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `successBlocks` LandingPageBlock[]
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `customCss` string
        - `styles` LandingPageStyles, required
          - `headingFontFamily` string
          - `fontFamily` string
          - `fontSize` number
          - `backgroundColor` string
          - `textColor` string
          - `accentColor` string
        - `settings` LandingPageSettings, required
          - `seo` object
            - `title` string
            - `description` string
          - `social` object
            - `imageAssetId` string, nullable
            - `imageUrl` string
            - `altText` string
          - `analytics` object
            - `trackingCode` string
          - `form` FormStyles
            - `formBackgroundColor` string
            - `textColor` string
            - `accentColor` string
            - `fieldBackgroundColor` string
            - `fieldBorderColor` string
            - `fieldTextColor` string
            - `errorTextColor` string
            - `formBorderColor` string
            - `buttonTextColor` string
            - `rowGap` number
            - `columnGap` number
            - `formBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderWidthCustom` LandingPageBoxEdges
              - …
            - `fieldBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderWidthCustom` LandingPageBoxEdges
              - …
            - `formBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `fieldBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `buttonBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `buttonBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `submitButtonLabel` string
            - `submitBehavior` 'message' | 'redirect'
            - `redirectUrl` string
            - `forwardSubscriberData` boolean
            - `forwardedSubscriberFields` string[]
            - `tagIds` string[]
            - `doubleOptIn` DoubleOptInSettings
              - …
          - `display` FormDisplaySettings
            - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
            - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
            - `scrollPercentage` integer, nullable
            - `timingSeconds` integer, nullable
            - `triggerClassName` string
            - `triggerId` string
            - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
            - `slideInPosition` 'left' | 'right' | 'null', nullable
    - `starting_point_id` string: Creates the Form from this canonical starting point. Do not also provide definition.
  - object
    - `name` string, required
    - `definition` FormDefinition
      - `display` FormDisplaySettings
        - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
        - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
        - `scrollPercentage` integer, nullable
        - `timingSeconds` integer, nullable
        - `triggerClassName` string
        - `triggerId` string
        - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
        - `slideInPosition` 'left' | 'right' | 'null', nullable
      - `builder` object, required
        - `definition` LandingPageDefinition, required
          - `blocks` LandingPageBlock[], required
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `successBlocks` LandingPageBlock[]
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `customCss` string
        - `styles` LandingPageStyles, required
          - `headingFontFamily` string
          - `fontFamily` string
          - `fontSize` number
          - `backgroundColor` string
          - `textColor` string
          - `accentColor` string
        - `settings` LandingPageSettings, required
          - `seo` object
            - `title` string
            - `description` string
          - `social` object
            - `imageAssetId` string, nullable
            - `imageUrl` string
            - `altText` string
          - `analytics` object
            - `trackingCode` string
          - `form` FormStyles
            - `formBackgroundColor` string
            - `textColor` string
            - `accentColor` string
            - `fieldBackgroundColor` string
            - `fieldBorderColor` string
            - `fieldTextColor` string
            - `errorTextColor` string
            - `formBorderColor` string
            - `buttonTextColor` string
            - `rowGap` number
            - `columnGap` number
            - `formBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderWidthCustom` LandingPageBoxEdges
              - …
            - `fieldBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderWidthCustom` LandingPageBoxEdges
              - …
            - `formBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `fieldBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `buttonBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `buttonBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `submitButtonLabel` string
            - `submitBehavior` 'message' | 'redirect'
            - `redirectUrl` string
            - `forwardSubscriberData` boolean
            - `forwardedSubscriberFields` string[]
            - `tagIds` string[]
            - `doubleOptIn` DoubleOptInSettings
              - …
          - `display` FormDisplaySettings
            - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
            - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
            - `scrollPercentage` integer, nullable
            - `timingSeconds` integer, nullable
            - `triggerClassName` string
            - `triggerId` string
            - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
            - `slideInPosition` 'left' | 'right' | 'null', nullable
    - `starting_point_id` string, required: Creates the Form from this canonical starting point. Do not also provide definition.

## Response `201`

Form created

- object
  - `data` Form, required
    - `self` string, required: Stable relative Public API path for retrieving this resource.
    - `id` string, required
    - `name` string, required
    - `definition` FormDefinition, required
      - `display` FormDisplaySettings
        - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
        - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
        - `scrollPercentage` integer, nullable
        - `timingSeconds` integer, nullable
        - `triggerClassName` string
        - `triggerId` string
        - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
        - `slideInPosition` 'left' | 'right' | 'null', nullable
      - `builder` object, required
        - `definition` LandingPageDefinition, required
          - `blocks` LandingPageBlock[], required
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `successBlocks` LandingPageBlock[]
            - `id` string, required
            - `type` 'section' | 'heading' | 'paragraph' | 'blockquote' | 'image' | 'video' | 'countdown' | 'testimonial' | 'logo-strip' | 'faq' | 'divider' | 'icon' | 'button' | 'form', required
            - `content` string
            - `level` 1 | 2 | 3
            - `textAlign` 'left' | 'center' | 'right' | 'justify' | 'null', nullable
            - `highlightColor` string, nullable
            - `citation` string
            - `borderColor` string, nullable
            - `backgroundColor` string, nullable
            - `textColor` string, nullable
            - `src` string
            - `altText` string
            - `caption` string
            - `href` string
            - `borderRadius` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderRadius` LandingPageBoxCorners
              - …
            - `title` string
            - `aspectRatio` '16:9' | '4:3' | '1:1' | '9:16'
            - `targetDate` string: The countdown target as an ISO 8601 date and time with an explicit UTC offset or Z suffix.
            - `label` string
            - `expiredMessage` string
            - `design` 'cards' | 'minimal' | 'inline' | 'card' | 'quote' | 'row' | 'grid' | 'bordered'
            - `accentColor` string, nullable
            - `align` 'left' | 'center' | 'right'
            - `quote` string
            - `name` string
            - `avatarUrl` string
            - `avatarAlt` string
            - `rating` number
            - `heading` string
            - `logos` LandingPageLogo[]
              - …
            - `logoHeight` number
            - `items` LandingPageFaqItem[]
              - …
            - `defaultOpenFirst` boolean
            - `iconPosition` 'start' | 'end'
            - `color` string, nullable
            - `thickness` number
            - `style` 'solid' | 'dashed' | 'dotted'
            - `iconName` string
            - `size` union
              - …
            - `cssClass` string
            - `cssId` string
            - `buttonTextColor` string
            - `borderWidth` 'none' | 'normal' | 'large' | 'custom'
            - `customBorderWidth` LandingPageBoxEdges
              - …
            - `width` 'default' | 'large' | 'full' | 'fit'
            - `openInNewTab` boolean
            - `fields` FormField[]
              - …
            - `disclaimerText` string
            - `fieldLayout` 'one-column' | 'two-column'
            - `submitLayout` 'stacked' | 'inline-email'
            - `styles` FormStyles
              - …
            - `columns` LandingPageColumn[]
              - …
            - `backgroundImageUrl` string, nullable
            - `backgroundImageOverlayOpacity` number
            - `coverViewport` boolean
            - `margin` 'none' | 'normal' | 'large' | 'custom'
            - `padding` 'none' | 'normal' | 'large' | 'custom'
            - `customMargin` LandingPageBoxEdges
              - …
            - `customPadding` LandingPageBoxEdges
              - …
            - `visibility` LandingPageVisibility
              - …
          - `customCss` string
        - `styles` LandingPageStyles, required
          - `headingFontFamily` string
          - `fontFamily` string
          - `fontSize` number
          - `backgroundColor` string
          - `textColor` string
          - `accentColor` string
        - `settings` LandingPageSettings, required
          - `seo` object
            - `title` string
            - `description` string
          - `social` object
            - `imageAssetId` string, nullable
            - `imageUrl` string
            - `altText` string
          - `analytics` object
            - `trackingCode` string
          - `form` FormStyles
            - `formBackgroundColor` string
            - `textColor` string
            - `accentColor` string
            - `fieldBackgroundColor` string
            - `fieldBorderColor` string
            - `fieldTextColor` string
            - `errorTextColor` string
            - `formBorderColor` string
            - `buttonTextColor` string
            - `rowGap` number
            - `columnGap` number
            - `formBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderWidthCustom` LandingPageBoxEdges
              - …
            - `fieldBorderWidthMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderWidthCustom` LandingPageBoxEdges
              - …
            - `formBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `formBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `fieldBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `fieldBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `buttonBorderRadiusMode` 'none' | 'normal' | 'large' | 'custom'
            - `buttonBorderRadiusCustom` LandingPageBoxCorners
              - …
            - `submitButtonLabel` string
            - `submitBehavior` 'message' | 'redirect'
            - `redirectUrl` string
            - `forwardSubscriberData` boolean
            - `forwardedSubscriberFields` string[]
            - `tagIds` string[]
            - `doubleOptIn` DoubleOptInSettings
              - …
          - `display` FormDisplaySettings
            - `format` 'inline' | 'modal' | 'slide_in' | 'sticky_bar' | 'full_page'
            - `triggerType` 'exit_intent' | 'scroll_percentage' | 'timing_seconds' | 'click_trigger' | 'null', nullable
            - `scrollPercentage` integer, nullable
            - `timingSeconds` integer, nullable
            - `triggerClassName` string
            - `triggerId` string
            - `stickyBarPosition` 'top' | 'bottom' | 'null', nullable
            - `slideInPosition` 'left' | 'right' | 'null', nullable
    - `public_token` string, required
    - `subscribers_90d` integer, required
    - `views_90d` integer, required
    - `conversion_rate_90d` number, required
    - `submit_url` string, required
    - `embed_url` string, required
    - `hosted_url` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: The request is invalid.

---

[API](https://skmtc.dev/mailrith/apis/mailrith-api.md) · [All operations](https://skmtc.dev/mailrith/apis/mailrith-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailrith/apis/mailrith-api/revisions/41f09536f2da?raw)