Connectors Reference
JungleMail for Office 365 is a service that helps companies deliver personalized newsletters to their employees and their customers and increase engagement. Connect to JungleMail 365 to create newsletters, approve them and get analytical data.
|
Status: Preview |
Tier: Premium |
Version: v1.0 |
|
Name |
Summary |
|
Delete webhook |
|
|
Get processed emails list |
|
|
Approve newsletter |
|
|
Create newsletter |
|
|
Get newsletter details |
|
|
Get newsletters |
|
|
Get analytics report |
|
|
Reject newsletter |
|
|
Get all list email fields |
|
|
Get all list views |
|
|
Get Schema |
|
|
Get all sending addresses |
|
|
Get all templates |
|
|
Get all time zones |
|
|
TrackerLog_Get (string request.jobId, string request.dataType) |
Get analytics log |
|
Get unsubscribes |
|
Name |
Summary |
|
Webhook_JobCompleted (Webhook_JobCompletedParameterRequest request) |
When newsletter processing is completed |
|
Webhook_JobStarted (Webhook_JobStartedParameterRequest request) |
When newsletter processing is started |
|
Webhook_JobSumitted (Webhook_JobSumittedParameterRequest request) |
When a newsletter is submitted |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Delete webhook
Description: Delete webhook
Syntax:
JungleMail365.DeleteWebhook (string hookid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
hookid |
string(uuid)
|
|
True |
Returns:
Summary: Get processed emails list
Description: Get processed emails list
Syntax:
JungleMail365.Emails_Get (string request.jobId, string request.emailType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.jobId |
string(uuid) (Newsletter id) |
Newsletter id to retrieve |
True |
|
|
request.emailType |
string (Filter type)Values: [Sent, Skipped, Failed, Completed] |
Email filter type |
True |
Returns:
Type:JsEmailsResponse
Summary: Approve newsletter
Description: Approve and execute JungleMail 365 newsletter.
Syntax:
JungleMail365.Job_Approve (JsApproveJobRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:JsApproveJobResponse
Summary: Create newsletter
Description: Create JungleMail 365 newsletter.
Syntax:
JungleMail365.Job_Create (JsCreateJobRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:JsCreateJobResponse
Summary: Get newsletter details
Description: Get newsletter details.
Syntax:
JungleMail365.Job_Get (string request.jobId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.jobId |
string(uuid) (Newsletter id) |
Specify newsletter id to retrieve |
True |
Returns:
Type:JsJob
Summary: Get newsletters
Description: Get the list of recently completed newsletters.
Syntax:
JungleMail365.Job_GetAll ([Optional]string request.dateFrom, [Optional]string request.dateTo, [Optional]integer request.limit)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.dateFrom |
string(date-time) (Date from) |
Date from (UTC, ISO 8601 format) |
False |
|
|
request.dateTo |
string(date-time) (Date to) |
Date to (UTC, ISO 8601 format) |
False |
|
|
request.limit |
integer(int32) (Limit) |
Number of newsletters to retrieve (up to 200) |
False |
Returns:
Type:JsJobsResponse
Summary: Get analytics report
Description: Get newsletter analytics report.
Syntax:
JungleMail365.Job_GetReport (string request.jobId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.jobId |
string(uuid) (Newsletter id) |
Specify newsletter id to retrieve |
True |
Returns:
Type:JsJobReport
Summary: Reject newsletter
Description: Reject JungleMail 365 newsletter.
Syntax:
JungleMail365.Job_Reject (JsRejectJobRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:JsRejectJobResponse
Summary: Get all list email fields
Description: Get all list email fields
Syntax:
JungleMail365.List_GetListEmailFields (string listUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
listUrl |
string
|
|
True |
Returns:
Type:array of (JsListViewResponse)
Summary: Get all list views
Description: Get all list views
Syntax:
JungleMail365.List_GetListViews (string listUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
listUrl |
string
|
|
True |
Returns:
Type:array of (JsListViewResponse)
Summary: Get Schema
Description: Get schema by job recipient type.
Syntax:
JungleMail365.Schema_GetJobRecipientTypeSchema (string type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
type |
string
|
|
True |
Returns:
Type:JsSchemaResponse
Summary: Get all sending addresses
Description: Get all sending addresses
Syntax:
JungleMail365.SendingAddresses_GetAll ()
Returns:
Type:array of (JsSendingAddress)
Summary: Get all templates
Description: Get all templates
Syntax:
JungleMail365.Templates_GetAll ()
Returns:
Type:array of (JsTemplateResponse)
Summary: Get all time zones
Description: Get all time zones
Syntax:
JungleMail365.TimeZones_GetAllTimeZones ()
Returns:
Type:array of (JsTimeZoneResponse)
Summary: Get analytics log
Description: Get analytics log
Syntax:
JungleMail365.TrackerLog_Get (string request.jobId, string request.dataType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.jobId |
string(uuid) (Newsletter id) |
Specify newsletter id to retrieve tracker log |
True |
|
|
request.dataType |
string (Data type)Values: [OpensUnique, OpensTotal, OpensUnopened, ClicksUnique, ClicksTotal, ClicksNotClicked, Unsubscribes, Bounces, FailedEmails, SkippedEmails] |
Specify log type to retrieve |
True |
Returns:
Type:JsTrackerLogResponse
Summary: Get unsubscribes
Description: Get unsubscribes
Syntax:
JungleMail365.Unsubscribes_Get ([Optional]string request.jobId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request.jobId |
string(uuid) (Newsletter id) |
If not specified then all unsubcribes will be retrieved |
False |
Returns:
Summary: When newsletter processing is completed
Description: This operation triggers a flow when a JungleMail 365 newsletter processing is completed.
Syntax:
JungleMail365.Webhook_JobCompleted (Webhook_JobCompletedParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
Webhook_JobCompletedParameterRequest
|
|
True |
Returns:
Summary: When newsletter processing is started
Description: This operation triggers a flow when a JungleMail 365 newsletter processing is started.
Syntax:
JungleMail365.Webhook_JobStarted (Webhook_JobStartedParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
Webhook_JobStartedParameterRequest
|
|
True |
Returns:
Summary: When a newsletter is submitted
Description: This operation triggers a flow when a JungleMail 365 newsletter is submitted.
Syntax:
JungleMail365.Webhook_JobSumitted (Webhook_JobSumittedParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
Webhook_JobSumittedParameterRequest
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
comments |
string Comments |
Specify details or reason |
|
secret |
string(uuid) Secret |
Newsletter secret from "When a newsletter is submitted" trigger. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
adGroups |
string Office 365 groups |
Office 365 group names comma separated |
|
attachmentContent |
string(byte) Attachment content |
Attachment content |
|
attachmentName |
string Attachment name |
Attachment file name with extension (ex. document.docx) |
|
emailAddresses |
string Email addresses |
Email addresses comma separated |
|
emailBody |
string Email content |
Email content (html or text) |
|
emailContentType |
string Email content type |
Specify email content type Values: [Template, Html] |
|
emailSubject |
string Email subject |
Specify email subject |
|
exchangeGroups |
string Exchange groups |
Exchange groups comma separated |
|
jobExecutionType |
string When to send type |
Specify when to send newsletter type Values: [Now, AtSpecifiedTime] |
|
jobScheduleTime |
string(date-time) When to send |
Newsletter execution time (ISO 8601 or yyyy-MM-dd HH:mm), ex: 2017-02-16 20:30 |
|
recipientListField |
string Recipient email field |
SharePoint list recipient field id or name |
|
recipientListUrl |
string Recipient list URL |
SharePoint list URL of recipients list |
|
recipientListView |
string Recipient filter view |
SharePoint list view name for filter |
|
recipientType |
string Recipient source |
Newsletter recipient source Values: [Emails, List, Office365Groups, ExchangeGroups] |
|
removeDuplicates |
boolean Remove duplicates |
Remove email duplicates |
|
reportAuthor |
boolean Send report |
Send newsletter report after finish |
|
scheduledTimeZoneId |
string Time zone |
Time zone for sending date adjustment |
|
sendingAddressId |
string(uuid) Sending account |
Sending account for email sending |
|
template |
string Template |
Template for email content |
|
title |
string Newsletter title |
Specify newsletter title |
|
trackClicks |
boolean Track clicks |
Track clicks |
|
trackOpens |
boolean Track opens |
Track opens |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
errorMessage |
string
|
|
|
id |
string(uuid)
|
|
|
success |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientAddress |
string Recipient email |
Recipient email address |
|
recipientId |
string Recipient id |
Recipient id depends on recipient source |
|
recipientItemId |
integer(int32) Recipient item id |
Recipient item id if recipient from SharePoint list |
|
recipientName |
string Recipient name |
Recipient name |
|
recipientSource |
string Recipient source |
Recipient source type name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
emails |
array of (JsEmail) Emails |
Emails list |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createdByEmail |
string Created by email |
Email of a user who created a newsletter |
|
createdById |
integer(int32) Created by id |
Id of a user who created a newsletter |
|
createdByTitle |
string Created by |
Name of a user who created a newsletter |
|
createdTime |
string(date-time) Created time |
Time when newsletter was created |
|
displayName |
string Newsletter display name |
Newsletter display name |
|
emailSubject |
string Email subject |
Email subject |
|
emailbody |
string Email HTML |
Email content in HTML format |
|
id |
string(uuid) Newsletter id |
Newsletter id |
|
isRecurrent |
boolean Is recurrent |
Status if newsletter is recurrent (true or false) |
|
isScheduled |
boolean Is scheduled |
Status if newsletter is scheduled (true or false) |
|
modifiedByEmail |
string Modified by email |
Email of a user who modified a newsletter |
|
modifiedById |
integer(int32) Modified by id |
Id of a user who modified a newsletter |
|
modifiedByTitle |
string Modified by |
Name of a user who modified a newsletter |
|
modifiedTime |
string(date-time) Modified time |
Time when newsletter was modified |
|
previewUrl |
string Preview URL |
Newsletter preview URL |
|
scheduledTime |
string(date-time) Scheduled time |
Time when newsletter should be sent |
|
sendFailedCount |
integer(int32) Send failed count |
Number of failed emails |
|
sendPercent |
number(double) Send percent |
Send percent (number) |
|
sendPercentFormatted |
string Send percent |
Send percent (plain text) |
|
sendSkippedCount |
integer(int32) Send skipped count |
Number of skipped emails |
|
sendSucceededCount |
integer(int32) Send succeeded count |
Number of send succeeded emails |
|
sendTime |
string(date-time) Send time |
Time when newsletter was sent |
|
sendTotal |
integer(int32) Send total |
Number of total emails |
|
status |
string Status |
Newsletter current status |
|
submittedByEmail |
string Submitted by email |
Email of a user who submitted a newsletter |
|
submittedById |
integer(int32) Submitted by id |
Id of a user who submitted a newsletter |
|
submittedByTitle |
string Submitted by |
Name of a user who submitted a newsletter |
|
submittedTime |
string(date-time) Submitted time |
Time when newsletter was submitted |
|
title |
string Newsletter title |
Newsletter title |
|
totalRecipients |
integer(int32) Total recipients |
Total resolved recipients count after newsletter submission |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
jobId |
string(uuid) Newsletter id |
Newsletter id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
bounces |
integer(int32) Bounces |
Number of total bounces |
|
bouncesRate |
number(double) Bounces rate |
Bouces rate (number) |
|
bouncesRateFormatted |
string Bounces rate |
Bounces rate (plain text) |
|
devicesDesktopCount |
integer(int32) Devices desktop |
Number of emails opened on desktop computers |
|
devicesDesktopRate |
number(double) Devices desktop rate |
Emails opened on desktop computers rate (number) |
|
devicesDesktopRateFormatted |
string Devices desktop rate |
Emails opened on desktop computers rate (plain text) |
|
devicesOtherCount |
integer(int32) Devices other |
Number of emails opened on unknown device |
|
devicesPhoneCount |
integer(int32) Devices phone |
Number of emails opened on mobile phones |
|
devicesPhoneRate |
number(double) Devices phone rate |
Emails opened on mobile phones rate (number) |
|
devicesPhoneRateFormatted |
string Devices phone rate |
Emails opened on mobile phones rate (plain text) |
|
devicesTabletCount |
integer(int32) Devices tablet |
Number of emails opened on tablet devices |
|
devicesTabletRate |
number(double) Devices tablet rate |
Emails opened on tablet devices rate (number) |
|
devicesTabletRateFormatted |
string Devices tablet rate |
Emails opened on tablet devices rate (plain text) |
|
emailOpensRate |
number(double) Email opens rate |
Email opens rate (number) |
|
emailOpensRateFormatted |
string Email opens rate |
Email opens rate (plain text) |
|
emailOpensTotal |
integer(int32) Total email opens |
Number of total email opens |
|
emailOpensUnique |
integer(int32) Unique email opens |
Number of unique email opens |
|
emailSubject |
string Email subject |
Email subject |
|
emailsFailed |
integer(int32) Emails failed |
Number of emails failed |
|
emailsSent |
integer(int32) Total emails sent |
Number of emails sent |
|
emailsSkipped |
integer(int32) Emails skipped |
Number of emails skipped |
|
emailsTotal |
integer(int32) Total emails |
Number of total emails processed |
|
emailsUnopened |
integer(int32) Emails unopened |
Unopened emails |
|
jobDisplayName |
string Newsletter display name |
Newsletter display name |
|
jobTitle |
string Newsletter title |
Newsletter title |
|
linkClicksRate |
number(double) Link clicks rate |
Link clicks rate (number) |
|
linkClicksRateFormatted |
string Link clicks rate |
Link clicks rate (plain text) |
|
linkClicksTotal |
integer(int32) Total link clicks |
Number of total link clicks |
|
linkClicksUnique |
integer(int32) Unique link clicks |
Number of unique link clicks |
|
linksNotClicked |
integer(int32) Links not clicked |
Number of total emails with unclicked links |
|
reportHtml |
string Report in HTML |
Send analytics report in HTML format |
|
sendTime |
string(date-time) Send time |
Time when newsletter was sent |
|
submittedBy |
string Submitted by |
Name of a user who submitted a newsletter |
|
submittedByEmail |
string Submitted by email |
Email of a user who submitted a newsletter |
|
submittedById |
string Submitted by id |
Id of a user who submitted a newsletter |
|
topLinks |
array of (JsTopLink) Top links |
Top links list |
|
unsubscribes |
integer(int32) Total unsubscribes |
Number of total unsubscribes |
|
unsubscribesRate |
number(double) Unsubscribes rate |
Unsuscribes rate (number) |
|
unsubscribesRateFormatted |
string Unsubscribes rate |
Unsubscribes rate (plain text) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
jobs |
array of (JsJobInfo) Newsletters |
Newsletters list |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
|
|
title |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
comments |
string Comments |
Specify details or reason |
|
secret |
string(uuid) Secret |
Newsletter secret from "When a newsletter is submitted" trigger. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
Schema |
Summary:
Description: Schema
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string
|
|
|
id |
string(uuid)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
body |
string
|
Email body |
|
displayTitle |
string
|
Template title for display |
|
emailSubject |
string
|
Email subject |
|
id |
string(uuid)
|
Template Id |
|
isBuilder |
boolean
|
Is template builder |
|
title |
string
|
Template Title |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
title |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
linkClicksTotal |
string Total link clicks |
Number of total link clicks |
|
linkClicksUnique |
string Unique link clicks |
Number of unique link clicks |
|
linkIndex |
integer(int32) Index |
Link index number |
|
url |
string URL |
Link URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
trackerLog |
array of (JsTrackerLogRow) TrackerLog |
Tracker log |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
bounceDescription |
string Bounce description |
Bounce description (availble only in bounces) |
|
bounceReason |
string Bounce reason |
Bounce reason (availble only in bounces) |
|
bounceType |
integer(int32) Bounce type |
Bounce type (availble only in bounces) |
|
bouncedOn |
string(date-time) Bounced time |
When email bounced (available only in bounces) |
|
clickCount |
integer(int32) Clicks count |
Total email clicks (available only in unique clicks) |
|
clickedOn |
string(date-time) Clicked time |
When email clicked (available only in total clicks) |
|
|
string |
Recipient email address |
|
firstTimeClickedOn |
string(date-time) First click time |
When email first time clicked (available only in unique clicks) |
|
firstTimeOpenedOn |
string(date-time) First open time |
When email first time opened (available only in unique opens) |
|
ipAddress |
string IP address |
IP address (available in total opens and clicks) |
|
linkUrl |
string Link URL |
URL of clicked (available in total clicks) |
|
openCount |
integer(int32) Open count |
Total email opens (available only in unique opens) |
|
openedOn |
string(date-time) Opened time |
When email opened (available only in total opens) |
|
unsubscribedOn |
string(date-time) Unsubscribed time |
When email unsubscribed |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientAddress |
string Recipient email |
Recipient email address |
|
recipientId |
string Recipient id |
Recipient id depends on recipient source |
|
recipientItemId |
integer(int32) Recipient item id |
Recipient item id if recipient from SharePoint list |
|
recipientName |
string Recipient name |
Recipient name |
|
recipientSource |
string Recipient source |
Recipient source type name |
|
unsubscribeTime |
string(date-time) Unsubscribe Time |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
unsubscribes |
array of (JsUnsubscribe) Unsubscribes |
Unsubscribes list |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
succeeded |
boolean
|
Webhook Creation Status |
|
webhookId |
string(uuid)
|
Webhook Id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
Title used in JungleMail Settings for a reference |
|
triggerUrl |
string
|
Trigger Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
Title used in JungleMail Settings for a reference |
|
triggerUrl |
string
|
Trigger Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
Title used in JungleMail Settings for a reference |
|
triggerUrl |
string
|
Trigger Url |