API Reference

Get BeeFree Email Template by email Type

This API is used to get information on the Beefree template for a particular email type. To call this API, the user has to pass in path parameter email type and authentication key to authenticate the user. It will return JSON and HTML of the template and load in bee pro editor.

Response

Here is the description of response attributes, which returns to the form of JSON.

Note: if make first-time beefree template then only beeFreeJson value we can get from system JSON file of particular email type**

Attribute

Description

beeFreeId

It contains a unique id of Beefree template

beeFreeJson

It contains the JSON value of the Beefree template

beeFreeHtml

It contains the html value of the Beefree template

emailType

It contains an email type of Beefree template

customTemplateEnabled

This is a boolean value and if it's true then we are using customized templates to send emails and false means we are using default templates.

Error Codes

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4010101

Not authorized

Language
Credentials
Header
Click Try It! to start a request and see the response here!