Create a site block

Creates a new site block with a name, type, and optional schema. The slug is auto-generated from the name.

Required permissions
site_blocks.create
POST/site-blocks
Base URLhttps://api.lynkow.com/v1

Request body
required

  • seo
    object

    SEO metadata for the block: meta title/description, keywords, Open Graph, Twitter Card, canonical URL, noindex, and sitemap priority/changefreq

    • ogUrl
      string
    • noIndex
      boolean
    • ogImage
      union
    • ogTitle
      string
    • keywords
      array<string>
    • metaTitle
      string
    • ogSiteName
      string
    • twitterCard
      enum

      One of: summarysummary_large_imageappplayer

    • canonicalUrl
      string
    • twitterImage
      union
    • twitterTitle
      string
    • ogDescription
      string
    • metaDescription
      string
    • sitemapPriority
      number
    • sitemapChangefreq
      enum

      One of: alwayshourlydailyweeklymonthlyyearlynever

    • twitterDescription
      string
  • data
    object

    Resource data object

    • name
      string
      required

      Required. Display name. 1-255 characters

    • path
      union

      Storefront URL path with a `.md` suffix. Any path that resolves to a published content or page can be appended with `.md` to receive the Markdown rendering.

    • slug
      string
      required

      Required. URL-friendly identifier, unique per site and locale. 1-100 characters

    • tags
      array<string>

      Max 10 characters. Array of strings

    • type
      enum
      required

      Required. Resource type. One of: global, page

      One of: globalpage

    • schema
      object
      required

      Required. Field schema definition

      • fields
        array<any>
        required
    • llmContent
      union

      Markdown content for the page surfaced to LLM crawlers (e.g. llms.txt)

    • jsonLdGraph
      array<object>

      Max 50 characters. Array of objects

      • id
        string
      • data
        any
        required
      • type
        string
        required
      • source
        enum

        One of: presetcustom

    • jsonLdConfig
      object

      JSON-LD structured-data configuration: enabled flag, schema type (WebPage, AboutPage, ContactPage, FAQPage, CollectionPage), include organization/breadcrumb flags, and custom fields

      • type
        enum
        required

        One of: WebPageAboutPageContactPageFAQPageCollectionPage

      • enabled
        boolean
        required
      • customFields
        object
        • includeBreadcrumb
          boolean
          required
        • includeOrganization
          boolean
          required
      • jsonLdExclusions
        array<string>

        Max 50 characters. Array of strings

      Feedback

      Was this page helpful?