Skip to content

Templates API

List universal content

GEThttps://email.growthdept.ai/api/template-universal-content

Sort by created, id, name, updated, ascending or descending (put - in front).

Rate limits

Burst: 75/s

Steady: 750/m

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

Scopes

templates:read

Operation id

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

Query parameters

array of strings

Attributes of template-universal-content resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • id: equals, any
  • name: equals, any
  • created: greater-than, greater-or-equal, less-than, less-or-equal
  • updated: greater-than, greater-or-equal, less-than, less-or-equal
  • definition.content_type: equals
  • definition.type: equals

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 100default 20

Default 20, at most 100.

Pagination guide

string

Default id.

Sorting guide

Headers

stringrequireddefault 2026-10-15

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

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 4 fields
    • typestringrequired

      template-universal-content
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringrequired

      • definitionone ofcan be null

        One option: ButtonBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          button
        • dataobjectrequiredcan be null

          data: 4 fields
          • contentstringrequiredcan be null

          • propertiesobjectrequired

            properties: 1 field
            • hrefstringcan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 25 fields
            • background_colorstringcan be null

            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_colorstringcan be null

            • border_radiusintegercan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • colorstringcan be null

            • drop_shadow_colorstringcan be null

            • font_familystringcan be null

            • font_sizeintegercan be null

            • font_stylestringcan be null

              italicnormal
            • font_weightstringcan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • letter_spacingintegercan be null

            • mobile_stretch_contentbooleancan be null

            • stretchbooleancan be null

            • text_alignstringcan be null

              centerleftright
            • text_decorationstringcan be null

        One option: CouponBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          coupon
        • dataobjectrequiredcan be null

          data: 4 fields
          • contentstringrequiredcan be null

          • propertiesobjectrequired

            properties: 4 fields
            • coupon_idstringcan be null

            • couponstringcan be null

            • header_enabledbooleancan be null

            • hrefstringcan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 30 fields
            • background_colorstringcan be null

            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_colorstringcan be null

            • border_radiusintegercan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • colorstringcan be null

            • font_familystringcan be null

            • font_sizeintegercan be null

            • font_stylestringcan be null

              italicnormal
            • font_weightstringcan be null

            • header_font_familystringcan be null

            • header_font_sizeintegercan be null

            • header_padding_bottomintegercan be null

            • header_padding_leftintegercan be null

            • header_padding_rightintegercan be null

            • header_padding_topintegercan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • letter_spacingintegercan be null

            • mobile_stretch_contentbooleancan be null

            • stretchbooleancan be null

            • text_alignstringcan be null

              centerleftright
            • text_decorationstringcan be null

        One option: DropShadowBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          drop_shadow
        • dataobjectrequiredcan be null

          data: 2 fields
          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 7 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • mobile_stretch_contentbooleancan be null

            • shadow_colorstringcan be null

              darklightmedium
        One option: HeaderBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          header
        • dataobjectrequiredcan be null

          data: 2 fields
          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 30 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_colorstringcan be null

            • border_radiusintegercan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • colorstringcan be null

            • desktop_layoutstringcan be null

              centeredinlinelinksstacked
            • font_familystringcan be null

            • font_sizeintegercan be null

            • font_stylestringcan be null

              italicnormal
            • font_weightstringcan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • item_alignstringcan be null

              centerleftright
            • item_spacingintegercan be null

            • item_spacing_typestringcan be null

              automanual
            • letter_spacingintegercan be null

            • logo_alignstringcan be null

              centerleftright
            • logo_link_spacingintegercan be null

            • mobile_layoutstringcan be null

              inlinelinkslinks-stackedlogo-stackedstacked
            • mobile_spacingintegercan be null

            • mobile_wrapbooleancan be null

            • text_decorationstringcan be null

            • vertical_alignstringcan be null

              baselinebottommiddletop
        • subblocksarray of objectscan be null

          One option: HeaderLinkSubBlock
          • idstringcan be null

          • typestringrequired

            header_link_bar_button
          • background_colorstringcan be null

          • contentstringcan be null

          • drop_shadow_colorstringcan be null

          • hrefstringcan be null

          • show_onstringcan be null

            alldesktopmobile
          One option: HeaderImageSubBlock
          • idstringcan be null

          • typestringrequired

            header_link_bar_image
          • alt_textstringcan be null

          • asset_idstringcan be null

          • background_colorstringcan be null

          • heightintegercan be null

          • hrefstringcan be null

          • max_widthintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • srcstringcan be null

          • widthintegercan be null

          One option: HeaderLogoSubBlock
          • idstringcan be null

          • typestringrequired

            header_link_bar_logo
          • alt_textstringcan be null

          • asset_idstringcan be null

          • heightintegercan be null

          • hrefstringcan be null

          • max_widthintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • srcstringcan be null

          • widthintegercan be null

        One option: HorizontalRuleBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          horizontal_rule
        • dataobjectrequiredcan be null

          data: 2 fields
          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 9 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_colorstringcan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • mobile_stretch_contentbooleancan be null

        One option: HTMLBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          html
        • dataobjectrequired

          data: 2 fields
          • contentstringrequired

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

        One option: ImageBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          image
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesone ofrequired

            One option: StaticImageBlockProperties
            • dynamicbooleanrequiredcan be null

              false
            • alt_textstringcan be null

            • asset_idstringcan be null

            • cropping_propertiesobjectcan be null

              cropping_properties: 7 fields
              • aspect_ratiostringcan be null

              • asset_idstringcan be null

              • heightintegercan be null

              • srcstringcan be null

              • widthintegercan be null

              • xintegercan be null

              • yintegercan be null

            • hrefstringcan be null

            • srcstringcan be null

            One option: DynamicImageBlockProperties
            • dynamicbooleanrequired

              true
            • alt_textstringcan be null

            • hrefstringcan be null

            • srcstringcan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 20 fields
            • alignstringcan be null

              centerleftright
            • background_colorstringcan be null

            • block_background_colorstringcan be null

            • block_border_colorstringcan be null

            • block_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • block_border_widthintegercan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_radiusintegercan be null

            • full_width_mobilebooleancan be null

            • heightintegercan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • max_widthintegercan be null

            • mobile_stretch_contentbooleancan be null

            • widthintegercan be null

        One option: ProductBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          product
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesone ofrequired

            One option: StaticProductBlockProperties
            • is_ai_generatedbooleancan be null

            • is_prebuilt_contentbooleancan be null

            • item_subtype_idintegercan be null

            • show_buttonbooleancan be null

            • show_original_pricebooleancan be null

            • show_pricebooleancan be null

            • show_ratingbooleancan be null

            • show_rating_countbooleancan be null

            • show_titlebooleancan be null

            • show_title_linksbooleancan be null

            • title_placeholderstringcan be null

            • dynamicbooleanrequiredcan be null

              false
            • show_descriptionbooleancan be null

            • localize_for_recipientbooleancan be null

            • languagestringcan be null

            • regionstringcan be null

            One option: DynamicProductBlockProperties
            • is_ai_generatedbooleancan be null

            • is_prebuilt_contentbooleancan be null

            • item_subtype_idintegercan be null

            • show_buttonbooleancan be null

            • show_original_pricebooleancan be null

            • show_pricebooleancan be null

            • show_ratingbooleancan be null

            • show_rating_countbooleancan be null

            • show_titlebooleancan be null

            • show_title_linksbooleancan be null

            • title_placeholderstringcan be null

            • dynamicbooleanrequired

              true
            • button_textstringcan be null

            • feedstringcan be null

            • feed_offsetintegercan be null

            • is_nbpbooleancan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 78 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • button_alignmentstringcan be null

              centerleftright
            • button_background_colorstringcan be null

            • button_border_colorstringcan be null

            • button_border_radiusintegercan be null

            • button_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • button_border_widthintegercan be null

            • button_drop_shadow_colorstringcan be null

            • button_font_colorstringcan be null

            • button_font_familystringcan be null

            • button_font_sizeintegercan be null

            • button_font_stylestringcan be null

              italicnormal
            • button_font_weightstringcan be null

            • button_letter_spacingintegercan be null

            • button_padding_bottomintegercan be null

            • button_padding_leftintegercan be null

            • button_padding_rightintegercan be null

            • button_padding_topintegercan be null

            • button_text_decorationstringcan be null

            • description_font_colorstringcan be null

            • description_font_familystringcan be null

            • description_font_sizeintegercan be null

            • description_font_stylestringcan be null

              italicnormal
            • description_font_weightstringcan be null

            • description_letter_spacingintegercan be null

            • description_padding_bottomintegercan be null

            • description_padding_topintegercan be null

            • description_text_decorationstringcan be null

            • item_border_colorstringcan be null

            • item_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • item_border_widthintegercan be null

            • item_max_heightintegercan be null

            • item_padding_bottomintegercan be null

            • item_padding_leftintegercan be null

            • item_padding_rightintegercan be null

            • item_padding_topintegercan be null

            • item_text_alignmentstringcan be null

              centerleftright
            • layoutstringcan be null

              horizontalvertical-left-imagevertical-right-image
            • num_columnsintegercan be null

            • num_rowsintegercan be null

            • original_price_font_colorstringcan be null

            • original_price_font_familystringcan be null

            • original_price_font_sizeintegercan be null

            • original_price_font_stylestringcan be null

              italicnormal
            • original_price_font_weightstringcan be null

            • original_price_text_decorationstringcan be null

            • price_font_colorstringcan be null

            • price_font_familystringcan be null

            • price_font_sizeintegercan be null

            • price_font_stylestringcan be null

              italicnormal
            • price_font_weightstringcan be null

            • price_letter_spacingintegercan be null

            • price_padding_bottomintegercan be null

            • price_padding_topintegercan be null

            • price_text_decorationstringcan be null

            • rating_font_colorstringcan be null

            • rating_font_familystringcan be null

            • rating_font_sizeintegercan be null

            • rating_font_stylestringcan be null

              italicnormal
            • rating_font_weightstringcan be null

            • rating_letter_spacingintegercan be null

            • rating_padding_bottomintegercan be null

            • rating_padding_topintegercan be null

            • rating_text_decorationstringcan be null

            • stack_on_mobilebooleancan be null

            • title_font_colorstringcan be null

            • title_font_familystringcan be null

            • title_font_sizeintegercan be null

            • title_font_stylestringcan be null

              italicnormal
            • title_font_weightstringcan be null

            • title_letter_spacingintegercan be null

            • title_padding_bottomintegercan be null

            • title_padding_topintegercan be null

            • title_text_decorationstringcan be null

        • subblocksarray of objectscan be null

          subblocks: 15 fields
          • idstringcan be null

          • typestringrequired

            product
          • product_idstringcan be null

          • external_idstringcan be null

          • autogenerate_linkbooleancan be null

          • button_textstringcan be null

          • descriptionstringcan be null

          • image_urlstringcan be null

          • linkstringcan be null

          • namestringcan be null

          • original_pricestringcan be null

          • pricestringcan be null

          • currency_codestringcan be null

          • titlestringcan be null

          • urlstringcan be null

        One option: ReviewBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          review
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesone ofrequired

            One option: StaticReviewBlockProperties
            • show_ratingbooleancan be null

            • show_reviewer_namebooleancan be null

            • show_product_namebooleancan be null

            • show_variant_namebooleancan be null

            • show_verified_badgebooleancan be null

            • author_placeholderstringcan be null

            • quote_placeholderstringcan be null

            • product_name_placeholderstringcan be null

            • product_variant_name_placeholderstringcan be null

            • verified_badge_languagestringcan be null

              dutchenglishfrenchgermanhungarianitalianjapanesekoreanportuguesespanish
            • dynamicbooleanrequiredcan be null

              false
            • authorstringcan be null

            • product_namestringcan be null

            • product_variant_namestringcan be null

            • quotestringcan be null

            • starsintegercan be null

            • verifiedbooleancan be null

            One option: DynamicReviewBlockProperties
            • show_ratingbooleancan be null

            • show_reviewer_namebooleancan be null

            • show_product_namebooleancan be null

            • show_variant_namebooleancan be null

            • show_verified_badgebooleancan be null

            • author_placeholderstringcan be null

            • quote_placeholderstringcan be null

            • product_name_placeholderstringcan be null

            • product_variant_name_placeholderstringcan be null

            • verified_badge_languagestringcan be null

              dutchenglishfrenchgermanhungarianitalianjapanesekoreanportuguesespanish
            • dynamicbooleanrequired

              true
            • fallback_optionsstringcan be null

              high-quality-reviewhigh-quality-review-or-staticno-reviewrecentstatic-only
            • fallback_content_typestringcan be null

              fullquote
            • fallback_review_idstringcan be null

            • product_selection_modestringcan be null

              automaticmanual
            • product_idstringcan be null

            • product_event_variablestringcan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 54 fields
            • author_alignstringcan be null

              centerleftright
            • author_colorstringcan be null

            • author_font_familystringcan be null

            • author_font_sizeintegercan be null

            • author_font_stylestringcan be null

              italicnormal
            • author_font_weightstringcan be null

            • author_letter_spacingintegercan be null

            • author_text_decorationstringcan be null

            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_radiusintegercan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • empty_star_colorstringcan be null

            • layoutstringcan be null

              big-quotescentered-in-quote-bubblecentered-rating-firstcentered-review-firstcleanleft-alignedmessage-bubblerating-highlightright-aligned-with-quotation-iconsquarestacked-cardsubtle-background
            • product_name_alignstringcan be null

              centerleftright
            • product_name_colorstringcan be null

            • product_name_font_familystringcan be null

            • product_name_font_sizeintegercan be null

            • product_name_font_stylestringcan be null

              italicnormal
            • product_name_font_weightstringcan be null

            • product_name_letter_spacingintegercan be null

            • product_name_text_decorationstringcan be null

            • quote_alignstringcan be null

              centerleftright
            • quote_colorstringcan be null

            • quote_font_familystringcan be null

            • quote_font_sizeintegercan be null

            • quote_font_stylestringcan be null

              italicnormal
            • quote_font_weightstringcan be null

            • quote_letter_spacingintegercan be null

            • quote_line_heightnumbercan be null

            • quote_stylestringcan be null

              linesquarestandard
            • quote_text_decorationstringcan be null

            • shadow_colorstringcan be null

            • star_colorstringcan be null

            • star_sizestringcan be null

              largemediumsmall
            • star_rating_shapestringcan be null

              circleheartstar
            • star_icon_spacingintegercan be null

            • star_alignmentstringcan be null

              centerleftright
            • text_area_bg_colorstringcan be null

            • text_area_border_colorstringcan be null

            • verified_colorstringcan be null

            • verified_font_familystringcan be null

            • verified_font_sizeintegercan be null

            • verified_font_stylestringcan be null

              italicnormal
            • verified_font_weightstringcan be null

            • verified_letter_spacingintegercan be null

            • verified_text_decorationstringcan be null

            • verified_badge_colorstringcan be null

              darkdefaultlight
            • verified_badge_sizeintegercan be null

            • verified_badge_stylestringcan be null

              badge-and-textbadge-onlytext-only
        One option: SocialBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          social
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesobjectrequired

            properties: 1 field
            • show_labelsbooleancan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 16 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • icon_alignstringcan be null

              centerleftright
            • icon_colorstringcan be null

              blackdefaultgreywhite
            • icon_sizestringcan be null

              largemediumsmall
            • icon_spacingintegercan be null

            • label_colorstringcan be null

            • label_font_familystringcan be null

            • label_font_sizeintegercan be null

            • label_font_stylestringcan be null

              italicnormal
            • label_text_decorationstringcan be null

            • label_font_weightstringcan be null

            • stack_on_mobilebooleancan be null

        • subblocksarray of objectscan be null

          One option: SocialIconSubBlock
          • idstringcan be null

          • typestringrequired

            social_link_icon
          • custom_asset_idstringcan be null

          • custom_srcstringcan be null

          • custom_sizeintegercan be null

          • labelstringcan be null

          • link_typestringcan be null

            Show 20 allowed values
            androidapplecustomdiscordemailfacebookgoogle-plusinstagramlinkedinpinterestrsssnapchatthreadstiktoktwitchtwitterwhatsappx-twitteryelpyoutube
          • link_urlstringcan be null

          One option: SocialSpacerSubBlock
          • idstringcan be null

          • typestringrequired

            social_link_spacer
          • widthintegercan be null

        One option: SpacerBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          spacer
        • dataobjectrequiredcan be null

          data: 2 fields
          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 2 fields
            • background_colorstringcan be null

            • heightintegercan be null

        One option: SplitBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          split
        • dataobjectrequiredcan be null

          data: 2 fields
          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 8 fields
            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • column_widthsstringcan be null

            • mobile_stack_orderstringcan be null

              ltrno-stackrtl
            • padding_in_betweenintegercan be null

        • subblocksarray of objectscan be null

          One option: TableTextSubBlock
          • contentstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • colorstringcan be null

          • font_familystringcan be null

          • font_sizeintegercan be null

          • font_stylestringcan be null

            italicnormal
          • font_weightstringcan be null

          • letter_spacingintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • text_decorationstringcan be null

          • idstringcan be null

          • typestringrequired

            table_text
          One option: TableImageSubBlock
          • dynamicbooleancan be null

          • alt_textstringcan be null

          • asset_idstringcan be null

          • hrefstringcan be null

          • srcstringcan be null

          • widthintegercan be null

          • heightintegercan be null

          • image_widthintegercan be null

          • image_alignstringcan be null

            centerleftright
          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • cropped_asset_idstringcan be null

          • cropped_srcstringcan be null

          • cropping_aspect_ratiostringcan be null

          • cropping_heightintegercan be null

          • cropping_widthintegercan be null

          • cropping_xintegercan be null

          • cropping_yintegercan be null

          • idstringcan be null

          • typestringrequired

            table_image
          One option: TableHtmlSubBlock
          • contentstringcan be null

          • show_onstringcan be null

            alldesktopmobile
          • idstringcan be null

          • typestringrequired

            table_html
        One option: TableBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          table
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesone ofrequired

            One option: StaticTableBlockProperties
            • dynamicbooleanrequiredcan be null

              false
            • num_columnsintegercan be null

            • show_headersbooleancan be null

            One option: DynamicTableBlockProperties
            • dynamicbooleanrequired

              true
            • num_columnsintegercan be null

            • row_content_repeatobjectcan be null

              row_content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • show_headersbooleancan be null

            • show_fallback_contentbooleancan be null

            • show_static_rowbooleancan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 38 fields
            • block_background_colorstringcan be null

            • block_border_colorstringcan be null

            • block_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • block_border_widthintegercan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • cell_horizontal_border_colorstringcan be null

            • cell_horizontal_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • cell_horizontal_border_widthintegercan be null

            • cell_padding_bottomintegercan be null

            • cell_padding_leftintegercan be null

            • cell_padding_rightintegercan be null

            • cell_padding_topintegercan be null

            • cell_vertical_alignstringcan be null

              baselinebottommiddletop
            • cell_vertical_border_colorstringcan be null

            • cell_vertical_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • cell_vertical_border_widthintegercan be null

            • header_background_colorstringcan be null

            • header_font_colorstringcan be null

            • header_font_familystringcan be null

            • header_font_sizeintegercan be null

            • header_font_stylestringcan be null

              italicnormal
            • header_font_weightstringcan be null

            • header_letter_spacingintegercan be null

            • header_line_heightnumbercan be null

            • header_padding_bottomintegercan be null

            • header_padding_leftintegercan be null

            • header_padding_rightintegercan be null

            • header_padding_topintegercan be null

            • header_text_decorationstringcan be null

            • table_background_colorstringcan be null

            • table_font_colorstringcan be null

            • table_font_familystringcan be null

            • table_font_sizeintegercan be null

            • table_text_alignstringcan be null

              centerleftright
            • use_legacy_mobile_paddingbooleancan be null

        • subblocksarray of objectscan be null

          One option: TableHeaderSubBlock
          • contentstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • colorstringcan be null

          • font_familystringcan be null

          • font_sizeintegercan be null

          • font_stylestringcan be null

            italicnormal
          • font_weightstringcan be null

          • letter_spacingintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • text_decorationstringcan be null

          • idstringcan be null

          • typestringrequired

            table_header
          One option: TableHtmlSubBlock
          • contentstringcan be null

          • show_onstringcan be null

            alldesktopmobile
          • idstringcan be null

          • typestringrequired

            table_html
          One option: TableImageSubBlock
          • dynamicbooleancan be null

          • alt_textstringcan be null

          • asset_idstringcan be null

          • hrefstringcan be null

          • srcstringcan be null

          • widthintegercan be null

          • heightintegercan be null

          • image_widthintegercan be null

          • image_alignstringcan be null

            centerleftright
          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • cropped_asset_idstringcan be null

          • cropped_srcstringcan be null

          • cropping_aspect_ratiostringcan be null

          • cropping_heightintegercan be null

          • cropping_widthintegercan be null

          • cropping_xintegercan be null

          • cropping_yintegercan be null

          • idstringcan be null

          • typestringrequired

            table_image
          One option: TableTextSubBlock
          • contentstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • colorstringcan be null

          • font_familystringcan be null

          • font_sizeintegercan be null

          • font_stylestringcan be null

            italicnormal
          • font_weightstringcan be null

          • letter_spacingintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • text_decorationstringcan be null

          • idstringcan be null

          • typestringrequired

            table_text
          One option: TableFallbackHtmlSubBlock
          • contentstringcan be null

          • show_onstringcan be null

            alldesktopmobile
          • idstringcan be null

          • typestringrequired

            table_fallback_html
          One option: TableFallbackImageSubBlock
          • dynamicbooleancan be null

          • alt_textstringcan be null

          • asset_idstringcan be null

          • hrefstringcan be null

          • srcstringcan be null

          • widthintegercan be null

          • heightintegercan be null

          • image_widthintegercan be null

          • image_alignstringcan be null

            centerleftright
          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • cropped_asset_idstringcan be null

          • cropped_srcstringcan be null

          • cropping_aspect_ratiostringcan be null

          • cropping_heightintegercan be null

          • cropping_widthintegercan be null

          • cropping_xintegercan be null

          • cropping_yintegercan be null

          • idstringcan be null

          • typestringrequired

            table_fallback_image
          One option: TableFallbackTextSubBlock
          • contentstringcan be null

          • cell_text_alignstringcan be null

            centerleftright
          • colorstringcan be null

          • font_familystringcan be null

          • font_sizeintegercan be null

          • font_stylestringcan be null

            italicnormal
          • font_weightstringcan be null

          • letter_spacingintegercan be null

          • show_onstringcan be null

            alldesktopmobile
          • table_column_widthstringcan be null

          • text_decorationstringcan be null

          • idstringcan be null

          • typestringrequired

            table_fallback_text
        One option: TextBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          text
        • dataobjectrequired

          data: 3 fields
          • contentstringrequired

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 25 fields
            • background_colorstringcan be null

            • block_background_colorstringcan be null

            • block_border_colorstringcan be null

            • block_border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • block_border_widthintegercan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • colorstringcan be null

            • extra_css_classstringcan be null

            • font_familystringcan be null

            • font_sizeintegercan be null

            • font_stylestringcan be null

              italicnormal
            • font_weightstringcan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • letter_spacingintegercan be null

            • line_heightnumbercan be null

            • mobile_stretch_contentbooleancan be null

            • text_alignstringcan be null

              centerleftright
            • text_decorationstringcan be null

            • text_table_layoutstringcan be null

              autofixedinheritinitial
        One option: VideoBlockV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          block
        • typestringrequired

          video
        • dataobjectrequiredcan be null

          data: 3 fields
          • propertiesobjectrequired

            properties: 7 fields
            • raw_asset_idstringcan be null

            • src_asset_idstringcan be null

            • alt_textstringcan be null

            • hrefstringcan be null

            • overlay_togglebooleancan be null

            • raw_srcstringcan be null

            • srcstringcan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 19 fields
            • alignstringcan be null

              centerleftright
            • background_colorstringcan be null

            • block_background_colorstringcan be null

            • block_padding_bottomintegercan be null

            • block_padding_leftintegercan be null

            • block_padding_rightintegercan be null

            • block_padding_topintegercan be null

            • border_colorstringcan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • full_width_mobilebooleancan be null

            • heightintegercan be null

            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • max_widthintegercan be null

            • mobile_stretch_contentbooleancan be null

            • widthintegercan be null

        One option: SectionV1
        • idstringcan be null

        • data_idstringcan be null

        • universal_idstringcan be null

        • content_typestringrequired

          section
        • typestringrequired

          section
        • dataobjectrequired

          data: 3 fields
          • propertiesobjectrequired

            properties: 2 fields
            • is_ai_generatedbooleancan be null

            • is_prebuilt_contentbooleancan be null

          • display_optionsobjectrequired

            display_options: 5 fields
            • show_onstringcan be null

              alldesktopmobile
            • content_repeatobjectcan be null

              content_repeat: 2 fields
              • repeat_forstringrequired

              • item_aliasstringrequired

            • visibilityobjectcan be null

              visibility: 3 fields
              • checkstringcan be null

              • definitionstringcan be null

              • is_code_onlybooleancan be null

            • layout_typestringcan be null

            • layout_configobjectcan be null

          • stylesobjectrequired

            styles: 19 fields
            • background_asset_idstringcan be null

            • background_colorstringcan be null

            • background_formatstringcan be null

              autocontaincoverinitialrepeat
            • background_image_full_widthbooleancan be null

            • background_positionstringcan be null

              center-bottomcenter-centercenter-topleft-bottomleft-centerleft-topright-bottomright-centerright-top
            • background_repeatbooleancan be null

            • background_urlstringcan be null

            • border_colorstringcan be null

            • border_stylestringcan be null

              dasheddottedgrooveinsetnoneoutsetridgesolid
            • border_widthintegercan be null

            • column_alignstringcan be null

              baselinebottommiddletop
            • column_directionstringcan be null

              ltrno-stackrtl
            • content_colorstringcan be null

            • content_color_typestringcan be null

              nonesectiontemplate
            • inner_padding_bottomintegercan be null

            • inner_padding_leftintegercan be null

            • inner_padding_rightintegercan be null

            • inner_padding_topintegercan be null

            • stack_on_mobilebooleancan be null

        • rowsarray of objectscan be null

          rows: 4 fields
          • idstringcan be null

          • data_idstringcan be null

          • dataobjectrequired

            data: 1 field
            • stylesobjectrequired

              styles: 1 field
              • column_layoutstringcan be null

                1-column-full-width2-columns-25%-75%2-columns-33%-67%2-columns-67%-33%2-columns-75%-25%2-columns-equal-width3-columns-25%-25%-50%3-columns-25%-50%-25%3-columns-50%-25%-25%3-columns-equal-width4-columns-equal-width
          • columnsarray of objectscan be null

            columns: 4 fields
            • idstringcan be null

            • data_idstringcan be null

            • dataobjectcan be null

            • blocksarray of objectscan be null

              One option: ButtonBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                button
              • dataobjectrequiredcan be null

              One option: CouponBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                coupon
              • dataobjectrequiredcan be null

              One option: DropShadowBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                drop_shadow
              • dataobjectrequiredcan be null

              One option: HeaderBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                header
              • dataobjectrequiredcan be null

              • subblocksarray of objectscan be null

              One option: HorizontalRuleBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                horizontal_rule
              • dataobjectrequiredcan be null

              One option: HTMLBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                html
              • dataobjectrequired

              One option: ImageBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                image
              • dataobjectrequiredcan be null

              One option: ProductBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                product
              • dataobjectrequiredcan be null

              • subblocksarray of objectscan be null

              One option: ReviewBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                review
              • dataobjectrequiredcan be null

              One option: SocialBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                social
              • dataobjectrequiredcan be null

              • subblocksarray of objectscan be null

              One option: SpacerBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                spacer
              • dataobjectrequiredcan be null

              One option: SplitBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                split
              • dataobjectrequiredcan be null

              • subblocksarray of objectscan be null

              One option: TableBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                table
              • dataobjectrequiredcan be null

              • subblocksarray of objectscan be null

              One option: TextBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                text
              • dataobjectrequired

              One option: VideoBlockV1
              • idstringcan be null

              • data_idstringcan be null

              • universal_idstringcan be null

              • content_typestringrequired

                block
              • typestringrequired

                video
              • dataobjectrequiredcan be null

      • createdstring (date-time)required

      • updatedstring (date-time)required

      • screenshot_statusstringrequired

        completedfailedgeneratingnever_generatednot_renderablestale
      • screenshot_urlstringrequired

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • 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