Share via


Moosend (Independent Publisher) (Preview)

The ultimate email marketing software and marketing automation platform that will not break your bank. With hundreds of up-to-date templates to choose from, your email marketing campaigns will be dressed for success.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://moosend.com/
Privacy policy https://www.sitecore.com/trust/privacy-policy
Categories Marketing

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add multiple subscribers

Adds multiple subscribers in a mailing list with a single call.

Add subscriber

Adds a new subscriber to the specified mailing list.

Clone an existing campaign

Creates an exact copy of an existing campaign. The new campaign is created as a draft.

Create a custom field

Creates a new custom field in the specified mailing list.

Create a draft campaign

Creates a new draft campaign in your account.

Create a mailing list

Creates a new empty mailing list in your account.

Delete a campaign

Deletes a campaign from your account, draft or even sent.

Delete a mailing list

Deletes a mailing list from your account.

Get AB test campaign summary

Provides a basic summary of the results for a sent AB test campaign, separately for each version (A and B), such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc to date.

Get activity by location

Returns a detailed report of your campaign opens (unique and total) by country.

Get all active mailing lists

Retrieves a list of your active mailing lists in your account.

Get campaign details

Returns a complete set of properties that describe the requested campaign in detail.

Get campaign statistics

Retrieves a detailed list of statistics for a given campaign based on activity such as emails sent, opened, bounced, link clicked, etc.

Get campaign summary

Retrieves a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc. to date.

Get campaigns

Returns a list of all campaigns in your account with detailed information.

Get link activity

Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total.

Get mailing list details

Retrieve details for a given mailing list.

Get sender details

Returns information for the specified sender identified by its email address.

Get senders

Retrieves a list of your active senders in your account.

Get subscriber by email address

Searches for a subscriber with the specified email address in the specified mailing list.

Get subscriber by ID

Searches for a subscriber with the specified unique identifier in the specified mailing list.

Get subscribers

Retrieves a list of all subscribers in a given mailing list.

Remove a custom field

Removes a custom field definition from the specified mailing list.

Remove a subscriber

Removes a subscriber from the specified mailing list permanently.

Remove multiple subscribers

Removes a list of subscribers from the specified mailing list permanently.

Schedule a campaign

Assigns a scheduled date and time at which the campaign will be delivered.

Send a campaign

Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediately.

Test a campaign

Sends a test email of a draft campaign to a list of email addresses you specify for previewing.

Unschedule a campaign

Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.

Unsubscribe subscriber from account

Unsubscribes a subscriber from the account.

Unsubscribe subscriber from mailing list

Unsubscribes a subscriber from the specified mailing list.

Update a custom field

Updates the properties of an existing custom field in the specified mailing list.

Update a draft campaign

Updates properties of an existing draft AB campaign in your account. Non-draft campaigns cannot be updated. Ignore (AB Split Campaign Option) if you want to create a regular campaign.

Update a mailing list

Updates the properties of an existing mailing list.

Update a subscriber

Updates a subscriber in the specified mailing list.

Add multiple subscribers

Adds multiple subscribers in a mailing list with a single call.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Has External Double Opt In
HasExternalDoubleOptIn boolean

Whether has external double opt in.

Name
Name string

The name.

Email
Email string

The email address.

Custom Fields
CustomFields array of string

The custom fields.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context array of object
ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Unsubscribed On
Context.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.SubscribeType integer

The subscribe type.

Subscribe Method
Context.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.CustomFields array of object
Custom Field ID
Context.CustomFields.CustomFieldID string

The custom field identifier.

Name
Context.CustomFields.Name string

The name.

Value
Context.CustomFields.Value string

The value.

Removed On
Context.RemovedOn string

The removed on.

Add subscriber

Adds a new subscriber to the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Name
Name string

The name.

Email
Email string

The email address.

Has External Double Opt In
HasExternalDoubleOptIn boolean

Whether has external double opt in.

Custom Fields
CustomFields array of string

The custom fields.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Unsubscribed On
Context.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.SubscribeType integer

The subscribe type.

Subscribe Method
Context.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.CustomFields array of object
Custom Field ID
Context.CustomFields.CustomFieldID string

The custom field identifier.

Name
Context.CustomFields.Name string

The name.

Value
Context.CustomFields.Value string

The value.

Removed On
Context.RemovedOn string

When removed on.

Clone an existing campaign

Creates an exact copy of an existing campaign. The new campaign is created as a draft.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Subject
Context.Subject string

The subject.

Web Location
Context.WebLocation string

The web location.

HTML Content
Context.HTMLContent string

The HTML content.

Plain Content
Context.PlainContent string

The plain content.

ID
Context.Sender.ID string

The identifier.

Name
Context.Sender.Name string

The name.

Email
Context.Sender.Email string

The email address.

Created On
Context.Sender.CreatedOn string

When created on.

Is Enabled
Context.Sender.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.Sender.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.Sender.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.Sender.DkimPublic string

The public DKIM.

Delivered On
Context.DeliveredOn string

When delivered on.

ID
Context.ReplyToEmail.ID string

The identifier.

Name
Context.ReplyToEmail.Name string

The name.

Email
Context.ReplyToEmail.Email string

The email address.

Created On
Context.ReplyToEmail.CreatedOn string

When created on.

Is Enabled
Context.ReplyToEmail.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.ReplyToEmail.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.ReplyToEmail.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.ReplyToEmail.DkimPublic string

The public DKIM.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Scheduled For
Context.ScheduledFor string

When scheduled for.

Timezone
Context.Timezone string

The timezone.

Format Type
Context.FormatType integer

The format type.

ID
Context.ABCampaignData.ID integer

The identifier.

B Subject
Context.ABCampaignData.SubjectB string

The B subject.

B Plain Content
Context.ABCampaignData.PlainContentB string

The B plain content.

B HTML Content
Context.ABCampaignData.HTMLContentB string

The B HTML content.

B Web Location
Context.ABCampaignData.WebLocationB string

The B web location.

B Sender
Context.ABCampaignData.SenderB string

The B sender.

Hours To Test
Context.ABCampaignData.HoursToTest integer

The hours to test.

List Percentage
Context.ABCampaignData.ListPercentage integer

The list percentage.

AB Campaign Type
Context.ABCampaignData.ABCampaignType integer

The AB campaign type.

AB Winner Selection Type
Context.ABCampaignData.ABWinnerSelectionType integer

The AB winner selection type.

A Delivered On
Context.ABCampaignData.DeliveredOnA string

The A delivered on.

B Delivered On
Context.ABCampaignData.DeliveredOnB string

The B delivered on.

Mailing Lists
Context.MailingLists array of object
Mailing List ID
Context.MailingLists.MailingListID string

The mailing list identifier.

Segment ID
Context.MailingLists.SegmentID integer

The segment identifier.

Confirmation To
Context.ConfirmationTo string

The confirmation to.

Status
Context.Status integer

The status.

Is Transactional
Context.IsTransactional boolean

Whether is transactional.

Create a custom field

Creates a new custom field in the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Name
Name string

The name.

Custom Field Type
CustomFieldType string

The custom field type.

Options
Options string

The options.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Create a draft campaign

Creates a new draft campaign in your account.

Parameters

Name Key Required Type Description
Name
Name string

The name.

Subject
Subject string

The subject.

Sender Email
SenderEmail string

The sender email address.

Reply To Email
ReplyToEmail string

The reply to email address.

Confirmation To Email
ConfirmationToEmail string

The confirmation to email address.

Web Location
WebLocation string

The web location.

Mailing List ID
MailingListID string

The mailing list identifier.

Segment ID
SegmentID string

The segment identifier.

Is AB
IsAB string

The is AB.

AB Campaign Type
ABCampaignType string

The AB campaign type.

B Web Location
WebLocationB string

The B web location.

Hours To Test
HoursToTest string

The hours to test.

List Percentage
ListPercentage string

The list percentage.

AB Winner Selection Type
ABWinnerSelectionType string

The AB winner selection type.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Create a mailing list

Creates a new empty mailing list in your account.

Parameters

Name Key Required Type Description
Name
Name string

The name.

Confirmation Page
ConfirmationPage string

The confirmation page.

Redirect After Unsubscribe Page
RedirectAfterUnsubscribePage string

The redirect after unsubscribe page.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Delete a campaign

Deletes a campaign from your account, draft or even sent.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Delete a mailing list

Deletes a mailing list from your account.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Get AB test campaign summary

Provides a basic summary of the results for a sent AB test campaign, separately for each version (A and B), such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc to date.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Campaign ID
Context.CampaignID string

The campaign identifier.

Campaign ID
Context.A.CampaignID string

The campaign identifier.

AB Version
Context.A.ABVersion integer

The AB version.

Campaign Name
Context.A.CampaignName string

The campaign name.

Campaign Subject
Context.A.CampaignSubject string

The campaign subject.

Mailing Lists
Context.A.MailingLists array of object
Campaign
Context.A.MailingLists.Campaign string

The campaign.

ID
Context.A.MailingLists.MailingList.ID string

The identifier.

Name
Context.A.MailingLists.MailingList.Name string

The name.

Active Member Count
Context.A.MailingLists.MailingList.ActiveMemberCount integer

The active member count.

Bounced Member Count
Context.A.MailingLists.MailingList.BouncedMemberCount integer

The bounced member count.

Removed Member Count
Context.A.MailingLists.MailingList.RemovedMemberCount integer

The removed member count.

Unsubscribed Member Count
Context.A.MailingLists.MailingList.UnsubscribedMemberCount integer

The unsubscribed member count.

Status
Context.A.MailingLists.MailingList.Status integer

The status.

Custom Fields Definition
Context.A.MailingLists.MailingList.CustomFieldsDefinition array of

The custom fields definition.

Created By
Context.A.MailingLists.MailingList.CreatedBy string

The created by.

Created On
Context.A.MailingLists.MailingList.CreatedOn string

When created on.

Updated By
Context.A.MailingLists.MailingList.UpdatedBy string

The updated by.

Updated On
Context.A.MailingLists.MailingList.UpdatedOn string

The updated on.

Import Operation
Context.A.MailingLists.MailingList.ImportOperation string

The import operation.

Segment
Context.A.MailingLists.Segment string

The segment.

Campaign Delivered On
Context.A.CampaignDeliveredOn string

The campaign delivered on.

To
Context.A.To string

The To address.

From
Context.A.From string

The From address.

Total Opens
Context.A.TotalOpens integer

The total opens.

Unique Opens
Context.A.UniqueOpens integer

The unique opens.

Total Bounces
Context.A.TotalBounces integer

The total bounces.

Total Complaints
Context.A.TotalComplaints integer

The total complaints.

Total Forwards
Context.A.TotalForwards integer

The total forwards.

Unique Forwards
Context.A.UniqueForwards integer

The unique forwards.

Total Unsubscribes
Context.A.TotalUnsubscribes integer

The total unsubscribes.

Total Link Clicks
Context.A.TotalLinkClicks integer

The total link clicks.

Unique Link Clicks
Context.A.UniqueLinkClicks integer

The unique link clicks.

Sent
Context.A.Sent integer

The number sent.

Campaign Is Archived
Context.A.CampaignIsArchived boolean

Whether campaign is archived.

Campaign ID
Context.B.CampaignID string

The campaign identifier.

AB Version
Context.B.ABVersion integer

The AB version.

Campaign Name
Context.B.CampaignName string

The campaign name.

Campaign Subject
Context.B.CampaignSubject string

The campaign subject.

Mailing Lists
Context.B.MailingLists array of object
Campaign
Context.B.MailingLists.Campaign string

The campaign.

ID
Context.B.MailingLists.MailingList.ID string

The identifier.

Name
Context.B.MailingLists.MailingList.Name string

The name.

Active Member Count
Context.B.MailingLists.MailingList.ActiveMemberCount integer

The active member count.

Bounced Member Count
Context.B.MailingLists.MailingList.BouncedMemberCount integer

The bounced member count.

Removed Member Count
Context.B.MailingLists.MailingList.RemovedMemberCount integer

The removed member count.

Unsubscribed Member Count
Context.B.MailingLists.MailingList.UnsubscribedMemberCount integer

The unsubscribed member count.

Status
Context.B.MailingLists.MailingList.Status integer

The status.

Custom Fields Definition
Context.B.MailingLists.MailingList.CustomFieldsDefinition array of

The custom fields definition.

Created By
Context.B.MailingLists.MailingList.CreatedBy string

The created by.

Created On
Context.B.MailingLists.MailingList.CreatedOn string

When created on.

Updated By
Context.B.MailingLists.MailingList.UpdatedBy string

The updated by.

Updated On
Context.B.MailingLists.MailingList.UpdatedOn string

The updated on.

Import Operation
Context.B.MailingLists.MailingList.ImportOperation string

The import operation.

Segment
Context.B.MailingLists.Segment string

The segment.

Campaign Delivered On
Context.B.CampaignDeliveredOn string

The campaign delivered on.

To
Context.B.To string

The To address.

From
Context.B.From string

The From address.

Total Opens
Context.B.TotalOpens integer

The total opens.

Unique Opens
Context.B.UniqueOpens integer

The unique opens.

Total Bounces
Context.B.TotalBounces integer

The total bounces.

Total Complaints
Context.B.TotalComplaints integer

The total complaints.

Total Forwards
Context.B.TotalForwards integer

The total forwards.

Unique Forwards
Context.B.UniqueForwards integer

The unique forwards.

Total Unsubscribes
Context.B.TotalUnsubscribes integer

The total unsubscribes.

Total Link Clicks
Context.B.TotalLinkClicks integer

The total link clicks.

Unique Link Clicks
Context.B.UniqueLinkClicks integer

The unique link clicks.

Sent
Context.B.Sent integer

The number sent.

Campaign Is Archived
Context.B.CampaignIsArchived boolean

Whether campaign is archived.

Get activity by location

Returns a detailed report of your campaign opens (unique and total) by country.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Analytics
Context.Analytics array of object
Context
Context.Analytics.Context string

The context.

Context Name
Context.Analytics.ContextName string

The context name.

Total Count
Context.Analytics.TotalCount integer

The total count.

Unique Count
Context.Analytics.UniqueCount integer

The unique count.

Context Description
Context.Analytics.ContextDescription string

The context description.

Get all active mailing lists

Retrieves a list of your active mailing lists in your account.

Parameters

Name Key Required Type Description
Page
Page True integer

The page.

Page Size
PageSize True integer

The page size.

Sort By
SortBy string

The sort by.

Sort Method
SortMethod string

The sort method.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Mailing Lists
Context.MailingLists array of object
ID
Context.MailingLists.ID string

The identifier.

Name
Context.MailingLists.Name string

The name.

Active Member Count
Context.MailingLists.ActiveMemberCount integer

The active member count.

Bounced Member Count
Context.MailingLists.BouncedMemberCount integer

The bounced member count.

Removed Member Count
Context.MailingLists.RemovedMemberCount integer

The removed member count.

Unsubscribed Member Count
Context.MailingLists.UnsubscribedMemberCount integer

The unsubscribed member count.

Status
Context.MailingLists.Status integer

The status.

Custom Fields Definition
Context.MailingLists.CustomFieldsDefinition array of object
ID
Context.MailingLists.CustomFieldsDefinition.ID string

The identifier.

Name
Context.MailingLists.CustomFieldsDefinition.Name string

The name.

Context
Context.MailingLists.CustomFieldsDefinition.Context string

The context.

Is Required
Context.MailingLists.CustomFieldsDefinition.IsRequired boolean

Whether is required.

Type
Context.MailingLists.CustomFieldsDefinition.Type integer

The type.

Created By
Context.MailingLists.CreatedBy string

The created by.

Created On
Context.MailingLists.CreatedOn string

When created on.

Updated By
Context.MailingLists.UpdatedBy string

The updated by.

Updated On
Context.MailingLists.UpdatedOn string

The updated on.

ID
Context.MailingLists.ImportOperation.ID integer

The identifier.

Data Hash
Context.MailingLists.ImportOperation.DataHash string

The data hash.

Mappings
Context.MailingLists.ImportOperation.Mappings string

The mappings.

Email Notify
Context.MailingLists.ImportOperation.EmailNotify string

The notify email.

Created On
Context.MailingLists.ImportOperation.CreatedOn string

When created on.

Started On
Context.MailingLists.ImportOperation.StartedOn string

When started on.

Completed On
Context.MailingLists.ImportOperation.CompletedOn string

When completed on.

Total Inserted
Context.MailingLists.ImportOperation.TotalInserted integer

The total inserted.

Total Updated
Context.MailingLists.ImportOperation.TotalUpdated integer

The total updated.

Total Unsubscribed
Context.MailingLists.ImportOperation.TotalUnsubscribed integer

The total unsubscribed.

Total Invalid
Context.MailingLists.ImportOperation.TotalInvalid integer

The total invalid.

Total Duplicate
Context.MailingLists.ImportOperation.TotalDuplicate integer

The total duplicate.

Total Members
Context.MailingLists.ImportOperation.TotalMembers integer

The total members.

Message
Context.MailingLists.ImportOperation.Message string

The message.

Success
Context.MailingLists.ImportOperation.Success boolean

Whether successful.

Get campaign details

Returns a complete set of properties that describe the requested campaign in detail.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Subject
Context.Subject string

The subject.

Web Location
Context.WebLocation string

The web location.

HTML Content
Context.HTMLContent string

The HTML content.

Plain Content
Context.PlainContent string

The plain content.

ID
Context.Sender.ID string

The identifier.

Name
Context.Sender.Name string

The name.

Email
Context.Sender.Email string

The email address.

Created On
Context.Sender.CreatedOn string

When created on.

Is Enabled
Context.Sender.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.Sender.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.Sender.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.Sender.DkimPublic string

The public DKIM.

Delivered On
Context.DeliveredOn string

When delivered on.

ID
Context.ReplyToEmail.ID string

The identifier.

Name
Context.ReplyToEmail.Name string

The name.

Email
Context.ReplyToEmail.Email string

The email address.

Created On
Context.ReplyToEmail.CreatedOn string

When created on.

Is Enabled
Context.ReplyToEmail.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.ReplyToEmail.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.ReplyToEmail.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.ReplyToEmail.DkimPublic string

The public DKIM.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Scheduled For
Context.ScheduledFor string

When scheduled for.

Timezone
Context.Timezone string

The timezone.

Format Type
Context.FormatType integer

The format type.

AB Campaign Data
Context.ABCampaignData string

The AB campaign data.

Mailing Lists
Context.MailingLists array of object
Mailing List ID
Context.MailingLists.MailingListID string

The mailing list identifier.

Segment ID
Context.MailingLists.SegmentID integer

The segment identifier.

Confirmation To
Context.ConfirmationTo string

The confirmation to.

Status
Context.Status integer

The status.

Is Transactional
Context.IsTransactional boolean

Whether is transactional.

Get campaign statistics

Retrieves a detailed list of statistics for a given campaign based on activity such as emails sent, opened, bounced, link clicked, etc.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Type
Type True string

The type.

Page
Page integer

The page.

Page Size
PageSize integer

The page size.

From
From string

The From address.

To
To string

The To address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Analytics
Context.Analytics array of object
Context
Context.Analytics.Context string

The context.

Context Name
Context.Analytics.ContextName string

The context name.

Total Count
Context.Analytics.TotalCount integer

The total count.

Unique Count
Context.Analytics.UniqueCount integer

The unique count.

Context Description
Context.Analytics.ContextDescription string

The context description.

Get campaign summary

Retrieves a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc. to date.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Campaign ID
Context.CampaignID string

The campaign identifier.

AB Version
Context.ABVersion string

The AB version.

Campaign Name
Context.CampaignName string

The campaign name.

Campaign Subject
Context.CampaignSubject string

The campaign subject.

Mailing Lists
Context.MailingLists array of object
Mailing List ID
Context.MailingLists.MailingListID string

The mailing list identifier.

Segment ID
Context.MailingLists.SegmentID integer

The segment identifier.

Campaign Delivered On
Context.CampaignDeliveredOn string

When campaign delivered on.

To
Context.To string

The To address.

From
Context.From string

The From address.

Total Opens
Context.TotalOpens integer

The total opens.

Unique Opens
Context.UniqueOpens integer

The unique opens.

Total Bounces
Context.TotalBounces integer

The total bounces.

Total Complaints
Context.TotalComplaints integer

The total complaints.

Total Forwards
Context.TotalForwards integer

The total forwards.

Unique Forwards
Context.UniqueForwards integer

The unique forwards.

Total Unsubscribes
Context.TotalUnsubscribes integer

The total unsubscribes.

Total Link Clicks
Context.TotalLinkClicks integer

The total link clicks.

Unique Link Clicks
Context.UniqueLinkClicks integer

The unique link clicks.

Sent
Context.Sent integer

The number sent.

Campaign Is Archived
Context.CampaignIsArchived boolean

Whether campaign is archived.

Get campaigns

Returns a list of all campaigns in your account with detailed information.

Parameters

Name Key Required Type Description
Page
Page True string

The page.

Page Size
PageSize True string

The page size.

Sort By
SortBy string

The sort by.

Sort Method
SortMethod string

The sort method.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Campaigns
Context.Campaigns array of object
ID
Context.Campaigns.ID string

The identifier.

Name
Context.Campaigns.Name string

The name.

Subject
Context.Campaigns.Subject string

The subject.

Site Name
Context.Campaigns.SiteName string

The site name.

Confirmation To
Context.Campaigns.ConfirmationTo string

The confirmation to.

Created On
Context.Campaigns.CreatedOn string

When created on.

AB Hours To Test
Context.Campaigns.ABHoursToTest string

The AB hours to test.

AB Campaign Type
Context.Campaigns.ABCampaignType string

The AB campaign type.

A/ B Winner
Context.Campaigns.ABWinner string

The AB winner.

AB Winner Selection Type
Context.Campaigns.ABWinnerSelectionType string

The AB winner selection type.

Status
Context.Campaigns.Status integer

The status.

Delivered On
Context.Campaigns.DeliveredOn string

When delivered on.

Scheduled For
Context.Campaigns.ScheduledFor string

When scheduled for.

Scheduled For Timezone
Context.Campaigns.ScheduledForTimezone string

The scheduled for timezone.

Mailing Lists
Context.Campaigns.MailingLists array of object
Campaign
Context.Campaigns.MailingLists.Campaign string

The campaign.

ID
Context.Campaigns.MailingLists.MailingList.ID string

The identifier.

Name
Context.Campaigns.MailingLists.MailingList.Name string

The name.

Active Member Count
Context.Campaigns.MailingLists.MailingList.ActiveMemberCount integer

The active member count.

Bounced Member Count
Context.Campaigns.MailingLists.MailingList.BouncedMemberCount integer

The bounced member count.

Removed Member Count
Context.Campaigns.MailingLists.MailingList.RemovedMemberCount integer

The removed member count.

Unsubscribed Member Count
Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount integer

The unsubscribed member count.

Status
Context.Campaigns.MailingLists.MailingList.Status integer

The status.

Custom Fields Definition
Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition array of

The custom fields definition.

Created By
Context.Campaigns.MailingLists.MailingList.CreatedBy string

The created by.

Created On
Context.Campaigns.MailingLists.MailingList.CreatedOn string

When created on.

Updated By
Context.Campaigns.MailingLists.MailingList.UpdatedBy string

The updated by.

Updated On
Context.Campaigns.MailingLists.MailingList.UpdatedOn string

When updated on.

Import Operation
Context.Campaigns.MailingLists.MailingList.ImportOperation string

The import operation.

Segment
Context.Campaigns.MailingLists.Segment string

The segment.

Total Sent
Context.Campaigns.TotalSent integer

The total sent.

Total Opens
Context.Campaigns.TotalOpens integer

The total opens.

Unique Opens
Context.Campaigns.UniqueOpens integer

The unique opens.

Total Bounces
Context.Campaigns.TotalBounces integer

The total bounces.

Total Forwards
Context.Campaigns.TotalForwards integer

The total forwards.

Unique Forwards
Context.Campaigns.UniqueForwards integer

The unique forwards.

Total Link Clicks
Context.Campaigns.TotalLinkClicks integer

The total link clicks.

Unique Link Clicks
Context.Campaigns.UniqueLinkClicks integer

The unique link clicks.

Recipients Count
Context.Campaigns.RecipientsCount integer

The recipients count.

Is Transactional
Context.Campaigns.IsTransactional boolean

Whether is transactional.

Total Complaints
Context.Campaigns.TotalComplaints integer

The total complaints.

Total Unsubscribes
Context.Campaigns.TotalUnsubscribes integer

The total unsubscribes.

Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Analytics
Context.Analytics array of object
Context
Context.Analytics.Context string

The context.

Context Name
Context.Analytics.ContextName string

The context name.

Total Count
Context.Analytics.TotalCount integer

The total count.

Unique Count
Context.Analytics.UniqueCount integer

The unique count.

Context Description
Context.Analytics.ContextDescription string

The context description.

Get mailing list details

Retrieve details for a given mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

With Statistics
WithStatistics boolean

Whether with statistics.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Active Member Count
Context.ActiveMemberCount integer

The active member count.

Bounced Member Count
Context.BouncedMemberCount integer

The bounced member count.

Removed Member Count
Context.RemovedMemberCount integer

The removed member count.

Unsubscribed Member Count
Context.UnsubscribedMemberCount integer

The unsubscribed member count.

Status
Context.Status integer

The status.

Custom Fields Definition
Context.CustomFieldsDefinition array of object
ID
Context.CustomFieldsDefinition.ID string

The identifier.

Name
Context.CustomFieldsDefinition.Name string

The name.

Context
Context.CustomFieldsDefinition.Context string

The context.

Is Required
Context.CustomFieldsDefinition.IsRequired boolean

Whether is required.

Type
Context.CustomFieldsDefinition.Type integer

The type.

Created By
Context.CreatedBy string

The created by.

Created On
Context.CreatedOn string

When created on.

Updated By
Context.UpdatedBy string

The updated by.

Updated On
Context.UpdatedOn string

When updated on.

ID
Context.ImportOperation.ID integer

The identifier.

Data Hash
Context.ImportOperation.DataHash string

The data hash.

Mappings
Context.ImportOperation.Mappings string

The mappings.

Email Notify
Context.ImportOperation.EmailNotify string

The email notify.

Created On
Context.ImportOperation.CreatedOn string

When created on.

Started On
Context.ImportOperation.StartedOn string

When started on.

Completed On
Context.ImportOperation.CompletedOn string

When completed on.

Total Inserted
Context.ImportOperation.TotalInserted integer

The total inserted.

Total Updated
Context.ImportOperation.TotalUpdated integer

The total updated.

Total Unsubscribed
Context.ImportOperation.TotalUnsubscribed integer

The total unsubscribed.

Total Invalid
Context.ImportOperation.TotalInvalid integer

The total invalid.

Total Ignored
Context.ImportOperation.TotalIgnored integer

The total ignored.

Total Duplicate
Context.ImportOperation.TotalDuplicate integer

The total duplicate.

Total Members
Context.ImportOperation.TotalMembers integer

The total members.

Message
Context.ImportOperation.Message string

The message.

Success
Context.ImportOperation.Success boolean

Whether successful.

Skip New Members
Context.ImportOperation.SkipNewMembers boolean

Whether to skip new members.

Get sender details

Returns information for the specified sender identified by its email address.

Parameters

Name Key Required Type Description
Email
Email True string

The email address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Is Enabled
Context.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.DkimPublic string

The public DKIM.

Get senders

Retrieves a list of your active senders in your account.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context array of object
ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Is Enabled
Context.IsEnabled boolean

Whether is enabled.

SPF Verified
Context.SpfVerified boolean

Whether SPF verified.

DKIM Verified
Context.DkimVerified boolean

Whether DKIM verified.

DKIM Public
Context.DkimPublic string

The public DKIM.

Get subscriber by email address

Searches for a subscriber with the specified email address in the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Email
Email True string

The email address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Unsubscribed On
Context.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.SubscribeType integer

The subscribe type.

Subscribe Method
Context.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.CustomFields array of object
Custom Field ID
Context.CustomFields.CustomFieldID string

The custom field identifier.

Name
Context.CustomFields.Name string

The name.

Value
Context.CustomFields.Value string

The value.

Removed On
Context.RemovedOn string

When removed on.

Get subscriber by ID

Searches for a subscriber with the specified unique identifier in the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Subscriber ID
SubscriberId True string

The subscriber identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Unsubscribed On
Context.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.SubscribeType integer

The subscribe type.

Subscribe Method
Context.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.CustomFields array of

The custom fields.

Removed On
Context.RemovedOn string

When removed on.

Get subscribers

Retrieves a list of all subscribers in a given mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Page
Page integer

The page.

Page Size
PageSize integer

The page size.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Page Size
Context.Paging.PageSize integer

The page size.

Current Page
Context.Paging.CurrentPage integer

The current page.

Total Results
Context.Paging.TotalResults integer

The total results.

Total Page Count
Context.Paging.TotalPageCount integer

The total page count.

Sort Expression
Context.Paging.SortExpression string

The sort expression.

Sort Is Ascending
Context.Paging.SortIsAscending boolean

Whether the sort is ascending.

Subscribers
Context.Subscribers array of object
ID
Context.Subscribers.ID string

The identifier.

Name
Context.Subscribers.Name string

The name.

Email
Context.Subscribers.Email string

The email address.

Created On
Context.Subscribers.CreatedOn string

When created on.

Updated On
Context.Subscribers.UpdatedOn string

The updated on.

Unsubscribed On
Context.Subscribers.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.Subscribers.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.Subscribers.SubscribeType integer

The subscribe type.

Subscribe Method
Context.Subscribers.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.Subscribers.CustomFields array of object
Custom Field ID
Context.Subscribers.CustomFields.CustomFieldID string

The custom field identifier.

Name
Context.Subscribers.CustomFields.Name string

The name.

Value
Context.Subscribers.CustomFields.Value string

The value.

Removed On
Context.Subscribers.RemovedOn string

When removed on.

Remove a custom field

Removes a custom field definition from the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Custom Field ID
CustomFieldId True string

The custom field identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Remove a subscriber

Removes a subscriber from the specified mailing list permanently.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Email
Email True string

The email address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Remove multiple subscribers

Removes a list of subscribers from the specified mailing list permanently.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Emails
Emails True string

The emails.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Emails Ignored
Context.EmailsIgnored integer

The emails ignored.

Emails Processed
Context.EmailsProcessed integer

The emails processed.

Schedule a campaign

Assigns a scheduled date and time at which the campaign will be delivered.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Date Time
DateTime True string

The date and time.

Timezone
Timezone string

The timezone.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Send a campaign

Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediately.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Test a campaign

Sends a test email of a draft campaign to a list of email addresses you specify for previewing.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Test Emails
TestEmails True array of string

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Unschedule a campaign

Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Unsubscribe subscriber from account

Unsubscribes a subscriber from the account.

Parameters

Name Key Required Type Description
Email
Email True string

The email address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Unsubscribe subscriber from mailing list

Unsubscribes a subscriber from the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Email
Email True string

The email address.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Update a custom field

Updates the properties of an existing custom field in the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Custom Field ID
CustomFieldId True string

The custom field identifier.

Name
Name string

The name.

Custom Field Type
CustomFieldType string

The custom field type.

Options
Options string

The options.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Update a draft campaign

Updates properties of an existing draft AB campaign in your account. Non-draft campaigns cannot be updated. Ignore (AB Split Campaign Option) if you want to create a regular campaign.

Parameters

Name Key Required Type Description
Campaign ID
CampaignId True string

The campaign identifier.

Name
Name string

The name.

Subject
Subject string

The subject.

Sender Email
SenderEmail string

The sender email address.

Reply To Email
ReplyToEmail string

The reply to email address.

Confirmation To Email
ConfirmationToEmail string

The confirmation to email address.

Web Location
WebLocation string

The web location.

Mailing List ID
MailingListID string

The mailing list identifier.

Segment ID
SegmentID string

The segment identifier.

Is AB
IsAB string

The is AB.

AB Campaign Type
ABCampaignType string

The AB campaign type.

B Web Location
WebLocationB string

The B web location.

Hours To Test
HoursToTest string

The hours to test.

List Percentage
ListPercentage string

The list percentage.

AB Winner Selection Type
ABWinnerSelectionType string

The AB winner selection type.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Update a mailing list

Updates the properties of an existing mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Name
Name string

The name.

Confirmation Page
ConfirmationPage string

The confirmation page.

Redirect After Unsubscribe Page
RedirectAfterUnsubscribePage string

The redirect after unsubscribe page.

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

Context
Context string

The context.

Update a subscriber

Updates a subscriber in the specified mailing list.

Parameters

Name Key Required Type Description
Mailing List ID
MailingListId True string

The mailing list identifier.

Subscriber ID
SubscriberId True string

The subscriber identifier.

Name
Name string

The name.

Has External Double Opt In
HasExternalDoubleOptIn boolean

Whether has external double opt in.

Email
Email string

The email address.

Custom Fields
CustomFields array of string

Returns

Name Path Type Description
Code
Code integer

The code.

Error
Error string

The error.

ID
Context.ID string

The identifier.

Name
Context.Name string

The name.

Email
Context.Email string

The email address.

Created On
Context.CreatedOn string

When created on.

Updated On
Context.UpdatedOn string

When updated on.

Unsubscribed On
Context.UnsubscribedOn string

When unsubscribed on.

Unsubscribed From ID
Context.UnsubscribedFromID string

The unsubscribed from identifier.

Subscribe Type
Context.SubscribeType integer

The subscribe type.

Subscribe Method
Context.SubscribeMethod integer

The subscribe method.

Custom Fields
Context.CustomFields array of object
Custom Field ID
Context.CustomFields.CustomFieldID string

The custom field identifier.

Name
Context.CustomFields.Name string

The name.

Value
Context.CustomFields.Value string

The value.

Removed On
Context.RemovedOn string

When removed on.