1 of 7

Error Management

Use this guide to implement and manage error handling for Beefree SDK in your application. You'll learn how to structure errors, classify them consistently, localize messages, and surface them effectively in your UI.

There are two primary error types:

Errors: These are critical and interrupt normal execution. They typically require the end user or system to take corrective action.
Warnings: These are non-blocking and indicate a recoverable or informational condition, like a locked module or a timed-out iframe.

Attributes

Each error or warning may include the following:

Attribute

Type

Description

Error Code Reference

A categorized directory of all known error codes, their default messages, and classifications.

Generic Errors

Code

Name

Message

Authentication Errors

Code

Name

Message

Add-on Errors

Code

Name

Message

Type

Template Errors

Code

Name

Message

Locked Content Warnings

Code

Name

Message

Type

Frontend API Errors

Code

Name

Message

Plan Limitations

Code

Name

Message

File System Provider (FSP) Errors

Code

Name

Translation Errors

Code

Name

JSON Preprocessing and Validation Errors

Code

Name

Message

Reference the following pages for more information on additional errors:

Warning, Error, and Info Callbacks

`onWarning` Callback

The onWarning callback returns information about a soft error that doesn’t impact the normal usage of the builder. You can use this callback to track these errors, display a message or change any behavior in your application. The callback manages JSON as the output data format.

Beefree SDK Editor Errors

Example Response


{
    "code": 1200,
    "message": "Template cannot be saved."
    "detail": "Type mismatch: scope is undefined"
}

Error codes

Code

Message

File System Provider Errors

Example Response

Error Codes

Code

Message

HTTP Status

Details

Displaying custom errors from your FSP API

You can return custom errors from your application that will be displayed in the file manager.

To do that we reserved codes from 3900 to 3999. An error sent with an error code number in this range displays the message as the error title and the details as the error text.

Example:

Your file storage doesn’t support file names with the character “?”
The front end doesn’t stop the upload, as this character is allowed by other APIs and storages
When your API gets the file, returns the following error: Code: 39105 HTTP Status: 400 Message: Upload error Details: The file name is not allowed. Please make sure it does not contain one or more of these characters: \ / < > ? |

Template Validation and Update

As Beefree SDK is improved and updated over time, the JSON structure we use to describe a document may change.

The endpoint bump.getbee.io validates and – when needed – updates a JSON document that had been created with an earlier version of the builder.

This guarantees backward compatibility for older documents: any document (e.g., an email campaign, a template in your email template catalog, etc.) using a JSON structure that the system finds to be out-of-date gets updated automatically the next time it is passed to the builder.

Currently, this feature is working in test mode, tracking any issue with existing JSON documents and allowing us to improve this service. During this testing phase, the system does not stop the loading of the builder when an issue is found.

Error response example

To read the full list of possible errors, please refer to .

Code

Message

Detail

1000

bee.save is unavailable

Cannot call bee.save() while template is still loading. Use the onLoad callback to determine when it’s safe to use the save method.
After onLoad(), if bee.save() is not accessible, it’s due to an expired token.

1610

Unknown module name

[Grouping Content tiles]Unknown module name.

1620

Duplicate module

[Grouping Content tiles]Duplicate module

Error Management

There are two primary error types:

Errors: These are critical and interrupt normal execution. They typically require the end user or system to take corrective action.
Warnings: These are non-blocking and indicate a recoverable or informational condition, like a locked module or a timed-out iframe.

Attributes

Each error or warning may include the following:

Attribute

Type

Description

Error Code Reference

A categorized directory of all known error codes, their default messages, and classifications.

Generic Errors

Code

Name

Message

Authentication Errors

Code

Name

Message

Add-on Errors

Code

Name

Message

Type

Template Errors

Code

Name

Message

Locked Content Warnings

Code

Name

Message

Type

Frontend API Errors

Code

Name

Message

Plan Limitations

Code

Name

Message

File System Provider (FSP) Errors

Code

Name

Translation Errors

Code

Name

JSON Preprocessing and Validation Errors

Code

Name

Message

Reference the following pages for more information on additional errors:

Template Validation and Update

As Beefree SDK is improved and updated over time, the JSON structure we use to describe a document may change.

The endpoint bump.getbee.io validates and – when needed – updates a JSON document that had been created with an earlier version of the builder.

Error response example

To read the full list of possible errors, please refer to .

2000

Generic Bump Error

BAD REQUEST

400

Default generic bump error

2100

Invalid Target Version

BAD REQUEST

400

The target version does not exists

2200

[validation error detail]

BAD REQUEST

400

The JSON didn’t pass the validation.

The cause may be:

Missing keys
Added unknown keys

Message e.g.: required key not provided @ data[u'page'][u'body'][u'content'][u'style'][u'color']

Error Management

hashtagAttributes

hashtagError Code Reference

hashtagGeneric Errors

hashtagAuthentication Errors

hashtagAdd-on Errors

hashtagTemplate Errors

hashtagLocked Content Warnings

hashtagFrontend API Errors

hashtagPlan Limitations

hashtagFile System Provider (FSP) Errors

hashtagTranslation Errors

hashtagJSON Preprocessing and Validation Errors

Warning, Error, and Info Callbacks

hashtagonWarning Callback

Beefree SDK Editor Errors

hashtagExample Response

hashtagError codes

File System Provider Errors

hashtagExample Response

hashtagError Codes

hashtagDisplaying custom errors from your FSP API

hashtagExample:

Template Validation and Update

hashtagError response example

Beefree SDK Editor Errors

hashtagExample Response

hashtagError codes

Warning, Error, and Info Callbacks

hashtagonWarning Callback

hashtagResponse

hashtagExample

hashtagWarning codes

hashtagonError callback

hashtagConfiguration

hashtagResponse

hashtagExample

hashtagExtend onError

hashtagError code and message

hashtagonInfo Callback

hashtagResponse

hashtagExample Response on prompt generation

hashtagExample Response on prompt apply

Error Management

hashtagAttributes

hashtagError Code Reference

hashtagGeneric Errors

hashtagAuthentication Errors

hashtagAdd-on Errors

hashtagTemplate Errors

hashtagLocked Content Warnings

hashtagFrontend API Errors

hashtagPlan Limitations

hashtagFile System Provider (FSP) Errors

hashtagTranslation Errors

hashtagJSON Preprocessing and Validation Errors

Template Validation and Update

hashtagError response example

File System Provider Errors

hashtagExample Response

hashtagError Codes

hashtagDisplaying custom errors from your FSP API

hashtagExample:

Template Validation and Update Errors

hashtagExample Response

hashtagError Codes

JSON Parser Errors

hashtagExample Response

hashtagError Codes

hashtagAuthentication errors

hashtagPreliminary JSON parsing errors

hashtagJSON Pre-processing errors

hashtagHTML Creation errors

hashtagPost-processing errors

Attributes

Error Code Reference

Generic Errors

Authentication Errors

Add-on Errors

Template Errors

Locked Content Warnings

Frontend API Errors

Plan Limitations

File System Provider (FSP) Errors

Translation Errors

JSON Preprocessing and Validation Errors

`onWarning` Callback

Example Response

Error codes

Example Response

Error Codes

Displaying custom errors from your FSP API

Example:

Error response example

Example Response

Error codes

`onWarning` Callback

Response

Example

Warning codes

`onError` callback

Configuration

Response

Example

Extend onError

Error code and message

`onInfo` Callback

Response

Example Response on prompt generation

Example Response on prompt apply

Attributes

Error Code Reference

Generic Errors

Authentication Errors

Add-on Errors

Template Errors

Locked Content Warnings

Frontend API Errors

Plan Limitations

File System Provider (FSP) Errors

Translation Errors

JSON Preprocessing and Validation Errors

Error response example

Example Response

Error Codes

Displaying custom errors from your FSP API

Example:

Example Response

Error Codes

Example Response

Error Codes

Authentication errors

Preliminary JSON parsing errors

JSON Pre-processing errors

HTML Creation errors

Post-processing errors