get
https://api.accelevents.com/rest/host/event//contact/message
This API Used to get all email template associated with the specified event.
API used at host side event admin and super admin can access this API. It will return data like dateSentOrSchedule, encodedTemplateId, messageJson, replyToEmail, subjectLine, ticketTypeIds and other details.
To call this API, user have to pass query param with API URL like searchString, isNotification and authentication key to authenticate user.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Here is the description of response attributes, which returns in the form of JSON.
| Attribute | Description |
|---|---|
| dateSentOrSchedule | It'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 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. |
| 4030201 | Not Event Host |