API Reference

Get BeeFree Template

This API is used to get BeeFree Template. API used at host side event admin and super admin can access this API. It will return data like beeFreeHtml, beeFreeId, beeFreeJson, emailType.

To call this API, the user will have to pass an authentication key to authenticate the user and the name of emailType for which we want to get details for the BeeFree template. (Ex. of email type: REMINDER, ORDER_CONFIRMATION)

Response

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

Attributes

Description

beeFreeId

This field returns a BeeFree id

beeFreeJson

This field returns a BeeFree json value

beeFreeHtml

This field returns a BeeFree html value

emailType

This field returns the email type. ex: REMINDER, ORDER_CONFIRMATION

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

200

OK

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.

4040200

Event Not Found

4030201

Not Event Host

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