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

code

Integer

A unique numeric identifier for the error or warning.

name

String

A short identifier for internal reference and debugging.

message

String

A human-readable message summarizing the problem.

detail

Object

Additional structured information, such as invalid parameters or language.

title

String

Optional. A localized title (from useIntl and errorsTranslations).

description

String

Optional. A localized description (from useIntl and errorsTranslations).

Error Code Reference

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

Generic Errors

Code
Name
Message

9900

apiGeneric

(unlisted fallback)

9999

genericError

An error occurred

503

fspGeneric

An error occurred

Authentication Errors

Code
Name
Message

4001

authHeaderMissing

4005

authBearerInvalid

4010

authTokenExpired

5001

contentTypeFormUrlError

5002

unableToAuthenticate

5003

applicationDisabled

5005

invalidUID

5101

reLoginNeeded

Must login again and inject new token

5102

reLoginAndUpgradeNeeded

Must login again and re-create Plugin

Add-on Errors

Code
Name
Message
Type

1810

iframeTimeout

The iframe took too long to load

Warning

1820

iframeAuthFailed

Error authenticating the add-on

Warning

Template Errors

Code
Name
Message

1100

invalid

The template is malformed and cannot be loaded. Check it and try again.

1101

invalid

The template cannot have more than one row when editSingleRow is true.

1300

invalid

The language is not valid (conflicts with LOCKED_ROW warning)

Locked Content Warnings

Code
Name
Message
Type

1300

locked

This row is locked and therefore its content cannot be edited.

Warning

1310

locked

Locked content blocks cannot be edited.

Warning

7020

lockedEntity

Locked entity

Warning

Frontend API Errors

Code
Name
Message

7005

invalidCommand

Invalid command

7010

invalidCommandOptions

Invalid command options

7030

entityNotFound

Entity not found

7040

elementNotFound

Element not found

7050

forbiddenCommand

The command execution is not allowed

Plan Limitations

Code
Name
Message

1704

featureNotAvailable

This feature is not available for this plan

1705

featureNotEnabled

1706

featureNotAvailableInCoedit

1710

featureLimitReachedForPlan

1702

workspaceNotAvailableForPlan

1002

workspaceNotAvailable

File System Provider (FSP) Errors

Code
Name

3100

fspBeGenericError

3200

fspResourceNotFound

3300

fspPermissionDenied

3400

fspResourceAlreadyPresent

3401

fspResourceAlreadyPresentNoDialog

3450

fspFileNotUploaded

3500

fspRequestError

3600

fspUserError

3650

fspWrongCredentials

3750

fspInvalidImportUrl

Translation Errors

Code
Name

6050

translationGenericBeError

6150

autoTranslateNotSupported

JSON Preprocessing and Validation Errors

Code
Name
Message

4101–4192

Various (e.g., CSS, HTML tags)

Specific JSON validation failures

4501–4504

CSS Conversion Errors

Reference the following pages for more information on additional errors:

Last updated

Was this helpful?