LogoLogo
Try it outResourcesAPIsAddOnsBook a demo
  • Getting Started
    • Introduction to Beefree SDK
      • Create an Application
      • Installation and Fundamentals
        • Configuration parameters
          • Configuration Reload
          • Workspaces
          • Debugging the Beefree SDK Editor
        • Methods and Events
        • Authorization Process
        • How the UID parameter works
        • Set up two-factor authentication
        • Naming conventions
      • Development Applications
      • Manage Users
      • Manage Subscriptions
      • Installation and Fundamentals
    • Tracking Message Changes
    • Sample Code
    • Release Candidate Environment
  • Visual Builders
    • Email Builder
    • Page Builder
      • Integrating Page Builder
      • Embedding videos in a page
    • Popup Builder
      • Popup Builder - Getting Started
      • Testing and Integrating
      • Setting layout and size
        • Advanced settings
    • AI-Driven Design Creation
  • APIs
    • Content Services API
      • Authentication
      • Export
      • Convert
      • Row Processing
      • AI Collection
      • Brand Style
    • Template Catalog API
      • Authentication
      • Templates
      • Categories
      • Collections
      • Designers
      • Tags
    • HTML Importer API
      • Authentication
      • Import HTML
  • Forms
    • Form Block
    • Integrating and using the Form block
      • Passing forms to the builder
      • Form structure and parameters
      • Form layout customization
      • Allowed form fields
      • Edit form field modal
  • Rows
    • Reusable Content
      • Create Reusable Content
        • Pre-build Reusable Content
          • Implement Custom Rows
        • Save Reusable Content
          • Implement Hosted Saved Rows
          • Implement Self-hosted Saved Rows
            • Self-hosted Saved Rows Concepts and Tutorial
      • Sync Reusable Content
        • Implement Synced Rows
        • Initialize Edit Single Row Mode
      • Manage Reusable Content
    • Storage for Reusable Content
      • Hosted Saved Rows
      • Self-Hosted Saved Rows
  • File manager
    • File manager application overview
      • Mime Types and Groups
  • Server-side configurations
    • Server-side options
      • Toolbar options
      • Storage options
        • Configure your AWS S3 bucket
        • Connect your file storage system
      • Content options
      • Services options
      • Undo & Changes history
      • Custom JavaScript Libraries Injection
  • Other Customizations
    • Advanced options
      • Special Links and Merge Tags
      • Content Dialog
      • Custom Color Palette
      • Font management
      • Roles and Permissions
      • Smart Merge Tags
      • Commenting
      • Custom Attributes
      • Meta Tags
      • Custom Languages
      • Display Conditions
      • Advanced Permissions
      • Custom File Picker
      • Custom Headers
    • Appearance
      • Content Defaults
      • Custom Sidebar Position
      • Content Tile Sorting
      • Content Tile Grouping
      • Loading Spinner Theme
      • Custom Tab Layout
      • Themes
      • Custom CSS
        • Change Log
    • AMP for Email
    • Collaborative Editing
      • Co-editing Integration Guide
    • Mobile Design Mode
    • Multi-language Templates
    • Cards Style and Image Round Corners
    • Hover Effect for Buttons
    • Content Area Padding
    • Line Height
  • Data Structures
    • Getting Started
    • Schema Catalog
    • Simple Schema
      • Template Schema
      • Definitions Schema
      • Row Schema
      • Column Schema
      • Title Schema
      • Image Schema
      • Button Schema
      • Paragraph Schema
      • HTML Schema
      • Menu Schema
      • List Schema
      • Icon Schema
      • Divider Schema
    • Row Metadata
    • Form Validation Schema
    • Comments Schema
      • Change Schema for Comments
  • Builder AddOns
    • AddOns
      • AddOns Overview
      • Partner AddOns
        • Partner AddOns directory
        • Installing Partner AddOns
        • DeepL
        • Stability AI
        • Azure AI Vision - Image Analysis
          • Alternate Text Generation with AI
          • AI Alt Text Bulk Generation
        • AI Writing Assistant
          • Available Providers
            • OpenAI
            • Azure OpenAI
            • Anthropic
          • AI Providers and Data Security
          • AI-Generated Meta Tag Fields
          • Token Upselling
          • Apply a Brand Tone
        • Custom AI Writing Assistant
      • Custom AddOns
        • AddOn Development
        • Contribute to the Partner AddOn Marketplace
      • AddOns Configuration
      • AddOn FAQs
  • Resources
    • Error Management
      • onWarning
      • Beefree SDK Editor Errors
      • File System Provider errors
      • JSON Parser errors
      • Template Validation and Update
      • Template validation and update errors
    • Scheduled maintenances
Powered by GitBook
LogoLogo

Policies

  • Privacy & Cookies
  • Terms of Services
  • GDPR Compliance
  • Trust Center

Contact Us

  • Submit a request
  • Book a demo
  • Report a security issue

Resources

  • Developer website
  • Create a Developer Account

© Bee Content Design, Inc. San Francisco, CA | Part of Growens

On this page
  • Beefree SDK API Offering
  • Overview of HTML Importer API
  • How the HTML Importer API works
  • FAQs
  • Can I convert any HTML template? Are there any limitations?
  • Will I get different results if I upload the same HTML template to the API several times?
  • What's the applicable use policy?
  • Which plan has access to the API, and what's the pricing?
  • Do you store any of the templates I upload to the HTML Importer?
  • Does the HTML Importer API use AI, and are you using my templates for training?

Was this helpful?

Export as PDF
  1. APIs

HTML Importer API

Learn more about the HTML Importer API offering in Beefree SDK.

PreviousTagsNextAuthentication

Last updated 9 days ago

Was this helpful?

Available on all . Learn more about Usage-based fees for the .

The HTML Importer API is currently only accessible in production applications.

Beefree SDK API Offering

Beefree SDK includes a comprehensive API offering designed to expand upon the builder's capabilities. By leveraging Beefree SDK's APIs, you can extend the builder's functionality into other aspects of your application.

Beefree SDK's API offering includes three APIs. They are the following:

This section of the documentation discusses the , which includes resources for programmatically importing pre-existing HTML templates into Beefree SDK's builder.

Overview of HTML Importer API

Manually migrating your existing templates into Beefree SDK can be tedious and time-consuming, but with the HTML Importer API you can:

  • Make existing HTML editable in the Beefree SDK: Empower your end-users to edit their current HTML email templates using the intuitive drag-and-drop interface — without having to manually recreate them

  • Save time and resources: Manually recreating email templates from scratch can take hours. With the new Importer API, you can make existing email templates editable in Beefree in seconds.

  • Significantly reduce migration friction for faster client onboarding: Overcome the challenge of template migration, a common pain point when bringing on new clients. The HTML Importer API streamlines this process, allowing for quicker onboarding.

The resource in HTML Importer API is a synchronous endpoint that accepts the email HTML as the body of a POST request and returns the Beefree JSON in the response.

How the HTML Importer API works

The HTML Importer leverages a series of algorithms to map and classify all the content elements available in the email, label them, and then translate them into Beefree's JSON format.

Using a simple API, you can pass us the email you'd like us to convert, and the API will return Beefree JSON in response:

FAQs

Explore answers to the most frequently asked questions.

Can I convert any HTML template? Are there any limitations?

There are a few things you should be aware of to ensure a great import experience:

  • The conversion engine is designed to convert email HTML. It's not optimized for converting landing pages or other HTMLs.

  • Ensure your email HTML is valid. We can't import HTML files that miss DOCTYPE declaration, don't include valid html and body elements, or don't include the <meta charset="UTF-8"> tag in the head section of your HTML.

  • Our API doesn't convert dynamically created HTML documents that leverage JavaScript to render content. We currently support static HTML and CSS content only.

  • Ensure that all images and resources included in your HTML are publicly available on the internet. We can't convert emails with images and resources that are only available on private networks.

  • Please be aware that some HTML elements are not fully supported by the importer at this time, including background images, dividers, and menus.

If you follow the best practices above, the HTML Importer will migrate the structure and content of your HTML into Beefree's JSON format, significantly reducing the time it takes to recreate templates from scratch manually. Some design adjustments may still be necessary to match the original design.

Will I get different results if I upload the same HTML template to the API several times?

No, with the HTML importer API, the result will stay consistent each time you call the API.

What's the applicable use policy?

Which plan has access to the API, and what's the pricing?

The HTML Importer API is available for all Beefree SDK plan types, including the free plan. We charge $2 per template import.

  • Every time you call our HTML Importer API and receive a JSON in response, that’s counted as an import for billing purposes.

  • If an API call fails for any reason (and we respond with an error rather than a JSON file), you won’t be charged.

Do you store any of the templates I upload to the HTML Importer?

No, we do not store any of your templates.

Does the HTML Importer API use AI, and are you using my templates for training?

No, the HTML importer API does not use AI to recreate content into our native JSON format. Your templates will not be stored or used for training or data analysis purposes.

The HTML Importer API is a -based API that enables Beefree SDK integrators to programmatically convert email HTML into Beefree JSON. It is built to follow predictable resource url patterns, and to utilize standard HTTP response codes and methods. This service is particularly helpful if you (or your end users) have pre-existing HTML templates you'd like to load within the no-code Beefree SDK builder and edit in the drag-and-drop editor.

Beefree SDK requires that you prior to accessing the HTML Importer API's resources and obtain an API key for your production application.

You can use this tool in accordance with . In particular, you should use the tool in a way that ensures you will not violate the rights of third parties.

For more information on usage and pricing, visit the .

REST
authenticate
Beefree's Terms of Service
Usage-based fees article
Beefree SDK plan types
HTML Importer API
Content Services API
Template Catalog API
HTML Importer API
HTML Importer API
Diagram Displaying Beefree SDK's API Offering