Folloze API

The Folloze API lets you build personalized buyer experiences programmatically — generate boards? from templates?, sync your content library, and attach the right content to the right account — all driven from your CRM, CMS, or AI pipeline.

The platform exposes two complementary REST APIs, both served from the same host (https://content-api.folloze.com). Most integrations use both:

Both APIs share the same base URL, authentication, error model, and conventions described in the next few sections. A single API token issued to your organization unlocks both.

Typical use cases

• Bulk-personalized boards — one board per target account, campaign, or event, populated from your CRM.
• AI / content pipelines — pipe LLM-generated copy and curated assets straight into Folloze.
• CMS sync — mirror an internal content library into the Folloze Content Center?.
• 1:1 deal rooms — same source asset, different presentation per opportunity, with no duplicate items in your library.

Which API do I need? #

Pick by what you're trying to ship to a buyer:

• I need a new branded page per account / campaign / event → Board Creation API. You'll start from a template and fill in titles, subtitles, CTAs, and column content.
• I need to bring a new asset into Folloze (a file, a URL, a video — from anywhere, even if it's never been in Folloze before) → Content API — POST /v1/items.
• I need to place an existing Folloze item onto a board → Content API — POST /v1/board_items, optionally with per-board title / thumbnail overrides.
• I need to search or audit items already in Folloze → Content API — GET /v1/items.

End-to-end example

A typical "generate a personalized board for an account" flow uses both APIs:

1. GET /v1/board_templates — list templates in your organization.
2. GET /v1/board_templates/:id/describe — read a template's full structure (sections, widgets, header, footer).
3. POST /v1/boards — create a new board from a template.
4. POST /v1/items — create a content item.
5. GET /v1/items — list and search content items.
6. POST /v1/board_items — place a content item on a board.

Board Creation API: overview #

The Board Creation API turns a template board in your organization into the source-of-truth for many personalized boards. You read the template's structure, fill in your content, and post it back to create a new board.

Core endpoints

Prerequisites #

1. Feature enabled. The board_creation_api feature must be enabled for your organization. Contact your Folloze account manager if it is not.
2. API token. An API token issued by Folloze (a “Content Integration Client” token). To get a token, contact your Folloze account representative — tokens are provisioned per organization and cannot be self-served.
3. A template board. A board that is defined as a template in your Folloze instance.

Authentication #

All requests are authenticated with your API token in the Authorization header, using the Basic scheme:

Authorization: Basic <your_api_token>

Requests without a valid token return 401. Requests where the API is not enabled in your Folloze organization return 403.

Required headers #

These header rules apply to both the Board Creation API and the Content API.

All POST / PUT requests

Every write call must include these headers in addition to Authorization:

Example

POST https://content-api.folloze.com/v1/items
Authorization:     Basic <your_api_token>
Content-Type:      application/json
User-Agent:        Folloze
Folloze-Initiator: Folloze

{ ... }

Base URL #

Both the Board Creation API and the Content API are served from the same host:

https://content-api.folloze.com

All endpoint paths in this documentation are relative to this base URL.

Response codes #

Concepts: sections, widgets, ribbons #

A Folloze board is built from sections (e.g. a banner, a content block, a form). Each section contains one or more widgets (the actual content — a banner widget with title / subtitle / cta) and optionally ribbon parts? (background and decorative layers).

When you call the API, you describe each section as a JSON object that mirrors the API schema of the widgets that section uses.

Ribbons (section backgrounds) #

A section's background is exposed as a ribbon object, a sibling of widgets. Sections that have no background omit the key entirely.

"ribbon": {
  "background": { "type": "color", "value": "background: #ffffff" },
  "backgroundMobile": { "type": "color", "value": "background: var(--fz-color-neutral-1000)" },
  "optimizedForMobile": false
}

Background kinds

Example: image background

"ribbon": {
  "background": {
    "type": "image",
    "url": "https://images.folloze.com/image/upload/hpifscdihf1mw21yytsy.jpg",
    "image_config": {
      "shape": "none",
      "flipX": false,
      "flipY": false,
      "filter": "none",
      "tint": { "color": "#081d4d", "alpha": 78 },
      "crop": { "x": 1, "y": 154, "width": 1723, "height": 672 }
    },
    "cover": { "width": 1920 }
  },
  "optimizedForMobile": false
}

API schema descriptors #

Each widget exposes a small, stable contract — only the fields meant for external content are exposed. For example, the Banner widget exposes:

{
  "title": "string",
  "title_size": "wide | narrow",
  "subtitle": "string",
  "subtitle_size": "wide | narrow",
  "cta": { "text": "string", "type": "string", "action": { } },
  "secondary_cta": { "text": "string", "type": "string", "action": { } },
  "promoted_form": { "type": "string" },
  "content_alignment": "string",
  "mobile_alignment": "string",
  "min_height": "short | medium | tall",
  "visibility": {
    "title": "boolean", "subtitle": "boolean", "showButtons": "boolean",
    "cta": "boolean", "secondary_cta": "boolean", "promoted_form": "boolean"
  },
  "animate": "boolean"
}

The Promo — Columns widget exposes a repeatable list of columns:

{
  "title": "string",
  "subtitle": "string",
  "cta": { "text": "string" },
  "repeatable": {
    "columns": [
      {
        "title": "string",
        "subtitle": "string",
        "paragraph": "string",
        "cta": { "text": "string" },
        "visibility": "boolean"
      }
    ]
  }
}

Other widgets follow the same pattern (Single Item, Image Section, Side-by-side, Q&A, Multi-tab, Carousel, etc.). Use GET /v1/board_templates/:id/describe to retrieve the exact descriptor for any template.

Widget catalog #

The keys inside a section's widgets object are widget keys. These are the only keys the API recognises — anything else is rejected. Several widgets are versioned variants that share one schema, so promo-columns-2 takes exactly the same fields as promo-columns.

Body & content widgets

Structural widgets

Floating widgets

These live under the top-level floating_sections array, not inside a page's sections.

"floating_sections": [
  { "type": "back-to-top", "floating_id": "f_c94a84c4",
    "widgets": { "back-to-top": { "shape": "square", "icon_color": "var(--fz-color-neutral-0)", "background_color": "var(--fz-color-primary-3)" } } },
  { "type": "contact-card",  "floating_id": "f_f2cf719d", "widgets": {} },
  { "type": "floating-form", "floating_id": "f_5163d98b", "widgets": {} }
]

Simple widget schemas

A few widgets are small enough to state in full here. For every other widget, read the descriptor from /describe.

text-section:

image-section — same as text-section plus:

side-by-side (and split-banner): title (string), subtitle (string), left (side), right (side).

Each side is discriminated by type, and only the block named by type is read — send type together with the block it names:

"side-by-side": {
  "title": "<h2>Why teams switch</h2>",
  "left":  { "type": "paragraph", "paragraph": { "title": "<div>Best of them all</div>", "visibility": { "title": true, "subtitle": true } } },
  "right": { "type": "image", "image": { "image": { "url": "https://cdn.example.com/photo.png", "alt": "Customer" }, "image_size": "medium" } }
}

html-section:

Reading the authoritative schema #

The widget descriptors are served data, not a frozen contract in this document. New widgets ship, fields are added, and enums gain values between releases of this page. Anything here that disagrees with what the API returns today, the API wins.

Build integrations so they read the shape at runtime rather than hard-coding a snapshot:

Validation is strict and positive

Writes are validated against the descriptor for each section:

• Unknown fields are rejected, not ignored. unknown field 'maxWidth' (expected one of [shape, crop, fit, flipX, flipY, filter, tint]).
• Enums are checked. expected one of [short, medium, tall], got "huge".
• Types are checked. Id fields are numbers; a numeric string fails.
• Errors name the path. Section 'board:default:s_0dfbfc74' [2].widgets.promo-columns-2.repeatable.image.image_size: ... — the section id, its index in your array, and the field path.

All of these come back as 422 with an errors array. A 500 from these endpoints is a defect, not a validation signal — report it.

Validation is per widget, not per field

Writes are partial — you send only the fields you are changing — but validation is not scoped that narrowly. Editing any field of a widget re-validates that whole widget, including fields you did not send.

This matters most where fields constrain each other. Changing an image’s shape from rectangle to square re-checks the stored crop against the new shape’s 1:1 ratio, even though you only sent shape:

// sent
"image_config": { "shape": "square" }

// rejected, because the crop already stored is 16:9
Section 'board:default:s_4a5e83a5' [0].widgets.image-section.image.image_config.crop:
  crop does not match the 1:1 ratio required by shape "square"

So when you change something that constrains another field, send both together — a new shape with the crop that fits it. Narrowing the payload does not narrow the validation.

One live exception is tracked today: some boards and templates carry a stored image_size of "medium_large" or "small_medium" that the validator rejects. It is being fixed; in the meantime map medium_large to large and small_medium to medium.

Section & widget identity #

The API matches sections by section_id — the id you receive from GET /v1/board_templates/:id/describe (stable across calls for the same template).

section_id is an opaque string. Its internal format is not part of the contract and has changed before, so treat it as a token to carry, never to parse or construct:

"section_id": "board:default:s_f316586e"

The same applies to widgets within a section: provide widget_id to update specific widgets; otherwise widgets are matched by their order.

Merge semantics #

• Omitted fields fall back to the template. If you don't include a field in your payload, the API uses the equivalent value from the template. Empty strings, on the other hand, are sent as-is and overwrite the template value.
• Nested objects are merged field-by-field — you only provide the keys you want to change.
• Repeatable arrays (e.g. repeatable.columns, tabs.items, repeatable.items) — items you don't include in your payload are removed from the new board. Include every item you want to keep.
• Sections present in the template but missing from your request are removed from the new board. Headers and footers are always preserved.

Configuring CTAs #

Call-to-action buttons? can be configured on any section that exposes a cta or secondary_cta field — headers, banners, body sections, navigation items, and carousel columns. Every CTA follows the same object shape regardless of where it appears.

CTA object

Promoted form (promoted_form)

Some widgets — the banner most notably — expose a promoted_form field alongside cta and secondary_cta. It renders a form inline in the section instead of behind a button click.

"promoted_form": {
  "type": "form",
  "form": {
    "form_id": 173866,
    "privacy_message_id": 3000,
    "form_title": "",
    "send_mail": {
      "email_template_id": 0,
      "is_enabled": false,
      "sender_type": "inviter",
      "sender": { "id": 0, "email": "" }
    }
  }
}

In practice you will use form or registration here (see form config), but any action type is accepted. Like the buttons, it is gated by visibility — set visibility.promoted_form: true or it will not render.

Button styles

The type field accepts exactly these nine values. Anything else is rejected. The concrete look of each comes from the board theme, so the same value renders differently across brands.

CTA visibility

Setting cta, secondary_cta, or promoted_form only defines what the button is — it does not make it appear. Whether a button renders is controlled by the widget's visibility map, which /describe returns alongside the content fields:

{
  "widgets": {
    "banner": {
      "cta":           { "text": "Book a demo",    "type": "flz-primary",   "action": { ... } },
      "secondary_cta": { "text": "Watch the tour", "type": "flz-secondary", "action": { ... } },
      "visibility": {
        "showButtons": true,
        "cta": true,
        "secondary_cta": true,
        "promoted_form": false
      }
    }
  }
}

Action types

The action object always has a type field that selects the behaviour, plus a sibling key of exactly the same name containing the type-specific configuration. There are no exceptions — { "type": "form", "form": { … } }, { "type": "open_content_item", "open_content_item": { … } }, and so on.

Form config (form / registration)

The form and registration actions take a full configuration object, not just an id. /describe returns the whole thing — round-trip what you don't intend to change.

"action": {
  "type": "form",
  "form": {
    "form_id": 82839,
    "privacy_message_id": 0,
    "form_title": "See how this applies to your organization",
    "success_message": "",
    "submit_redirect_url": "",
    "submit_redirect_new_tab": false,
    "columns_layout": "single",
    "send_mail": {
      "email_template_id": 0,
      "is_enabled": false,
      "sender_type": "inviter",
      "sender": { "id": 0, "email": "" }
    },
    "success_message_style": {
      "duration": 5,
      "text_color": "#ffffff",
      "background": "#000000",
      "top_line_color": "#00b0ff"
    }
  }
}

send_mail object (also used by the share action):

Example: banner with primary and secondary CTA

"cta": {
  "text": "Download the report",
  "type": "flz-primary",
  "action": {
    "type": "open_content_item",
    "open_content_item": {
      "flz_item_id": { "content_center_item_id": 775972 },
      "design": "sidebar",
      "allow_download": true
    }
  }
},
"secondary_cta": {
  "text": "Schedule a Demo",
  "type": "flz-secondary",
  "action": {
    "type": "open_url",
    "open_url": {
      "url": "https://example.com/demo",
      "open_in_new_window": true
    }
  }
}

Example: header navigation with mixed actions

"navigation": {
  "items": [
    {
      "text": "About Us",
      "type": "flz-link",
      "action": {
        "type": "anchor",
        "anchor": { "hash": "about" }
      }
    },
    {
      "text": "Contact",
      "type": "flz-link",
      "action": {
        "type": "form",
        "form": { "form_id": "86102" }
      }
    },
    {
      "text": "Share",
      "type": "flz-link",
      "action": {
        "type": "share",
        "share": { "privacy_message_id": "11869" }
      }
    }
  ]
}

Where CTAs appear

Configuring images #

Many widgets expose editable image fields?. The API accepts any public image URL or base64-encoded data URI and automatically hosts it on the Folloze CDN — no separate upload step is required.

The three image kinds

Images are not one shape. Which config keys are accepted depends on where the image sits, and sending a key the location does not accept is a 422, not a silent ignore.

Always confirm against the section’s own schema — see Reading the authoritative schema.

Image object

Editable images and icon images share the same envelope:

"image": {
  "url": "https://cdn.example.com/hero-banner.jpg",
  "image_config": { "shape": "none", "fit": "cover", "flipX": false, "flipY": false, "filter": "none" },
  "alt": "Product dashboard screenshot",
  "link": "https://example.com/product-tour"
}

Write semantics: what a new url resets

This is the single most common source of surprise when round-tripping /describe output.

So to swap an image and keep its framing, send the new url and the image_config you want in the same request. A follow-up call will not re-apply the old settings — they are already gone.

Accepted input formats

image_config fields

There is no maxWidth, maxHeight, sharpness, or artisticFilter. Sending any of them fails with unknown field '<name>' (expected one of [...]).

filter values

none, al_dente, athena, audrey, aurora, daguerre, eucalyptus, hairspray, hokusai, peacock, primavera, quartz, incognito, red_rock, sizzle, fes, linen, refresh, sonnet, ukulele, frost, zorro

crop

A pixel rectangle in the source image, with exactly four keys:

"crop": { "x": 136, "y": 45, "width": 2920, "height": 2101 }

There are no aspect, radius, crop, or unit sub-fields — earlier revisions of this page listed them in error.

cover (read-only)

cover states the minimum size the image needs to fill its slot without upscaling:

"cover": { "width": 1920 }

"cover": { "width": 240, "height": 240 }

Example: ribbon background with tint and crop

"ribbon": {
  "background": {
    "type": "image",
    "url": "https://images.folloze.com/image/upload/hpifscdihf1mw21yytsy.jpg",
    "image_config": {
      "shape": "none",
      "flipX": false,
      "flipY": false,
      "filter": "none",
      "tint": { "color": "#081d4d", "alpha": 78 },
      "crop": { "x": 1, "y": 154, "width": 1723, "height": 672 }
    },
    "cover": { "width": 1920 }
  },
  "optimizedForMobile": false
}

Sizing repeatable images: image_shape and image_size

Icon images inside a repeatable group are framed by the group, not by the individual image:

"repeatable": {
  "image": { "image_shape": "circle", "image_size": "medium" },
  "columns": [
    {
      "title": "Faster onboarding",
      "image": { "url": "https://.../rocket.png", "alt": "Rocket" }
    }
    /* ... */
  ]
}

422 unknown field 'icon' (expected one of [title, subtitle, paragraph, image, cta, back, visibility])

Where images appear

The exact paths depend on the widget — always read /describe for your template to see the actual structure.

Setting items on content sections #

You can specify which content items appear in a section at board-creation time using the item_id field type. The API accepts two value formats for every item_id field:

Supported widgets

Not yet supported

The following content widgets do not expose item sources in their API schema. Items on these sections can only be set through the Folloze UI or via POST /v1/board_items after board creation.

• content-tab / content-tab-2
• content-spread / content-spread-2

Example: single-item widget

"widgets": {
  "single-item": {
    "title": "Featured case study",
    "subtitle": "See how Acme Corp transformed their pipeline",
    "sources": {
      "flz_item_id": { "content_center_item_id": 774620 }
    }
  }
}

Example: side-by-side with video item

"widgets": {
  "side-by-side": {
    "title": "Product overview",
    "left": {
      "paragraph": { "title": "...", "subtitle": "..." },
      "video": {
        "preview_image": { "image": { "url": "https://..." } },
        "flz_item_id": { "content_center_item_id": 775972 }
      }
    },
    "right": {
      "image": { "image": { "url": "https://..." } },
      "paragraph": { "title": "...", "subtitle": "..." }
    }
  }
}

CTA: open a content item #

The open_content_item action type on any CTA opens a content item in the board’s item viewer. The flz_item_id inside open_content_item accepts the same two formats as the sources fields — plain integer or content_center_item_id object.

CTA object with open_content_item

"cta": {
  "text": "View case study",
  "type": "flz-primary",
  "action": {
    "type": "open_content_item",
    "open_content_item": {
      "flz_item_id": { "content_center_item_id": 775972 },
      "design": "sidebar",
      "allow_download": true
    }
  }
}

This action is available on every CTA across all widget types — banners, split banners, side-by-side, promo columns, Q&A, single items, etc. See Configuring CTAs for the full list of action types.

Event sections (Zoom / Simulive) #

Zoom and Simulive event sections let you embed a live or pre-recorded video experience directly into a board — with scheduling, state-specific images, and a registration CTA. Both widgets share the same schema; they differ only in the video source field.

Zoom vs. Simulive

Widget fields

Supported timezones

The scheduling.timezone field accepts the following IANA timezone identifiers:

Pacific/Honolulu, America/Anchorage, America/Los_Angeles, America/Denver, America/Chicago, America/New_York, America/Halifax, Europe/London, Europe/Berlin, Europe/Athens, Europe/Moscow, Asia/Jerusalem, Australia/Perth, Australia/Adelaide, Australia/Sydney

Image objects

Each image slot (views.pre.image, views.during.preview_image.image, views.post.placeholder.image) accepts:

Full example: Zoom event section

{
  "section_id": "board:default:s_abc12345",
  "widgets": {
    "zoom": {
      "name": "OT Security for Manufacturing",
      "title": "Live webinar: OT security for manufacturing",
      "subtitle": "Join our experts for a deep dive into securing operational technology",
      "sources": {
        "meetingUrl": "https://zoom.us/j/1234567890"
      },
      "scheduling": {
        "startTime": "2026-07-15T14:00:00Z",
        "endTime": "2026-07-15T15:00:00Z",
        "timezone": "America/New_York"
      },
      "cta": {
        "text": "Register now",
        "type": "flz-primary",
        "action": {
          "type": "form",
          "form": { "form_id": "172817" }
        }
      },
      "views": {
        "pre": {
          "image": {
            "url": "https://images.folloze.com/image/upload/v.../pre-event-banner.jpg",
            "alt": "Webinar pre-event banner"
          }
        },
        "during": {
          "preview_image": {
            "image": {
              "url": "https://images.folloze.com/image/upload/v.../during-preview.jpg",
              "alt": "Webinar in progress"
            }
          }
        },
        "post": {
          "placeholder": {
            "image": {
              "url": "https://images.folloze.com/image/upload/v.../post-event-thanks.jpg",
              "alt": "Thank you for attending"
            }
          }
        }
      }
    }
  }
}

Full example: Simulive event section

{
  "section_id": "board:default:s_def67890",
  "widgets": {
    "simulive-event": {
      "name": "Platform Walkthrough",
      "title": "On-demand demo: Platform walkthrough",
      "subtitle": "Watch our 30-minute product tour at the scheduled time",
      "sources": {
        "videoUrl": "https://videos.example.com/demo-recording.mp4"
      },
      "scheduling": {
        "startTime": "2026-08-01T10:00:00Z",
        "endTime": "2026-08-01T10:30:00Z",
        "timezone": "Europe/London"
      },
      "cta": {
        "text": "Reserve your spot",
        "type": "flz-primary",
        "action": {
          "type": "form",
          "form": { "form_id": "183920" }
        }
      },
      "views": {
        "pre": {
          "image": { "url": "https://images.folloze.com/image/upload/v.../simulive-pre.jpg" }
        },
        "during": {
          "preview_image": {
            "image": { "url": "https://images.folloze.com/image/upload/v.../simulive-during.jpg" }
          }
        },
        "post": {
          "placeholder": {
            "image": { "url": "https://images.folloze.com/image/upload/v.../simulive-post.jpg" }
          }
        }
      }
    }
  }
}

Organization media library #

Browse your organization's media library to find image URLs for board creation payloads — logos, banners, backgrounds, icons, and more. This endpoint uses the same Basic auth and base URL as the rest of the Board Creation API.

Query parameters

Image categories

Example request

curl -s "https://content-api.folloze.com/v1/organization_media?category[]=logos&category[]=banners&per_page=10&page=1&sort_col=created_at&sort_direction=desc" \
  -H "Authorization: Basic $BASE64_CREDENTIALS"

Example: fetch all images (no category filter)

curl -s "https://content-api.folloze.com/v1/organization_media?per_page=100&page=1" \
  -H "Authorization: Basic $BASE64_CREDENTIALS"

Example response

{
  "media": [
    {
      "id": 170092,
      "name": "Cloud Network Logo",
      "url": "https://images.folloze.com/image/upload/v1770730346/kpo6sywpsdpcqwi8esdq.png",
      "category": "logos",
      "created_at": "2026-03-08T13:35:19.119Z",
      "updated_at": "2026-03-08T13:35:19.119Z",
      "uploader": null
    },
    {
      "id": 169988,
      "name": "Banner Image",
      "url": "https://images.folloze.com/image/upload/v1759827103/qqtposangcjdxfymv72k.jpg",
      "category": "banners",
      "created_at": "2026-03-08T13:33:18.807Z",
      "updated_at": "2026-03-08T13:33:18.807Z",
      "uploader": null
    }
  ],
  "pagination": {
    "total_items": 47,
    "total_pages": 24,
    "current_page": 1,
    "per_page": 2
  }
}

Response fields

List forms #

Lists and searches the forms in your organization, so you can resolve a form_id for the form and registration CTA actions without opening the Folloze app.

Query parameters

Example request

curl -G "https://content-api.folloze.com/v1/forms" \
  --data-urlencode "query=demo" \
  --data-urlencode "form_type=classic" \
  --data-urlencode "sort_col=name" \
  --data-urlencode "sort_direction=asc" \
  --data-urlencode "per_page=10" \
  -H "Authorization: Basic <your_api_token>" \
  -H "User-Agent: Folloze" \
  -H "Folloze-Initiator: Folloze"

Example response

{
  "forms": [
    { "id": 12634, "name": "Book a demo",        "form_type": "classic",  "updated_at": "2026-08-14T09:22:11.000Z" },
    { "id": 12871, "name": "Demo request (EMEA)", "form_type": "marketo", "updated_at": "2026-09-02T16:40:03.000Z" }
  ],
  "pagination": {
    "total_items": 2,
    "total_pages": 1,
    "current_page": 1,
    "per_page": 10
  }
}

Response fields

Errors

List templates #

Returns every template board in your organization with its id, name, and description. Use this to discover which templates are available before fetching schemas or creating boards — especially helpful when you don't already know the template ids.

Example request

curl https://content-api.folloze.com/v1/board_templates \
  -H "Authorization: Basic $FOLLOZE_API_TOKEN"

const res = await fetch(
  "https://content-api.folloze.com/v1/board_templates",
  { headers: { Authorization: `Basic ${FOLLOZE_API_TOKEN}` } }
);
const templates = await res.json();

import requests
res = requests.get(
    "https://content-api.folloze.com/v1/board_templates",
    headers={"Authorization": f"Basic {FOLLOZE_API_TOKEN}"},
)
templates = res.json()

Example response

[
  {
    "id": 178297,
    "name": "CSM: Account Resource Center",
    "description": "A customer-success hub for sharing onboarding guides, success plans, and key contacts with each account. Use as the home base for ongoing customer engagement. #csm #customer-success"
  },
  {
    "id": 155459,
    "name": "[Template] Digital Sales Room",
    "description": "Digital Sales room for Folloze - \n\nHow to use:\n\nWithin the content section there are categories labelled \"Hidden\" where you an pull in the most used content straight into the actual categories. \n\n #Template #sales"
  },
  {
    "id": 165922,
    "name": "[Template] GeneratorAI",
    "description": "Pre-wired template for boards generated by AI pipelines — every section's titles, subtitles, and CTAs are designed to be filled programmatically. Pair with a content pipeline that calls POST /v1/boards. #generative #template"
  },
  {
    "id": 152644,
    "name": "[BuyEx 3.0 Template] ABM 1:1",
    "description": "1:1 personalized buyer experience for ABM plays — branded for a single target account, with sections for tailored value props, case studies, and a curated content library. #abm #buyex"
  }
]

Response fields

Errors

Describe template / board #

Returns the full structure of a template or any existing board: every body section (with the API schema of its widgets pre-populated with the current content), plus the header and footer, all in the format used for creation. Useful for “round-tripping” — read it, modify it, and post it back to create a new board.

The response is keyed by page. Every board has a main_page. Boards that include a registration page also have a registration_page key with its own sections, header, and footer. Alongside the pages, the top level carries theme_id — the id of the board theme applied to this board or template (null when none is set).

Example response

{
  "theme_id": 777,
  "main_page": {
    "header": {
      "section_id": "board:default:s_f316586e",
      "type": "header",
      "name": "Header - original POC",
    "widgets": {
      "header": {
        "primary_logo": {
          "image": {
            "url": "https://images.folloze.com/image/upload/v1759506309/vuo2cfwtclkhewhd5ryb.png"
          }
        },
        "secondary_logo": {
          "image": {
            "url": "https://images.folloze.com/image/upload/v1776690426/aqmsxd15kdpeoj3pm3vi.svg"
          }
        },
        "cta": {
          "text": "Contact Us",
          "type": "flz-secondary",
          "action": {
            "type": "open_url",
            "open_url": {
              "url": ""
            }
          }
        },
        "color": {
          "tag_line": "#000000"
        },
        "visibility": {
          "primary_logo": true,
          "show_logos": true,
          "show_symbols": false,
          "secondary_logo": true,
          "tag_line": false,
          "cta": false,
          "share_button": false,
          "navigation": false
        },
        "navigation": {}
      },
      "banner": {
        "title": "<div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading2\"><span style=\"color: var(--fz-color-primary-1);\">Global. Simple. Unified. </span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading2\"><span style=\"color: var(--fz-color-primary-1);\">It’s the Power of One</span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading3\"><span style=\"text-align: left;\"><br></span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading3\"><span style=\"text-align: left; color: var(--fz-color-primary-1);\">How JLL will empower </span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading3\"><span style=\"text-align: left; color: var(--fz-color-primary-1);\">[insert target’s sector]</span><span style=\"text-align: left;\"> </span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading3\"><span style=\"color: var(--fz-color-primary-1);\"><br></span></div><div style=\"--fz-marker-color: var(--fz-color-neutral-0); text-align: center;\" class=\"ql-style-heading3\"><br></div>",
        "subtitle": "<div style=\"text-align: center;\" class=\"ql-style-heading4\"><span style=\"color: var(--fz-color-primary-1);\">Enhance productivity, services and employee experiences with data center and workspace management solutions from JLL.</span></div>",
        "cta": {
          "text": "Read your business case now",
          "type": "flz-primary",
          "action": {
            "type": "open_content_item",
            "open_content_item": {}
          }
        },
        "secondary_cta": {
          "text": "Schedule a Demo",
          "type": "flz-secondary",
          "action": {
            "type": "open_url",
            "open_url": {
              "url": "",
              "open_in_new_window": true
            }
          }
        }
      }
    },
    "ribbon": {
      "background": { "type": "color", "value": "background: #ffffff" }
    }
  },
    "sections": [ /* array of section objects */ ],
    "footer_id": 789
  },
  "registration_page": {
    "sections": [
      {
        "section_id": "board:registration:s_reg001",
        "type": "body",
        "name": "Registration",
        "anchor": "signup",
        "widgets": { /* widget schema with current content */ },
        "ribbon": {
          "background": { "type": "color", "value": "background: var(--fz-color-neutral-0)" }
        }
      }
    ]
  }
}

Variation: header with two logos and inline navigation

Different header types return different widget keys and fields. For example, a template using the Header with 2 logos type returns a widgets.header with a populated navigation.items array (instead of an empty navigation: {}) and no banner widget at all:

{
  "theme_id": 777,
  "main_page": {
    "header": {
      "section_id": "board:default:s_27da2d1a",
      "type": "header",
      "name": "Header with 2 logos",
    "widgets": {
      "header": {
        "primary_logo": {
          "image": {
            "url": "https://images.folloze.com/image/upload/v1750030731/d7ajbarxztndszv8ywi8.png"
          }
        },
        "secondary_logo": {
          "image": {
            "url": "",
            "link": "",
            "alt": ""
          }
        },
        "cta": {
          "text": "Contact Us",
          "type": "flz-secondary",
          "action": {
            "type": "open_url",
            "open_url": {
              "url": ""
            }
          }
        },
        "color": {
          "tag_line": "#000000",
          "symbol": "var(--fz-color-neutral-4)"
        },
        "visibility": {
          "primary_logo": true,
          "show_logos": true,
          "show_symbols": true,
          "secondary_logo": false,
          "tag_line": false,
          "cta": false,
          "share_button": false,
          "navigation": true
        },
        "navigation": {
          "items": [
            { "text": "Solutions",       "type": "flz-link", "action": { "type": "open_url", "open_url": {} } },
            { "text": "Why us",          "type": "flz-link", "action": { "type": "open_url", "open_url": {} } },
            { "text": "Success stories", "type": "flz-link", "action": { "type": "open_url", "open_url": {} } },
            { "text": "Product tour",    "type": "flz-link", "action": { "type": "open_url", "open_url": {} } },
            { "text": "Resources",       "type": "flz-link", "action": { "type": "open_url", "open_url": {} } }
          ]
        }
      }
    }
    }
  }
}

Search boards #

Search and list boards in your organization. Supports filtering by name, status, and owner — based on the same search functionality available in the Folloze UI.

Query parameters

Example request

curl -s "https://content-api.folloze.com/v1/boards?search=Acme&activation_state=1&page=1&per_page=10" \
  -H "Authorization: Basic $BASE64_CREDENTIALS"

Example response

{
  "boards": [
    {
      "id": 247054,
      "name": "Personalized Hub for Acme Corp",
      "description": null,
      "status": "Online",
      "board_url": "https://acme.boards.folloze.com/eee17a",
      "image_url": "https://images.folloze.com/image/upload/v.../hero.png",
      "owner": {
        "id": 1999626,
        "full_name": "Jane Smith",
        "email": "jane@acme.com"
      },
      "hashtags": [],
      "created_at": "2026-07-06T08:27:35.511Z",
      "updated_at": "2026-07-06T08:28:12.797Z"
    }
  ],
  "pagination": {
    "total_items": 1,
    "total_pages": 1,
    "current_page": 1,
    "per_page": 10
  }
}

Response fields

Create a board #

Creates a new board in the organization, copying the source board's structure and applying your content. The source can be a template board (template_board_id) or any existing board (source_board_id).

Request body

Page object

Section object

Channels

Pass each channel as { "name": "…" }. The name is matched exactly (case-sensitive, no whitespace trimming) against existing channels in the organization — the board joins the existing channel if a match is found; otherwise a new channel is created with this name.

{
  "channels": [
    { "name": "Q4 launch" },
    { "name": "Acme account" }
  ]
}

Access settings

The settings.access object controls who can view the board. Four access types are supported:

Open to all (default):

{
  "settings": {
    "access": {
      "type": "open_to_all",
      "token_enabled": true
    }
  }
}

Password-protected:

{
  "settings": {
    "access": {
      "type": "password",
      "password": "s3cret",
      "re_authenticate_per_session": true
    }
  }
}

Email verification:

{
  "settings": {
    "access": {
      "type": "email",
      "include_recipients": true,
      "domain_filter_enabled": true,
      "allowed_domains": ["acme.com", "partner.co"],
      "blocked_domain_filter_enabled": false,
      "blocked_domains": [],
      "privacy_message_id": 123,
      "re_authenticate_per_session": false,
      "code_expiration_seconds": 900
    }
  }
}

Example response

{
  "board_id": 12345,
  "board_url": "https://acme.boards.folloze.com/my-vanity-slug",
  "slug": "my-vanity-slug",
  "main_page": {
    "header": { "section_id": "board:default:s_f316586e", "type": "header", "name": "Header", "widgets": { ... } },
    "sections": [
      { "section_id": "board:default:s_abc123", "type": "body", "name": "Single Item", "widgets": { ... } }
    ],
    "footer_id": 789
  },
  "registration_page": {
    "sections": [
      { "section_id": "board:registration:s_reg001", "type": "body", "name": "Registration", "widgets": { ... } }
    ]
  }
}

Errors

Update a board #

Updates an existing board's sections, widgets, slug, and settings. Accepts the same page structure as POST /v1/boards — main_page, registration_page, or legacy top-level sections. The board must have a published configuration (i.e. it must have been published at least once).

Path parameters

Request body

Example request

PATCH /v1/boards/12345
Content-Type: application/json
Authorization: Basic <your_api_token>

{
  "board_name": "Updated Hub for Acme Corp",
  "slug": "acme-hub-q4",
  "main_page": {
    "sections": [
      {
        "section_id": "board:default:s_abc123",
        "widgets": {
          "banner": {
            "title": "<p>Welcome to Acme, updated!</p>",
            "subtitle": "<p>Your personalized resource hub</p>"
          }
        }
      }
    ]
  },
  "settings": {
    "access": {
      "type": "password",
      "password": "acme2026",
      "re_authenticate_per_session": true
    }
  },
  "state": "online"
}

Example response

{
  "board_id": 12345,
  "board_url": "https://acme.boards.folloze.com/acme-hub-q4",
  "slug": "acme-hub-q4",
  "main_page": {
    "header": { "section_id": "board:default:s_f316586e", "type": "header", "name": "Header", "widgets": { ... } },
    "sections": [
      { "section_id": "board:default:s_abc123", "type": "body", "name": "Banner", "widgets": { ... } }
    ],
    "footer_id": 789
  }
}

Errors

Publish board #

Publishes a board's unpublished changes, making them live. By default the board is also set to online state; pass go_online=false to publish the configuration without going live.

Path parameters

Query / body parameters

Example request

POST /v1/boards/243672/publish
Authorization: Basic <your_api_token>

Example response

{
  "board_id": 243672,
  "board_url": "https://acme.boards.folloze.com/q3-acme",
  "published_at": "2026-05-18T06:12:43Z",
  "online": true
}

Errors

List HTML sections #

Returns every editable HTML field? in a board's unpublished configuration. Use this to discover which fields can be read or updated via the HTML content endpoint.

Path parameters

Example request

GET /v1/boards/243672/html_sections
Authorization: Basic <your_api_token>

Example response

{
  "html_sections": [
    {
      "section_id": "s_1b61c01c",
      "widget_tag": "html-section",
      "field": "content",
      "url": "/v1/boards/243672/html_sections/s_1b61c01c/html-section/content"
    },
    {
      "section_id": "s_f316586e",
      "widget_tag": "html-header",
      "field": "content",
      "url": "/v1/boards/243672/html_sections/s_f316586e/html-header/content"
    }
  ]
}

Response fields

Errors

Get / update HTML content #

Read or replace the raw HTML content of a single field in a board's configuration. Both verbs use text/html — not JSON — for the content body.

Path parameters

GET — read HTML content

Returns the raw HTML of the field. By default reads from the unpublished configuration; pass the ?published query parameter to read the published version instead.

GET /v1/boards/243672/html_sections/s_1b61c01c/html-section/content
Authorization: Basic <your_api_token>

Response: Content-Type: text/html; charset=utf-8

<div class="ql-style-heading4">
  <strong>Your platform isn't truly modern</strong>
</div>

PUT — update HTML content

Replaces the HTML content in the board's unpublished configuration. The request body is raw HTML — not a JSON object.

PUT /v1/boards/243672/html_sections/s_1b61c01c/html-section/content
Authorization: Basic <your_api_token>
Content-Type: text/html

<div class="ql-style-heading4">
  <strong>Updated headline copy</strong>
</div>

Response: 200 OK with Content-Type: text/html; charset=utf-8, echoing back the written HTML.

Typical workflow

1. Create a board via POST /v1/boards (the board is created as a draft with unpublished config).
2. Call GET /v1/boards/:id/html_sections to discover which HTML fields exist.
3. Use PUT on each field to inject your custom HTML content.
4. Call POST /v1/boards/:id/publish to push the changes live.

Errors

End-to-end walkthrough #

A common workflow has four steps: pick a template, read its schema, build a payload, create the board.

Step 1 — Pick a template

GET /v1/board_templates
Authorization: Basic <your_api_token>

Returns every template board in your organization with its id, name, and description. Pick the template id you want to base the new board on (e.g. 4321). If you already know the id (e.g. it's stored in your config), you can skip this step.

Step 2 — Read the template's schema

GET /v1/board_templates/4321/describe
Authorization: Basic <your_api_token>

Save the response — it tells you which sections exist, which widgets they contain, what fields each widget exposes, and the header / footer to round-trip back to POST /v1/boards.

Step 3 — Build your payload

Take the response, replace the placeholder text with your real content, drop sections you don't want, and add your header.

{
  "template_board_id": 4321,
  "board_name": "Q3 Campaign — Acme Corp",
  "owner_email": "rep@acme.com",
  "tags": ["acme", "q3-campaign"],
  "state": "online",
  "channels": [
    { "name": "Q3 Campaigns" }
  ],
  "header": {
    "primary_logo": { "url": "https://cdn.example.com/acme.png", "link": "https://acme.com", "alt": "Acme" },
    "tagline": "Built for modern teams",
    "navigation": {
      "items": [
        { "text": "Solutions", "type": "flz-link", "action": { "type": "open_url", "open_url": { "url": "https://acme.com/solutions", "open_in_new_window": true } } },
        { "text": "Pricing",   "type": "flz-link", "action": { "type": "open_url", "open_url": { "url": "https://acme.com/pricing", "open_in_new_window": true } } }
      ]
    },
    "cta": {
      "text": "Talk to sales",
      "type": "flz-primary",
      "action": { "type": "form", "form": { "form_id": "86101" } }
    }
  },
  "footer_id": 789,
  "sections": [
    {
      "section_id": "board:default:s_abc123",
      "name": "Banner - classic",
      "widgets": [
        {
          "widget_id": "w_111",
          "title": "Acme x Folloze",
          "subtitle": "Personalized buyer experiences at scale",
          "cta": {
            "text": "Get started",
            "type": "flz-primary",
            "action": { "type": "open_content_item", "open_content_item": {} }
          },
          "secondary_cta": {
            "text": "Watch demo",
            "type": "flz-secondary",
            "action": { "type": "open_url", "open_url": { "url": "https://acme.com/demo", "open_in_new_window": true } }
          }
        }
      ]
    },
    {
      "section_id": "board:default:s_def456",
      "name": "Columns - Value proposition 4 columns",
      "widgets": [
        {
          "widget_id": "w_222",
          "title": "Why Acme",
          "subtitle": "Three reasons teams choose us",
          "cta": {
            "text": "See all",
            "type": "flz-primary",
            "action": { "type": "open_url", "open_url": { "url": "", "open_in_new_window": true } }
          },
          "repeatable": {
            "columns": [
              { "title": "Faster onboarding",      "paragraph": "Go live in days, not months." },
              { "title": "Personalized at scale",  "paragraph": "1:1 experiences for every account." },
              { "title": "Built-in analytics",     "paragraph": "Know what works and double down." }
            ]
          }
        }
      ]
    }
  ]
}

Step 4 — Create the board

POST /v1/boards
Authorization: Basic <your_api_token>
Content-Type: application/json

<body from step 3>

Response:

{
  "board_id": 99213,
  "board_url": "https://acme.boards.folloze.com/q3-acme",
  "sections": [
    {
      "section_id": "board:default:s_abc123",
      "type": "body",
      "name": "Banner - classic",
      "widgets": [{ "widget_id": "w_888", "title": "Acme x Folloze", "subtitle": "..." }]
    }
  ]
}

You can now share board_url with your audience.

Content API #

The Content API manages the content items in your Folloze organization — the URLs, files, videos, and PDFs that appear on boards. You can ingest assets from any external source (the asset doesn't need to exist in Folloze first), update them, search them, and place them on specific boards with per-board overrides.

What it's for

• Ingest from anywhere — create items directly from any URL or downloadable asset, with no prior step in the Folloze UI.
• Sync your CMS — mirror your single source of truth into Folloze.
• Personalize per account — place the same item on many boards with a different title, description, or thumbnail on each, without duplicating the source asset.
• Search & audit — list and filter items in your organization from external systems.

Endpoints at a glance

Authentication & base URL #

The Content API is served from the same host as the Board Creation API:

https://content-api.folloze.com

Authentication uses the same scheme as the Board Creation API — an API token in the Authorization header:

Authorization: Basic <your_api_token>

Tokens are issued per organization by Folloze. Contact your Folloze account representative to request a token — the same token grants access to both the Board Creation API and the Content API.

List & search content items #

Returns a paginated list of content items in your organization, with filtering by type, owner, tags, and free text.

Query parameters

Examples

# Single filter
curl "https://content-api.folloze.com/v1/items?type[]=video" \
  -H "Authorization: Basic $FOLLOZE_API_TOKEN"

# Combined filters
curl "https://content-api.folloze.com/v1/items?type[]=video&type[]=pdf&owner[]=42&tags[]=webinar&search=demo&page=1&per_page=50&sort_direction=asc" \
  -H "Authorization: Basic $FOLLOZE_API_TOKEN"

const params = new URLSearchParams();
["video", "pdf"].forEach(t => params.append("type[]", t));
params.append("owner[]", "42");
params.append("tags[]", "webinar");
params.set("search", "demo");
params.set("per_page", "50");

const res = await fetch(
  `https://content-api.folloze.com/v1/items?${params}`,
  { headers: { Authorization: `Basic ${FOLLOZE_API_TOKEN}` } }
);
const items = await res.json();

import requests
res = requests.get(
    "https://content-api.folloze.com/v1/items",
    headers={"Authorization": f"Basic {FOLLOZE_API_TOKEN}"},
    params=[
        ("type[]", "video"), ("type[]", "pdf"),
        ("owner[]", "42"),
        ("tags[]", "webinar"),
        ("search", "demo"),
        ("per_page", 50),
    ],
)
items = res.json()

Create a content item #

Creates a new content item in your Folloze organization from any external source. The asset itself does not need to exist in Folloze beforehand — provide a public URL (for link items) or a downloadable URL (for file items) and Folloze ingests it. File items are ingested asynchronously — see Async file ingest.

Request body (key fields)

Response

Successful create returns 202 Accepted with a tracking payload:

{
  "folloze_id": 770029,
  "provider_asset_id": "abc123",
  "provider_name": "folloze"
}

Attach an item to a board #

Places an existing content item on a board without creating a duplicate. Per-board presentation fields (title, description, thumbnail, tags, schedule, categories) override the source item's defaults only on this board — the source item is never mutated.

Request body

Example request

POST https://content-api.folloze.com/v1/board_items
Authorization: Basic <your_api_token>
Content-Type: application/json

{
  "board_id": 241976,
  "content_center_item_id": 509798,
  "creator_email": "admin@follozeqa.com",
  "title": "Shaping Tomorrow's Cities — for JLL",
  "description": "Human-centric development insights tailored for this account.",
  "thumbnail_url": "https://images.folloze.com/image/upload/hsvolbwawc9krdqmybvs.png",
  "tags": ["JLL", "Creating a Space"],
  "status": "online",
  "is_gated": false,
  "open_in_new_tab": true,
  "schedule": {
    "start_unix": 1714500000,
    "end_unix":   1717092000,
    "timezone":   "America/New_York"
  },
  "categories": [
    { "name": "Product Updates" },
    { "name": "Customer Stories" }
  ]
}

Update a board item #

Updates the per-board overrides for an existing board item: title, description, thumbnail, schedule, status, and categories. The underlying source content item is never modified.

Path parameters

Request body

Same fields as attach to board, except board_id and content_center_item_id are not changeable. Only fields you include are updated — omit a field to leave it as-is.

Example request

PUT https://content-api.folloze.com/v1/board_items/2207832
Authorization: Basic <your_api_token>
Content-Type: application/json

{
  "title": "Test of update",
  "description": "Updated walkthrough of the new platform capabilities.",
  "thumbnail_url": "https://images.folloze.com/image/upload/hsvolbwawc9krdqmybvs.png",
  "status": "online",
  "is_gated": true,
  "open_in_new_tab": true,
  "schedule": {
    "start_unix": 1714500000,
    "end_unix":   1717092000,
    "timezone":   "America/New_York"
  },
  "categories": [
    { "name": "Product Updates" },
    { "name": "Customer Stories" }
  ]
}

Categories & subcategories? #

The categories field on board-item endpoints lets you place an item under one or more categories on the board. Each entry can be specified by name (created on demand if missing) or by id (must already exist; otherwise the call fails).

Shape

{
  "categories": [
    {
      "name": "Marketing",
      "sub_categories": [
        { "name": "Email Campaigns" },
        { "id":   456 }
      ]
    },
    { "id": 789 }
  ]
}

Async file ingest #

When you create a file-type item with a download_url, Folloze responds immediately with 202 Accepted and ingests the file asynchronously by pulling it from the URL you provided.

What this means for your client

• The folloze_id in the response is valid right away — you can attach the item to boards immediately.
• The actual file content (and any derived previews / thumbnails) becomes available once ingest completes — usually seconds to minutes depending on size.
• Make sure download_url is publicly reachable (or signed with a long enough TTL) until ingest finishes.
• If ingest fails, the item is created but its file payload is empty. Re-create or update the item with a fresh download_url.

Folloze 101 — Key concepts

New to Folloze? This is a quick tour of the things the API talks about — boards, sections, content items, and the rest. Anywhere a term is marked with a ? in the API docs above, this is the page that's being linked to.

The big picture

A board is a personalized web page you share with buyers. Boards are built from sections (banner, content block, form, etc.), and each section is populated with content items from your Folloze organization. Marketers usually start by designing a template board in the Folloze UI, then the API takes that template and stamps out personalized copies of it — one per account, campaign, or event.

Boards

CTAs & actions

Sections & ribbons

Content items

How they fit together

From the API's perspective, generating a personalized board for an account looks like this:

1. Start with a template board the marketing team designed in the Folloze UI.
2. Read the template's sections and widgets to see which fields you can fill.
3. Send a POST /v1/boards with account-specific copy — you get back a new board with its own URL.
4. Optionally add or update content items in your library, then place them on the new board as board items with per-board titles, thumbnails, and categories.
5. Share the board URL with your buyer.

Changelog

Audit log of changes to the public APIs. Newest first.