Skip to content

Forms API

Update a form

PATCHhttps://email.growthdept.ai/api/forms/{id}

Only submitted attributes change. definition replaces the stored one, but live versions cannot be edited.

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

forms:write

Operation id

update_form The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of form resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      form
    • idstringrequired

    • attributesobjectrequired

      attributes: 2 fields
      • definitionobject

        definition: 1 field
        • versionsarray of objectsrequired

          versions: 15 fields
          • idinteger

          • stepsarray of objectsrequired

            steps: 5 fields
            • idstringcan be null

            • temporary_idstringcan be null

            • columnsarray of objectsrequired

              columns: 3 fields
              • idstringcan be null

              • rowsarray of objects

              • stylesobject

            • namestringcan be null

            • stepsarray of objects

              steps: 5 fields
              • idstringcan be null

              • temporary_idstringcan be null

              • columnsarray of objectsrequired

              • namestringcan be null

              • stepsarray of objects

          • triggersarray of objects

            One option: object
            • idstringcan be null

            • typestringrequired

              after_close_or_submit_timeout
            • propertiesobject

              properties: 1 field
              • timeout_daysinteger

            One option: object
            • idstringcan be null

            • typestringrequired

              cart_content
            • propertiesobject

              properties: 3 fields
              • valueobject

              • itemsobject

              • productobject

            One option: object
            • idstringcan be null

            • typestringrequired

              cart_item_count
            • propertiesobject

              properties: 2 fields
              • comparisonobject

              • valueobject

            One option: object
            • idstringcan be null

            • typestringrequired

              cart_product
            • propertiesobject

              properties: 2 fields
              • typeobject

              • valuestringcan be null

            One option: object
            • idstringcan be null

            • typestringrequired

              cart_value
            • propertiesobject

              properties: 2 fields
              • comparisonobject

              • valuenumbercan be null

            One option: object
            • idstringcan be null

            • typestringrequired

              channel
            • propertiesobjectrequired

              properties: 1 field
              • channelstringrequired

                emailsms
            One option: object
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              custom_javascript
            One option: object
            • idstringcan be null

            • typestringrequired

              delay
            • propertiesobject

              properties: 1 field
              • secondsinteger

            One option: object
            • idstringcan be null

            • typestringrequired

              device
            • propertiesobject

              properties: 1 field
              • devicestring

                bothdesktopmobile
            One option: object
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              exit_intent
            One option: object
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              identified_profiles
            One option: object
            • idstringcan be null

            • typestringrequired

              lists_and_segments
            • propertiesobjectrequired

              properties: 2 fields
              • allow_listobject

              • deny_listobject

            One option: object
            • idstringcan be null

            • typestringrequired

              location
            • propertiesobjectrequired

              properties: 2 fields
              • allow_listobject

              • deny_listobject

            One option: object
            • idstringcan be null

            • typestringrequired

              page_visits
            • propertiesobject

              properties: 1 field
              • pagesinteger

            One option: object
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              previously_submitted
            One option: object
            • idstringcan be null

            • typestringrequired

              profile_event_tracked
            • propertiesobjectrequired

              properties: 3 fields
              • metricstringcan be null

              • property_filtersobject

              • delay_secondsobject

            One option: object
            • idstringcan be null

            • typestringrequired

              scroll_percentage
            • propertiesobject

              properties: 1 field
              • percentageinteger

            One option: object
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              unidentified_profiles
            One option: object
            • idstringcan be null

            • typestringrequired

              url_patterns
            • propertiesobject

              properties: 2 fields
              • allow_listobject

              • deny_listobject

            One option: object
            • idstringcan be null

            • typestringrequired

              back_in_stock
            • propertiesobject

              properties: 2 fields
              • tag_allowlistarray of strings

              • tag_blocklistarray of strings

          • teasersarray of objects

            teasers: 10 fields
            • idstringcan be null

            • contentstringrequired

            • display_orderstring

              afterbeforebefore_and_after
            • teaser_typestring

              circlecornerrectangle
            • locationstring

              bottom_centerbottom_leftbottom_rightcenter_leftcenter_righttop_centertop_lefttop_right
            • sizestring

              customlargemediumsmall
            • custom_sizeinteger

            • stylesobject

              styles: 6 fields
              • background_colorstring

              • drop_shadowobject

              • corner_radiusinteger

              • background_imageobject

              • close_buttonobject

              • marginobject

            • close_buttonboolean

            • device_typestring

              bothdesktopmobile
          • dynamic_buttonobject

            dynamic_button: 3 fields
            • idstringcan be null

            • typestringrequired

              BACK_IN_STOCK_OPEN
            • dataobjectrequired

              data: 4 fields
              • labelstring

              • displaystring

                NEXT_TOREPLACE
              • text_stylesobject

              • button_stylesobject

          • namestringcan be null

          • stylesobject

            styles: 17 fields
            • wrap_contentboolean

              false
            • border_stylesobject

              border_styles: 4 fields
              • radiusinteger

              • colorstringcan be null

              • styleobject

              • thicknessobject

            • close_buttonobject

              close_button: 7 fields
              • background_colorstring

              • outline_colorstring

              • colorstring

              • strokenumber

              • sizeinteger

              • marginobject

              • positionobject

            • marginobject

              margin: 4 fields
              • leftinteger

              • rightinteger

              • topinteger

              • bottominteger

            • paddingobject

              padding: 4 fields
              • leftinteger

              • rightinteger

              • topinteger

              • bottominteger

            • minimum_heightinteger

            • widthstring

              customfulllargemediumsmall
            • custom_widthinteger

            • background_imageobject

              background_image: 2 fields
              • stylesobject

              • propertiesobjectrequired

            • background_colorstringcan be null

            • input_stylesobject

              input_styles: 10 fields
              • text_stylesobject

              • label_colorstring

              • text_colorstring

              • placeholder_colorstring

              • background_colorstring

              • border_colorstring

              • border_focus_colorstring

              • focus_outline_colorstring

              • corner_radiusinteger

              • field_heightinteger

            • drop_shadowobject

              drop_shadow: 3 fields
              • enabledboolean

              • blurinteger

              • colorstringcan be null

            • overlay_colorstring

            • rich_text_stylesobject

              rich_text_styles: 8 fields
              • bodyobject

              • linkobject

              • h1object

              • h2object

              • h3object

              • h4object

              • h5object

              • h6object

            • mobile_overlayobject

              mobile_overlay: 2 fields
              • colorstringcan be null

              • enabledboolean

                false
            • banner_stylesobject

              banner_styles: 3 fields
              • desktop_positionstring

                bottomtop
              • mobile_positionstring

                bottomtop
              • scroll_with_pageboolean

            • custom_cssobject

              custom_css: 2 fields
              • enabledboolean

              • cssstring

          • propertiesobject

            properties: 6 fields
            • side_image_settingsobject

              side_image_settings: 3 fields
              • sizestring

                largemediumsmall
              • alignmentstring

                leftright
              • device_typearray of strings

            • click_outside_to_closearray of strings

            • rule_based_trigger_evaluationstring

            • record_utm_params_on_submitboolean

            • show_close_buttonboolean

            • accessible_namestringcan be null

          • typestring

            bannerembedflyoutfull_screenpopup
          • locationstring

          • statusstring

            draftlive
          • ab_testboolean

          • specialtiesarray of strings

          • channelstring

            IN_APPWEB
          • message_priorityinteger

      • namestring

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 4 fields
    • typestringrequired

      form
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • statusstringrequired

        draftlive
      • ab_testbooleanrequired

      • namestringrequired

      • definitionobjectrequired

        definition: 1 field
        • versionsarray of objectsrequired

          versions: 15 fields
          • idintegercan be null

          • stepsarray of objectsrequired

            steps: 5 fields
            • idstringcan be null

            • temporary_idstringcan be null

            • columnsarray of objectsrequired

              columns: 3 fields
              • idstringcan be null

              • rowsarray of objects

              • stylesobjectcan be null

            • namestringcan be null

            • stepsarray of objectscan be null

              steps: 5 fields
              • idstringcan be null

              • temporary_idstringcan be null

              • columnsarray of objectsrequired

              • namestringcan be null

              • stepsarray of objectscan be null

          • triggersarray of objects

            One option: AfterCloseTimeout
            • idstringcan be null

            • typestringrequired

              after_close_or_submit_timeout
            • propertiesobject

              properties: 1 field
              • timeout_daysinteger

            One option: CartContent
            • idstringcan be null

            • typestringrequired

              cart_content
            • propertiesobject

              properties: 3 fields
              • valueobjectcan be null

              • itemsobjectcan be null

              • productobjectcan be null

            One option: CartItemCount
            • idstringcan be null

            • typestringrequired

              cart_item_count
            • propertiesobject

              properties: 2 fields
              • comparisonstringcan be null

                equalsgreater_thanless_than
              • valueintegercan be null

            One option: CartProduct
            • idstringcan be null

            • typestringrequired

              cart_product
            • propertiesobject

              properties: 2 fields
              • typestringcan be null

                brandcategoriesidname
              • valuestringcan be null

            One option: CartValue
            • idstringcan be null

            • typestringrequired

              cart_value
            • propertiesobject

              properties: 2 fields
              • comparisonstringcan be null

                equalsgreater_thanless_than
              • valuenumbercan be null

            One option: Channel
            • idstringcan be null

            • typestringrequired

              channel
            • propertiesobjectrequired

              properties: 1 field
              • channelstringrequired

                emailsms
            One option: CustomJavascript
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              custom_javascript
            One option: Delay
            • idstringcan be null

            • typestringrequired

              delay
            • propertiesobject

              properties: 1 field
              • secondsinteger

            One option: Device
            • idstringcan be null

            • typestringrequired

              device
            • propertiesobject

              properties: 1 field
              • devicestring

                bothdesktopmobile
            One option: ExitIntent
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              exit_intent
            One option: IdentifiedProfiles
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              identified_profiles
            One option: ListsAndSegments
            • idstringcan be null

            • typestringrequired

              lists_and_segments
            • propertiesobjectrequired

              properties: 2 fields
              • allow_listarray of stringscan be null

              • deny_listarray of stringscan be null

            One option: Location
            • idstringcan be null

            • typestringrequired

              location
            • propertiesobjectrequired

              properties: 2 fields
              • allow_listarray of objectscan be null

              • deny_listarray of objectscan be null

            One option: PageVisits
            • idstringcan be null

            • typestringrequired

              page_visits
            • propertiesobject

              properties: 1 field
              • pagesinteger

            One option: PreviouslySubmitted
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              previously_submitted
            One option: ProfileEventTracked
            • idstringcan be null

            • typestringrequired

              profile_event_tracked
            • propertiesobjectrequired

              properties: 3 fields
              • metricstringcan be null

              • property_filtersarray of objectscan be null

              • delay_secondsintegercan be null

            One option: Scroll
            • idstringcan be null

            • typestringrequired

              scroll_percentage
            • propertiesobject

              properties: 1 field
              • percentageinteger

            One option: UnidentifiedProfiles
            • idstringcan be null

            • propertiesobject

            • typestringrequired

              unidentified_profiles
            One option: URLPatterns
            • idstringcan be null

            • typestringrequired

              url_patterns
            • propertiesobject

              properties: 2 fields
              • allow_listarray of stringscan be null

              • deny_listarray of stringscan be null

            One option: BackInStock
            • idstringcan be null

            • typestringrequired

              back_in_stock
            • propertiesobject

              properties: 2 fields
              • tag_allowlistarray of strings

              • tag_blocklistarray of strings

          • teasersarray of objects

            teasers: 10 fields
            • idstringcan be null

            • contentstringrequired

            • display_orderstring

              afterbeforebefore_and_after
            • teaser_typestring

              circlecornerrectangle
            • locationstring

              bottom_centerbottom_leftbottom_rightcenter_leftcenter_righttop_centertop_lefttop_right
            • sizestring

              customlargemediumsmall
            • custom_sizeintegercan be null

            • stylesobject

              styles: 6 fields
              • background_colorstring

              • drop_shadowobject

              • corner_radiusinteger

              • background_imageobjectcan be null

              • close_buttonobject

              • marginobject

            • close_buttonboolean

            • device_typestring

              bothdesktopmobile
          • dynamic_buttonobjectcan be null

            dynamic_button: 3 fields
            • idstringcan be null

            • typestringrequired

              BACK_IN_STOCK_OPEN
            • dataobjectrequired

              data: 4 fields
              • labelstring

              • displaystring

                NEXT_TOREPLACE
              • text_stylesobject

              • button_stylesobject

          • namestringcan be null

          • stylesobject

            styles: 17 fields
            • wrap_contentboolean

              false
            • border_stylesobjectcan be null

              border_styles: 4 fields
              • radiusinteger

              • colorstringcan be null

              • stylestringcan be null

                dasheddottedsolid
              • thicknessintegercan be null

            • close_buttonobject

              close_button: 7 fields
              • background_colorstring

              • outline_colorstring

              • colorstring

              • strokenumber

              • sizeinteger

              • marginobject

              • positionstringcan be null

                leftright
            • marginobject

              margin: 4 fields
              • leftinteger

              • rightinteger

              • topinteger

              • bottominteger

            • paddingobject

              padding: 4 fields
              • leftinteger

              • rightinteger

              • topinteger

              • bottominteger

            • minimum_heightinteger

            • widthstring

              customfulllargemediumsmall
            • custom_widthintegercan be null

            • background_imageobjectcan be null

              background_image: 2 fields
              • stylesobject

              • propertiesobjectrequired

            • background_colorstringcan be null

            • input_stylesobject

              input_styles: 10 fields
              • text_stylesobject

              • label_colorstring

              • text_colorstring

              • placeholder_colorstring

              • background_colorstring

              • border_colorstring

              • border_focus_colorstring

              • focus_outline_colorstring

              • corner_radiusinteger

              • field_heightinteger

            • drop_shadowobject

              drop_shadow: 3 fields
              • enabledboolean

              • blurinteger

              • colorstringcan be null

            • overlay_colorstring

            • rich_text_stylesobject

              rich_text_styles: 8 fields
              • bodyobject

              • linkobject

              • h1object

              • h2object

              • h3object

              • h4object

              • h5object

              • h6object

            • mobile_overlayobjectcan be null

              mobile_overlay: 2 fields
              • colorstringcan be null

              • enabledboolean

                false
            • banner_stylesobjectcan be null

              banner_styles: 3 fields
              • desktop_positionstring

                bottomtop
              • mobile_positionstring

                bottomtop
              • scroll_with_pageboolean

            • custom_cssobject

              custom_css: 2 fields
              • enabledboolean

              • cssstring

          • propertiesobject

            properties: 6 fields
            • side_image_settingsobjectcan be null

              side_image_settings: 3 fields
              • sizestring

                largemediumsmall
              • alignmentstring

                leftright
              • device_typearray of strings

            • click_outside_to_closearray of stringscan be null

            • rule_based_trigger_evaluationstringcan be null

              allany
            • record_utm_params_on_submitboolean

            • show_close_buttonboolean

            • accessible_namestringcan be null

          • typestring

            bannerembedflyoutfull_screenpopup
          • locationstringcan be null

            bottom_centerbottom_leftbottom_rightcenter_leftcenter_righttop_centertop_lefttop_right
          • statusstring

            draftlive
          • ab_testboolean

          • specialtiesarray of strings

          • channelstring

            IN_APPWEB
          • message_priorityinteger

      • created_atstring (date-time)required

      • updated_atstring (date-time)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject