API Reference

Create Email Template

A user can use this API to create a email template for an event.
This API can be access by event admin and super admin.
For creating new email template, need to pass request body param for message Contact Details.
User have to pass their authentication key for user authentication.
This API used at host side to create new email template.

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

AttributeDescription
sentToCount It's contains the total number of people to whom message sent
dateSentOrScheduleIt's contains message sent or schedule on date. When the particular message sent on date, and it will return in MM/dd/yyyy HH:mm format.
encodedTemplateId It's contains the encoded template id. for examaple AvtpqJSmT9fPWH_OnYJ0Sg
id id of contact, if record exists in system.
messageJson It's contains the message json string.
notificationIcon It's contains the notification icon.
replyToEmail It's contains the reply to email address.
scheduledAT It's contains scheduled time of the message. When the particular message sent on specific time, and it will return in MM/dd/yyyy HH:mm format.
sendTo send list must be either of ALL_CONTACTS, ALL_TICKER_HOLDER_AND_BUYERS, ALL_AUCTION_PARTICIPANTS, ALL_AUCTION_WINNERS, ALL_RAFFLE_WINNERS, ALL_FUND_A_NEED_PLEDGERS, ALL_TEXT_TO_GIVE_DONORS, BY_TICKET_TYPE_VIA, ALL_SPEAKERS, ALL_EXHIBITORS, CHECKED_IN, NOT_CHECKED_IN, ALL_RAFFLE_PARTICIPANTS.
sentToCount It's contains the total number of people to whom message sent.
status It's contains the status of the email message.it will return all data like SENT,SCHEDULED etc.
subjectLine The message's title as subject line.
targetAudienceType It's contains the target audience type should be All, WEB_APP, MOBILE_APP.
ticketTypeIds Ticket Type Id to send mail if EMAIL_RECIPIENTS is BY_TICKET_TYPE_VIA
type There are two type of message like Email OR Notification.

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

Error codeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
Language
Credentials
Header
Click Try It! to start a request and see the response here!