Account

Load

Loads your account. Returns detailed information about your account.

/account/load

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { Account } }

Example

https://api.emailwiz.com/v2/account/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadAdvancedOptions

Load advanced options of your account

/account/loadadvancedoptions

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { AdvancedOptions } }

Example

https://api.emailwiz.com/v2/account/loadadvancedoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadEmailCreditsHistory

Lists email credits history

/account/loademailcreditshistory

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of EmailCredits } }

Example

https://api.emailwiz.com/v2/account/loademailcreditshistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadLitmusCreditsHistory

Lists litmus credits history

/account/loadlitmuscreditshistory

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of LitmusCredits } }

Example

https://api.emailwiz.com/v2/account/loadlitmuscreditshistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadNotificationQueue

Shows queue of newest notifications – very useful when you want to check what happened with mails that were not received.

/account/loadnotificationqueue

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of NotificationQueue } }

Example

https://api.emailwiz.com/v2/account/loadnotificationqueue?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadReputationHistory

Shows latest changes in your sending reputation

/account/loadreputationhistory

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
limit int 20 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { List of ReputationHistory } }

Example

https://api.emailwiz.com/v2/account/loadreputationhistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

Back To Top

LoadReputationImpact

Shows detailed information about your actual reputation score

/account/loadreputationimpact

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { ReputationDetail } }

Example

https://api.emailwiz.com/v2/account/loadreputationimpact?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

LoadSpamCheck

Returns detailed spam check.

/account/loadspamcheck

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
limit int 20 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { List of SpamCheck } }

Example

https://api.emailwiz.com/v2/account/loadspamcheck?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

Back To Top

LoadUsage

Shows usage of your account in given time.

/account/loadusage

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
from datetime Starting date for search in YYYY-MM-DDThh:mm:ss format.
to datetime Ending date for search in YYYY-MM-DDThh:mm:ss format.

Response

{"success": true, "error": null, "data": { List of Usage } }

Example

https://api.emailwiz.com/v2/account/loadusage?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01

Back To Top

ManageApiKeys

Manages your apikeys.

/account/manageapikeys

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
apiKey string APIKey you would like to manage.
action APIKeyAction Specific action you would like to perform on the APIKey

Response

{"success": true, "error": null, "data": { List of string } }

Example

https://api.emailwiz.com/v2/account/manageapikeys?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&apiKey=&action=

Back To Top

Overview

Shows summary for your account.

/account/overview

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { AccountOverview } }

Example

https://api.emailwiz.com/v2/account/overview?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

UpdateAdvancedOptions

Update sending and tracking options of your account.

/account/updateadvancedoptions

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
enableClickTracking boolean? True, if you want to track clicks. Otherwise, false
enableLinkClickTracking boolean? True, if you want to track by link tracking. Otherwise, false
skipListUnsubscribe boolean? True, if you do not want to use list-unsubscribe headers. Otherwise, false
autoTextFromHtml boolean? True, if text BODY of message should be created automatically. Otherwise, false
allowCustomHeaders boolean? True, if you want to apply custom headers to your emails. Otherwise, false
bccEmail string Email address to send a copy of all email to.
contentTransferEncoding string Type of content encoding
emailNotificationForError boolean? True, if you want bounce notifications returned. Otherwise, false
emailNotificationEmail string Specific email address to send bounce email notifications to.
webNotificationUrl string URL address to receive web notifications to parse and process.
webNotificationForSent boolean? True, if you want to send web notifications for sent email. Otherwise, false
webNotificationForOpened boolean? True, if you want to send web notifications for opened email. Otherwise, false
webNotificationForClicked boolean? True, if you want to send web notifications for clicked email. Otherwise, false
webNotificationForUnsubscribed boolean? True, if you want to send web notifications for unsubscribed email. Otherwise, false
webNotificationForAbuseReport boolean? True, if you want to send web notifications for complaint email. Otherwise, false
webNotificationForError boolean? True, if you want to send web notifications for bounced email. Otherwise, false
hubCallBackUrl string URL used for tracking action of inbound emails
inboundDomain string Domain you use as your inbound domain
inboundContactsOnly boolean? True, if you want inbound email to only process contacts from your account. Otherwise, false
notifyWeeklyStats boolean? null True, if you want to receive weekly stat email notifications. Otherwise, false
lowCreditNotification boolean? null True, if you want to receive low credit email notifications. Otherwise, false
enableUITooltips boolean? null True, if account has tooltips active. Otherwise, false
enableContactFeatures boolean? null True, if you want to use Advanced Tools. Otherwise, false

Response

{"success": true, "error": null, "data": { AdvancedOptions } }

Example

https://api.emailwiz.com/v2/account/updateadvancedoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&enableClickTracking=true&enableLinkClickTracking=true&skipListUnsubscribe=true&autoTextFromHtml=true&allowCustomHeaders=true&bccEmail=your@email.com&contentTransferEncoding=Base64&emailNotificationForError=false&emailNotificationEmail=your@emailaddress.com&webNotificationUrl=http://&webNotificationForSent=true&webNotificationForOpened=true&webNotificationForClicked=true&webNotificationForUnsubscribed=true&webNotificationForAbuseReport=true&webNotificationForError=true&hubCallBackUrl=http://&inboundDomain=yourdomain.com&inboundContactsOnly=true&notifyWeeklyStats=true&lowCreditNotification=true&enableUITooltips=true&enableContactFeatures=

Back To Top

UpdateCustomBranding

Update settings of your private branding. These settings are needed, if you want to use Elastic Email under your brand.

/account/updatecustombranding

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
enablePrivateBranding boolean false True: Turn on or off ability to send mails under your brand. Otherwise, false
logoUrl string null URL to your logo image.
supportLink string null Address to your support.
privateBrandingUrl string null Subdomain for your rebranded service
smtpAddress string null Address of SMTP server.
smtpAlternative string null Address of alternative SMTP server.
paymentUrl string null URL for making payments.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/account/updatecustombranding?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&enablePrivateBranding=true&logoUrl=http://yourdomain.com/logo.png&supportLink=http://help.yourdomain.com&privateBrandingUrl=mailing.yourdomain.com&smtpAddress=smtp.yourdomain.com&smtpAlternative=smtp2.yourdomain.com&paymentUrl=http://payments.yourdomain.com

Back To Top

UpdateHttpNotification

Update http notification URL.

/account/updatehttpnotification

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
url string URL of notification.
settings string null Http notification settings serialized to JSON

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/account/updatehttpnotification?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&url=http://address.for.notification.com&settings={ sent: true, opened: true, clicked: true, unsubscribed: true, complaints: true, error: true }

Back To Top

UpdateProfile

Update your profile.

/account/updateprofile

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
firstName string First name.
lastName string Last name.
company string Company name.
address1 string First line of address.
address2 string Second line of address.
city string City.
state string State or province.
zip string Zip/postal code.
countryID string Numeric ID of country.
deliveryReason string Why your clients are receiving your emails.
marketingConsent boolean True if you want to receive newsletters from Elastic Email. Otherwise, false.
website string null HTTP address of your website.
logoUrl string null URL to your logo image.
taxCode string null Code used for tax purposes.
phone string null Phone number

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/account/updateprofile?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&firstName=FIRSTNAME&lastName=LASTNAME&company=COMPANY&address1=ADDRESS1&address2=ADDRESS2&city=CITY&state=STATE&zip=ZIP/POSTAL&countryID=12345&deliveryReason=Reason&marketingConsent=true/false&website=http://example.com&logoUrl=http://yourdomain.com/logo.png&taxCode=&phone=1234567890

Back To Top

Attachment

Delete

Permanently deletes attachment file from your account

/attachment/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
attachmentID long ID number of your attachment.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/attachment/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&attachmentID=123456

Back To Top

Get

Gets address of chosen Attachment

/attachment/get

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
fileName string Name of your file.
attachmentID long ID number of your attachment.

Response

{"success": true, "error": null, "data": { Output stream containing file data } }

Example

https://api.emailwiz.com/v2/attachment/get?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileName=filename.txt&attachmentID=123456

Back To Top

List

Lists your available Attachments

/attachment/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
msgID string ID number of selected message.

Response

{"success": true, "error": null, "data": { List of Attachment } }

Example

https://api.emailwiz.com/v2/attachment/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&msgID=MessageID

Back To Top

Remove

Permanently removes attachment file from your account

/attachment/remove

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
fileName string Name of your file.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/attachment/remove?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileName=filename.txt

Back To Top

Upload

Uploads selected file to the server using http form upload format (MIME multipart/form-data) or PUT method.

/attachment/upload

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

File Content: POST multipart/form-data file upload or PUT file upload with content-disposition header

Response

{"success": true, "error": null, "data": { Attachment } }

Example

https://api.emailwiz.com/v2/attachment/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&attachmentFile=PUT or POST data

Back To Top

Classes

Account

Detailed information about your account

Properties

Property Description Example Type
AccountPaymentUrl URL for making payments. http://payments.yourdomain.com string
AccountType Type of account: 1 for Transactional Email, 2 for Marketing Email. 2 AccountType
Address1 First line of address. ADDRESS1 string
Address2 Second line of address. ADDRESS2 string
AffiliateLink URL for affiliating. http:// string
ApiKey ApiKey that gives you access to our SMTP and HTTP API’s. 94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3 string
ApiKey2 Second ApiKey that gives you access to our SMTP and HTTP API’s. Used mainly for changing ApiKeys without disrupting services. BE4C7ECC-5176-44B4-A843-EE704BCB1B51 string
AutoCreditAmount When AutoCreditStatus is Enabled, the amount of credit to be recharged. 500 decimal
AutoCreditLevel When AutoCreditStatus is Enabled, the credit level that triggers the credit to be recharged. 100 decimal
AutoCreditStatus Status of automatic payments configuration. neverenabled string
City City. CITY string
Company Company name. COMPANY string
ContentTransferEncoding Type of content encoding Base64 string
CountryID Numeric ID of country. 12345 int?
Credit Amount of emails sent from this account 1000 decimal
DailySendLimit Amount of emails account can send daily 100000 int
DateCreated Creation date. 2001-01-01:12:00:00 datetime
DeliveryReason Why your clients are receiving your emails. Reason string
Email Proper email address. mail@example.com string
EmailCredits Amount of email credits 1000 int
EnableContactFeatures Enable advanced tools on your Account. boolean
EnablePrivateBranding True: Turn on or off ability to send mails under your brand. Otherwise, false true boolean
FirstName First name. FIRSTNAME string
IsSub True, if account is a subaccount. Otherwise, false false boolean
LastName Last name. LASTNAME string
LinkTracking True, if you have enabled link tracking. Otherwise, false true boolean
LitmusCredits Amount of Litmus credits 1000 decimal
LogoUrl URL to your logo image. http://yourdomain.com/logo.png string
MonthlyEmailsSent Amount of emails sent from this account 1000 long?
PaymentFormUrl URL form for payments. http:// string
Phone Phone number 1234567890 string
PricePerEmail Amount of emails sent from this account 1000 decimal
PrivateBrandingUrl Subdomain for your rebranded service mailing.yourdomain.com string
PublicAccountID Public key for limited access to your account such as contact/add so you can use it safely on public websites. EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F string
Reputation Numeric reputation 100 double
Smtp Address of SMTP server. smtp.yourdomain.com string
SmtpAlternative Address of alternative SMTP server. smtp2.yourdomain.com string
State State or province. STATE string
StatusFormatted Account status: Active Active string
StatusNumber Number of status: 1 – Active 1 int
SubAccountsCount The number of subaccounts this account has. 1 long
SupportLink Address to your support. http://help.yourdomain.com string
TaxCode Code used for tax purposes. string
TotalEmailsSent Amount of emails sent from this account 1000 long
Website HTTP address of your website. http://example.com string
Zip Zip/postal code. ZIP/POSTAL string

Back To Top

AccountOverview

Basic overview of your account

Properties

Property Description Example Type
BlockedContactsCount Number of contacts currently with blocked status of Unsubscribed, Complaint, Bounced or InActive 1000 long
CampaignCount Number of created campaigns 10 long
ContactCount Number of contacts 10000 long
CostPerThousand Cost of 1000 emails 0.09 decimal
Credit Amount of emails sent from this account 1000 decimal
InProgressCount Number of messages in progress 1234 long
ReferralCount Number of active referrals 10 long
Reputation Numeric reputation 100 double
SubAccountCount Number of created subaccounts 10 long
TemplateCount Number of available templates 10 long
TotalEmailsSent Amount of emails sent from this account 1000 long

Back To Top

AccountType Enumeration

Properties

Values Value Description
Marketing 2 Account is used for sending bulk marketing email
Transactional 1 Account is used for sending transactional mail only.

Back To Top

AdvancedOptions

Lists advanced sending options of your account.

Properties

Property Description Example Type
AllowCustomHeaders True, if you want to apply custom headers to your emails. Otherwise, false true boolean
AutoTextFormat True, if text BODY of message should be created automatically. Otherwise, false true boolean
BccEmail Email address to send a copy of all email to. your@email.com string
ContentTransferEncoding Type of content encoding Base64 string
EmailNotification True, if you want to receive bounce email notifications. Otherwise, false true string
EmailNotificationForError True, if you want bounce notifications returned. Otherwise, false false boolean
EnableClickTracking True, if you want to track clicks. Otherwise, false true boolean
EnableContactFeatures True, if you want to use Advanced Tools. Otherwise, false boolean
EnableLinkClickTracking True, if you want to track by link tracking. Otherwise, false true boolean
EnableUITooltips True, if account has tooltips active. Otherwise, false true boolean
EnableUnsubscribeHeader True, if you want to enable list-unsubscribe header. Otherwise, false true boolean
HubCallbackUrl URL used for tracking action of inbound emails http:// string
InboundContactsOnly True, if you want inbound email to only process contacts from your account. Otherwise, false true boolean
InboundDomain Domain you use as your inbound domain yourdomain.com string
IsOwnedByReseller True, if this account resells Elastic Email. Otherwise, false. false boolean
IsSubAccount True, if this account is a sub-account. Otherwise, false true boolean
LowCreditNotification True, if you want to receive low credit email notifications. Otherwise, false true boolean
NotifyWeeklyStats True, if you want to receive weekly stat email notifications. Otherwise, false true boolean
WebNotificationForAbuse True, if you want to send web notifications for complaint email. Otherwise, false true boolean
WebNotificationForClicked True, if you want to send web notifications for clicked email. Otherwise, false true boolean
WebNotificationForError True, if you want to send web notifications for bounced email. Otherwise, false true boolean
WebNotificationForOpened True, if you want to send web notifications for opened email. Otherwise, false true boolean
WebNotificationForSent True, if you want to send web notifications for sent email. Otherwise, false true boolean
WebnotificationForUnsubscribed True, if you want to send web notifications for unsubscribed email. Otherwise, false true boolean
WebNotificationUrl URL address to receive web notifications to parse and process. http:// string

Back To Top

APIKeyAction Enumeration

Properties

Values Value Description
Add 1 Add an additional APIKey to your Account.
Change 2 Change this APIKey to a new one.
Delete 3 Delete this APIKey

Back To Top

Attachment

Attachment data

Properties

Property Description Example Type
FileName Name of your file. filename.txt string
ID ID number of your attachment 123456 string
Size Size of your attachment. 100 int

Back To Top

BlockedContact

Blocked Contact – Contact returning Hard Bounces

Properties

Property Description Example Type
DateUpdated Last change date 2001-01-01:12:00:00 string
Email Proper email address. mail@example.com string
FriendlyErrorMessage RFC error message Mailbox not found string
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced string

Back To Top

BouncedCategorySummary

Summary of bounced categories, based on specified date range.

Properties

Property Description Example Type
AccountProblem Number of messages flagged with ‘Account Problem’ 0 long
BlackListed Number of blacklisted messages 1000 long
CodeError Number of messages flagged with ‘Code Error’ 0 long
ConnectionProblem Number of messages flagged with ‘Connection Problem’ 0 long
ConnectionTerminated Number of messages flagged with ‘Connection terminated’ 0 long
DnsProblem Number of messages flagged with ‘DNS Problem’ 0 long
GreyListed Number of messages flagged with ‘Grey Listed’ 0 long
ManualCancel Number of manually cancelled messages 1000 long
NoMailbox Number of messages flagged with ‘No Mailbox’ 0 long
NotDelivered Number of messages flagged with ‘Not Delivered’ 0 long
Spam Number of messages marked as SPAM 1000 long
SpfProblem Number of messages flagged with ‘SPF Problem’ 0 long
Throttled Number of messages flagged with ‘Throttled’ 0 long
Timeout Number of messages flagged with ‘Timeout’ 0 long
WhitelistingProblem Number of messages flagged with ‘WhiteListing Problem’ 0 long

Back To Top

Campaign

Campaign

Properties

Property Description Example Type
CampaignTemplates List of CampaignTemplate
ChannelID ID number of selected Channel. 123456 int?
Name Filename attachment.txt string
SplitOptimization What should be checked for choosing the winner: opens or clicks 0 SplitOptimization
SplitOptimizationMinutes Number of minutes between sends during optimization period 30 int
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced CampaignStatus
Targets List of Segment and List IDs, comma separated s01,l10 Repeated list of string
TriggerChannelID ID number of transaction TransactionID int
TriggerCount Date of send 2001-01-01T12:00:00 int
TriggerData Data for filtering event campaigns such as specific link addresses. http://elasticemail.com string
TriggerDate Date of triggered send 2001-01-01T12:00:00 datetime?
TriggerDelay True, if campaign should be delayed. Otherwise, false. false double
TriggerFrequency When your next automatic mail will be sent, in days 30 double
TriggerType Number of event, triggering mail sending 1 CampaignTriggerType

Back To Top

CampaignChannel

Channel

Properties

Property Description Example Type
ChannelID ID number of selected Channel. 123456 int
ClickedCount Total emails clicked 1000 int
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime
FailedAbuse Abuses – mails sent to user without their consent 0.00 int
FailedCount Total emails sent. 1000 int
IsCampaign True, if you are sending a campaign. Otherwise, false. True boolean
LastActivity Date of last activity on account 2001-01-01T12:00:00 datetime?
LastProcessed Datetime of last action done on campaign. 2001-01-01T01:01:01 datetime?
MailerID ID number of mailer -9 int?
Name Filename attachment.txt string
OpenedCount Total emails opened. 1000 int
ParentChannelID Id number of parent channel 123456 int
RecipientCount Overall number of recipients 1000 int
SentCount Total emails sent. 1000 int
SplitOptimization What should be checked for choosing the winner: opens or clicks 0 SplitOptimization
SplitOptimizationMinutes Number of minutes between sends during optimization period 30 int
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced CampaignStatus
Targets List of Segment and List IDs, comma separated s01,l10 Repeated list of string
TemplateChannels List of CampaignTemplate for sending A-X split testing. CampaignTemplate1, CampaignTemplate2 List of CampaignChannel
TemplateFromEmail Default From: email address. sender@yourdomain.com string
TemplateFromName Default From: name. Sender string
TemplateID ID number of template. 1234 int?
TemplateReplyEmail Default Reply: email address. replyto@yourdomain.com string
TemplateReplyName Default Reply: name. Reply string
TemplateSubject Default subject of email. Hello! string
TriggerChannelID ID number of transaction TransactionID int
TriggerCount Date of send 2001-01-01T12:00:00 int
TriggerData Data for filtering event campaigns such as specific link addresses. http://elasticemail.com string
TriggerDate Date of triggered send 2001-01-01T12:00:00 datetime?
TriggerDelay True, if campaign should be delayed. Otherwise, false. false double
TriggerFrequency When your next automatic mail will be sent, in days 30 double
TriggerType Number of event, triggering mail sending 1 CampaignTriggerType
UnsubscribedCount Total emails clicked 1000 int

Back To Top

CampaignStatus Enumeration

Properties

Values Value Description
Active 0 Campaign is curently active and available.
Cancelled 5 Campaign has been cancelled during delivery.
Completed 3 Campaign has completed sending.
Deleted -1 Campaign is logically deleted and not returned by API or interface calls.
Paused 4 Campaign is currently paused and not sending.
Processing 1 Campaign is currently being processed for delivery.
Sending 2 Campaign is currently sending.

Back To Top

CampaignTemplate

Properties

Property Description Example Type
ChannelID ID number of selected Channel. 123456 int?
MailerID ID number of mailer -9 int?
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced CampaignStatus
TemplateFromEmail Default From: email address. sender@yourdomain.com string
TemplateFromName Default From: name. Sender string
TemplateID ID number of template. 1234 int?
TemplateReplyEmail Default Reply: email address. replyto@yourdomain.com string
TemplateReplyName Default Reply: name. Reply string
TemplateSubject Default subject of email. Hello! string

Back To Top

CampaignTriggerType Enumeration

Properties

Values Value Description
FutureScheduled 2
OnAdd 3
OnClick 5
OnOpen 4
SendNow 1

Back To Top

Channel

SMTP and HTTP API channel for grouping email delivery

Properties

Property Description Example Type
ClickedCount The number of emails that have been clicked within this channel. int
Cost The total cost for emails/attachments within this channel. decimal
DateAdded The date the channel was added to your account. datetime
FailedAbuse The number of emails that have been marked as abuse or complaint within this channel. int
FailedCount The number of emails that have been bounced within this channel. int
JobCount The number of email jobs this channel has been used with. int
LastActivity The date the channel was last sent through. datetime?
Name Descriptive name of the channel. string
OpenedCount The number of emails that have been opened within this channel. int
RecipientCount The number of emails attempted to be sent within this channel. int
SentCount The number of emails that have been sent within this channel. int
UnsubscribedCount The number of emails that have been unsubscribed within this channel. int

Back To Top

CompressionFormat Enumeration

FileResponse compression format

Properties

Values Value Description
None 0 No compression
Zip 1 Zip compression

Back To Top

Contact

Contact

Properties

Property Description Example Type
AnnualRevenue Annual revenue of contact 75000 decimal?
BirthDate Date of birth in YYYY-MM-DD format 2001-01-01 datetime?
BouncedErrorCode RFC Error code 550 int?
BouncedErrorMessage RFC error message Mailbox not found string
City City. CITY string
Country Name of country. Canada string
CreatedFromIP IP address 192.168.0.1 string
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime
DateUpdated Last change date 2001-01-01:12:00:00 datetime
Email Proper email address. mail@example.com string
ErrorCode RFC Error code 550 int?
FaxNumber Fax number 1234567890 string
FirstFailedDate Date of first failed message 2001-01-01:12:00:00 datetime?
FirstName First name. FIRSTNAME string
FirstPurchase Date of first purchase in YYYY-MM-DD format 2014-01-01 datetime?
FriendlyErrorMessage RFC error message Mailbox not found string
Gender Your gender F/M string
GravatarHash Your gravatar hash for image b642b4217b34b1e8d3bd915fc65c4452 string
Industry Industry contact works in Finance string
LastClicked datetime?
LastFailedCount Number of fails in sending to this Contact 1 int
LastMonthSent Number of messages sent last month 10 int?
LastName Last name. LASTNAME string
LastOpened Date this contact last opened an email 2014-01-01 datetime?
LastPurchase Date of last purchase in YYYY-MM-DD format 2015-01-01 datetime?
LinkedInBio Biography for Linked-In Short biography for Link-In Profile string
LinkedInConnections Number of Linked-In connections 50 int
MobileNumber Mobile phone number 1234567890 string
Notes Free form field of notes Contact is extremely important! string
NumberOfEmployees Number of employees 100 int
OrganizationName Name of organization ABC Inc. string
PageViews Number of page views 50 int
Phone Phone number 1234567890 string
PurchaseCount Number of purchases contact has made 2 int
Revenue Yearly revenue for the contact 100000 decimal
Source Source of URL of payment http:// ContactSource
State State or province. STATE string
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced ContactStatus
Title Title Mrs./Mr. string
TotalClicked Total emails clicked 1000 int
TotalFailed Total emails sent. 1000 int
TotalOpened Total emails opened. 1000 int
TotalSent Total emails sent. 1000 int
TwitterBio Biography for Twitter Short biography for Twitter Profile string
TwitterFollowerCount Number of Twitter followers 50 int
TwitterProfilePhoto URL for Twitter photo http:// string
TwitterUsername User name for Twitter @elastic_email string
UnsubscribedDate Unsubscribed date in YYYY-MM-DD format 2001-01-01 datetime?
Visits Number of website visits 100 int
WebsiteUrl Website of contact http:// string
Zip Zip/postal code. ZIP/POSTAL string

Back To Top

ContactHistory

History of chosen Contact

Properties

Property Description Example Type
ChannelName Name of selected channel. Channel01 string
ContactHistoryID ID of history of selected Contact. 123456 int
EventDate Formatted date of event. 1/1/2015 0:00:00 AM string
EventType Type of event occured on this Contact. Sent string
EventTypeValue Numeric code of event occured on this Contact. 1 int
TemplateName Name of template. Template01 string

Back To Top

ContactSource Enumeration

Properties

Values Value Description
APICall 4 Contact was added from an API call.
ListUpload 2 Contact was uploaded from the website interface.
ManualInput 1 Contact was inputted from the website interface.
Unknown 0 Source of the contact is not known.
WebForm 3 Contact was added from a public web form.

Back To Top

ContactStatus Enumeration

Properties

Values Value Description
Abuse 3 Abuses – mails sent to user without their consent
Active 0 Number of active contacts
Bounced 1 Number of bounced messages
Engaged -1 Number of engaged contacts
Inactive 4 Number of inactive contacts
Unsubscribed 2 Number of unsubscribed messages

Back To Top

ContactStatusCounts

Number of Contacts, grouped by Status;

Properties

Property Description Example Type
Active Number of active contacts 1000 long
Bounced Number of bounced messages 1000 long
Complaint Number of complaint messages 1000 long
Engaged Number of engaged contacts 1000 long
Inactive Number of inactive contacts 1000 long
Unsubscribed Number of unsubscribed messages 1000 long

Back To Top

DailyLogStatusSummary

Daily summary of log status, based on specified date range.

Properties

Property Description Example Type
Bounced Number of bounced messages 1000 string
Clicked Number of clicked messages 1000 string
Complaint Number of complaint messages 1000 string
Date Date in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 string
Delivered Number of delivered messages 1000 string
Email Proper email address. mail@example.com string
Inbound Number of inbound messages 1000 string
ManualCancel Number of manually cancelled messages 1000 string
Opened Number of opened messages 1000 string
Sms Number of SMS 12 string
Unsubscribed Number of unsubscribed messages 1000 string

Back To Top

DomainDetail

Domain data, with information about domain records.

Properties

Property Description Example Type
DefaultDomain True, if domain is used as default. Otherwise, false, boolean
Dkim True, if DKIM record is verified True boolean
Domain Name of selected domain. example.com string
IsRewriteDomainValid True, if tracking CNAME record is verified True boolean
MX True, if MX record is verified True boolean
Spf True, if SPF record is verified True boolean
Verify True, if verification is available True boolean

Back To Top

EmailCredits

Detailed information about email credits

Properties

Property Description Example Type
Amount Amount of money in transaction 100 decimal
Date Date in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime
Notes Free form field of notes Contact is extremely important! string
Source Source of URL of payment http:// string

Back To Top

EmailJobFailedStatus

Properties

Property Description Example Type
Address string
Category string
Error string
ErrorCode RFC Error code 550 int

Back To Top

EmailJobStatus

Properties

Property Description Example Type
AbuseReports List of string
AbuseReportsCount int
Clicked Number of clicked messages 1000 List of string
ClickedCount Total emails clicked 1000 int
Delivered Number of delivered messages 1000 List of string
DeliveredCount int
Failed List of EmailJobFailedStatus
FailedCount Total emails sent. 1000 int
ID ID number of your attachment 123456 string
Opened Number of opened messages 1000 List of string
OpenedCount Total emails opened. 1000 int
Pending List of string
PendingCount int
RecipientsCount int
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced string
Unsubscribed Number of unsubscribed messages 1000 List of string
UnsubscribedCount Total emails clicked 1000 int

Back To Top

EmailSend

Properties

Property Description Example Type
TransactionID ID number of transaction TransactionID string

Back To Top

EmailView

Email details formatted in json

Properties

Property Description Example Type
Body Body (text) of your message. Hello string
From Starting date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 string
Subject Default subject of email. Hello! string

Back To Top

EncodingType Enumeration

Encoding type for the email headers

Properties

Values Value Description
Base64 4 Encoding of the email is in Base64 format.
None 0 No endcoding is set for the email.
QuotedPrintable 3 Encoding of the email is in QuotedPrintable format.
Raw7bit 1 Encoding of the email is in Raw7bit format.
Raw8bit 2 Encoding of the email is in Raw8bit format.
UserProvided -1 Encoding of th eemail is provided by the sender and not altered.
Uue 5 Encoding of the email is in Uue format.

Back To Top

Export

Record of exported data from the system.

Properties

Property Description Example Type
DateAdded Date the export was created datetime
Filename Name of the file string
Info Long description of the export string
Link Link to download the export string
PublicExportID GUID
Status Current status of export string
Type Type of export string

Back To Top

ExportFileFormats Enumeration

Type of export

Properties

Values Value Description
Csv 1 Export in comma separated values format.
Json 3 Export in json format
Xml 2 Export in xml format

Back To Top

ExportStatus Enumeration

Current status of export

Properties

Values Value Description
Error -1 Export had an error and can not be downloaded.
Expired 2 Export is no longer available for downloading.
Loading 0 Export is currently loading and can not be downloaded.
Ready 1 Export is currently available for downloading.

Back To Top

ExportTypeCounts

Number of Exports, grouped by export type

Properties

Property Description Example Type
Campaign Json representation of a campaign long
Contact long
LinkTracking True, if you have enabled link tracking. Otherwise, false true long
Log long
Survey long

Back To Top

LinkTrackingDetails

Object containig tracking data.

Properties

Property Description Example Type
Count Number of items. 100 int
MoreAvailable True, if there are more detailed data available. Otherwise, false true boolean
TrackedLink List of TrackedLink

Back To Top

List

List of Contacts, with detailed data about its contents.

Properties

Property Description Example Type
AllowUnsubscribe True: Allow unsubscribing from this list. Otherwise, false true/false boolean
Count Number of items. 100 int
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime
ListID ID number of selected list. 1234 int
ListName Name of your list. My List 1 string
PublicListID ID code of list public-id-of-your-list GUID?

Back To Top

LitmusCredits

Detailed information about litmus credits

Properties

Property Description Example Type
Amount Amount of money in transaction 100 decimal
Date Date in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime

Back To Top

Log

Logs for selected date range

Properties

Property Description Example Type
From Starting date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 datetime?
Recipients Number of recipients 1234 List of Recipient
To Ending date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 datetime?

Back To Top

LogStatusSummary

Summary of log status, based on specified date range.

Properties

Property Description Example Type
Bounced Number of bounced messages 1000 long
Clicked Number of clicked messages 1000 long
Complaints Number of complaint messages 1000 long
Delivered Number of delivered messages 1000 long
Duration Overall duration double
EmailTotal Number of emails 1234 long
From Starting date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 string
Inbound Number of inbound messages 1000 long
InProgress Number of messages in progress 1234 long
ManualCancel Number of manually cancelled messages 1000 long
Opened Number of opened messages 1000 long
Recipients Number of recipients 1234 long
SmsTotal Number of SMS 12 long
TemplateChannel ID number of template used 1234 boolean
To Ending date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 string
Unsubscribed Number of unsubscribed messages 1000 long

Back To Top

LogSummary

Overall log summary information.

Properties

Property Description Example Type
BouncedCategorySummary Summary of bounced categories, based on specified date range. BouncedCategorySummary
DailyLogStatusSummary Daily summary of log status, based on specified date range. List of DailyLogStatusSummary
LogStatusSummary Summary of log status, based on specified date range. LogStatusSummary

Back To Top

NotificationQueue

Queue of notifications

Properties

Property Description Example Type
DateCreated Creation date. 2001-01-01:12:00:00 string
ErrorMessage Error message. Bounced string
NewStatus Actual status. Active string
Reference string
RetryCount Number of previous delivery attempts 2 string
StatusChangeDate Date of last status change. 2001-01-01:12:00:00 string

Back To Top

Recipient

Detailed information about message recipient

Properties

Property Description Example Type
Channel Name of selected Channel. Channel01 string
Date Date in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 string
FromEmail Default From: email address. sender@yourdomain.com string
IsSms True, if message is SMS. Otherwise, false True boolean
JobID ID of certain mail job string
Message Content of message, HTML encoded Lorem ipsum string
MessageCategory ID of message category 1 string
MessageSid Comma separated ID numbers of messages. 12345678,1234567890 string
MsgID ID number of selected message. MessageID string
NextTryOn Date of next try 2001-01-01T12:00:00 string
ShowCategory True, if message category should be shown. Otherwise, false true boolean
SmsUpdateRequired True, if message is a SMS and status is not yet confirmed. Otherwise, false false boolean
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. Bounced string
StatusChangeDate Date of last status change. 2001-01-01:12:00:00 string
Subject Default subject of email. Hello! string
TextMessage Content of message Lorem ipsum string
To Ending date for search in YYYY-MM-DDThh:mm:ss format. 2001-01-01T01:01:01 string

Back To Top

ReputationDetail

Detailed sending reputation of your account.

Properties

Property Description Example Type
AbusePercent Percent of Complaining users – those, who do not want to receive email from you. 0.00 double
AverageReputation Average reputation. 50 double
AverageSpamScore Penalty from messages marked as spam. 0 double
FailedSpamPercent Percent of Bounced users 0.00 double
Impact Overall reputation impact, based on the most important factors. ReputationImpact
NextPriceLevelReputation Reputation needed to change pricing. 70 double
PriceLevel Amount of emails sent from this account 1000 string
PriceLevelReputation Actual price level. 50 double
RepEmailsSent Points from quantity of your emails. 0 double
SenderDomainValid True, if sending domain is correctly configured. Otherwise, false. true boolean
TrackingDomainValid True, if tracking domain is correctly configured. Otherwise, false. true boolean
UnknownUsersPercent Percent of Unknown users – users that couldn’t be found 0.00 double

Back To Top

ReputationHistory

Reputation history of your account.

Properties

Property Description Example Type
AbusePercent Percent of Complaining users – those, who do not want to receive email from you. 0.00 double
AverageSpamScore Penalty from messages marked as spam. 0 double
DateCreated Creation date. 2001-01-01:12:00:00 string
RepEmailsSent Points from quantity of your emails. 0 double
Reputation Numeric reputation 100 double
SetupScore Points from proper setup of your account 0 double
UnknownUsersPercent Percent of Unknown users – users that couldn’t be found 0.00 double

Back To Top

ReputationImpact

Overall reputation impact, based on the most important factors.

Properties

Property Description Example Type
Abuse Abuses – mails sent to user without their consent 0.00 double
AverageSpamScore Penalty from messages marked as spam. 0 double
SenderDomain Sending domain. example.com double
ServerFilter Content analysis. 0.00 double
TotalEmailSent Total emails sent. 1000 double
TrackingDomain Tracking domain. example.com double
UnknownUsers Users, that could not be reached. 0.00 double

Back To Top

Segment

Information about Contact Segment, selected by RULE.

Properties

Property Description Example Type
AccountID ID of selected account. 1234567 int
History History of segment information. List of SegmentHistory
LastCount Number of items from last check. 100 long
Name Filename attachment.txt string
Rule Query used for filtering. Status%20=%20Engaged string
SegmentID ID number of your segment. 1234 int

Back To Top

SegmentHistory

Segment History

Properties

Property Description Example Type
AccountID ID of selected account. 1234567 int
Count Number of items. 100 long
Day Date in YYYY-MM-DD format 2001-01-01 int
SegmentHistoryID ID number of history. 1234567 int
SegmentID ID number of your segment. 1234 int

Back To Top

SendingPermission Enumeration

Properties

Values Value Description
All 255 Sending allowed via SMTP, HTTP API and the website interface.
HttpApi 2 Allow sending via HTTP API only.
HttpApiAndInterface 6 Allow sendnig via HTTP API and the website interface.
Interface 4 Allow sending via the website interface only.
None 0 Sending not allowed.
Smtp 1 Allow sending via SMTP only.
SmtpAndHttpApi 3 Allow sending via SMTP and HTTP API.
SmtpAndInterface 5 Allow sending via SMTP and the website interface.

Back To Top

SpamCheck

Spam check of specified message.

Properties

Property Description Example Type
ChannelName Name of selected channel. Channel01 string
Date Date in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 string
FromEmail Default From: email address. sender@yourdomain.com string
MsgID ID number of selected message. MessageID string
Rules List of SpamRule
Subject Default subject of email. Hello! string
TotalScore Total spam score from 5.5 string

Back To Top

SpamRule

Single spam score

Properties

Property Description Example Type
Description Description of rule. Very long subject, possibly filled up with random string
Key Name of rule JAM_LONG_SUBJECT string
Score Spam score 2.5 string

Back To Top

SplitOptimization Enumeration

Properties

Values Value Description
Clicked 1 Number of clicked messages
Opened 0 Number of opened messages

Back To Top

Template

Template

Properties

Property Description Example Type
BodyHtml HTML code of email (needs escaping). <BODY><H1>Hello!</H1></BODY> string
BodyText Text body of email. Hello%20World string
Css CSS style body:{color:black;} string
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format 2001-01-01T12:00:00 datetime
FromEmail Default From: email address. sender@yourdomain.com string
FromName Default From: name. Sender string
Name Filename attachment.txt string
OriginalTemplateID ID number of original template. 123 int
Subject Default subject of email. Hello! string
TemplateID ID number of template. 1234 int
TemplateScope Enum: 0 – private, 1 – public, 2 – mockup 1 TemplateScope
TemplateType 0 for API connections 0 TemplateType

Back To Top

TemplateList

List of templates

Properties

Property Description Example Type

Back To Top

TemplateScope Enumeration

Properties

Values Value Description
Private 0 Template is available for this account only.
Public 1 Template is available for this account and it’s sub-accounts.

Back To Top

TemplateType Enumeration

Properties

Values Value Description
DragDropEditor 1 Template is created and can only be modified in drag and drop editor
RawHTML 0 Template supports any valid HTML

Back To Top

TrackedLink

Information about tracking link and its clicks.

Properties

Property Description Example Type
Clicks Number of clicks 10 string
Link URL clicked http:// string
Percent Percent of clicks 10% string

Back To Top

Usage

Account usage

Properties

Property Description Example Type

Back To Top

Campaign

Add

Adds a campaign to the queue for processing based on the configuration

/campaign/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
campaign Campaign Json representation of a campaign

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/v2/campaign/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaign=

Back To Top

Copy

Copy selected campaign

/campaign/copy

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelID int ID number of selected Channel.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/campaign/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456

Back To Top

Delete

Delete selected campaign

/campaign/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelID int ID number of selected Channel.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/campaign/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456

Back To Top

Export

Export selected campaigns to chosen file format.

/campaign/export

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
campaignNames List of string
fileFormat ExportFileFormats ApiTypes.ExportFileFormats.Csv
compressionFormat CompressionFormat ApiTypes.CompressionFormat.None FileResponse compression format. None or Zip.
fileName string null Name of your file.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/campaign/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaignNames=&fileFormat=&compressionFormat=Zip&fileName=filename.txt

Back To Top

List

List all of your campaigns

/campaign/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
search string null Text fragment used for searching.
offset int 0 How many items should be loaded ahead.
limit int 0 Maximum of loaded items.

Response

{"success": true, "error": null, "data": { List of CampaignChannel } }

Example

https://api.emailwiz.com/v2/campaign/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&search=text&offset=20&limit=100

Back To Top

Update

Updates a previously added campaign. Only Active and Paused campaigns can be updated.

/campaign/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
campaign Campaign Json representation of a campaign

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/v2/campaign/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaign=

Back To Top

Channel

Add

Manually add a channel to your account to group email

/channel/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
name string Descriptive name of the channel

Response

{"success": true, "error": null, "data": { string } }

Example

https://api.emailwiz.com/v2/channel/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=

Back To Top

Delete

Delete the channel.

/channel/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
name string The name of the channel to delete.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/channel/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=

Back To Top

ExportCsv

Export channels in CSV file format.

/channel/exportcsv

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelNames List of string
compressionFormat CompressionFormat ApiTypes.CompressionFormat.None FileResponse compression format. None or Zip.
fileName string null Name of your file.

Response

{"success": true, "error": null, "data": { Output stream containing CSV file data } }

Example

https://api.emailwiz.com/v2/channel/exportcsv?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt

Back To Top

ExportJson

Export channels in JSON file format.

/channel/exportjson

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelNames List of string
compressionFormat CompressionFormat ApiTypes.CompressionFormat.None FileResponse compression format. None or Zip.
fileName string null Name of your file.

Response

{"success": true, "error": null, "data": { Output stream containing JSON file data } }

Example

https://api.emailwiz.com/v2/channel/exportjson?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt

Back To Top

ExportXml

Export channels in XML file format.

/channel/exportxml

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelNames List of string
compressionFormat CompressionFormat ApiTypes.CompressionFormat.None FileResponse compression format. None or Zip.
fileName string null Name of your file.

Response

{"success": true, "error": null, "data": { Output stream containing XML file data } }

Example

https://api.emailwiz.com/v2/channel/exportxml?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt

Back To Top

List

List all of your channels

/channel/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of Channel } }

Example

https://api.emailwiz.com/v2/channel/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

Update

Rename an existing channel.

/channel/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
name string The name of the channel to update.
newName string The new name for the channel.

Response

{"success": true, "error": null, "data": { string } }

Example

https://api.emailwiz.com/v2/channel/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=&newName=

Back To Top

Contact

ActivateBlocked

Activate contacts that are currently blocked.

/contact/activateblocked

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
activateAllBlocked boolean false Activate all your blocked contacts. Passing True will override email list and activate all your blocked contacts.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/activateblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&activateAllBlocked=&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

Add

Add a new contact and optionally to one of your lists. Note that your API KEY is not required for this call.

/contact/add

Parameters

Name Type Default Description
publicAccountID string Public key for limited access to your account such as contact/add so you can use it safely on public websites.
email string Proper email address.
publicListID Repeated list of string null ID code of list
listName Repeated list of string null Name of your list.
title string null Title
firstName string null First name.
lastName string null Last name.
phone string null Phone number
mobileNumber string null Mobile phone number
notes string null Free form field of notes
gender string null Your gender
birthDate datetime? null Date of birth in YYYY-MM-DD format
city string null City.
state string null State or province.
postalCode string null Zip/postal code.
country string null Name of country.
organizationName string null Name of organization
website string null HTTP address of your website.
annualRevenue int? 0 Annual revenue of contact
industry string null Industry contact works in
numberOfEmployees int? 0 Number of employees
type ContactSource ApiTypes.ContactSource.Unknown
return_Url string null URL to navigate to after account creation
source_Url string null The url for activation for private branding.
activation_Return_Url string null The url to return the contact to after activation.
activation_Template string null The custom template for double optin-in activation. Requires {url} merge tag.
requiresActivation boolean true True, if you want to send an activation notice to double opt-in the contact. Otherwise, false

Response

{"success": true, "error": null, "data": { Html string } }

Example

https://api.emailwiz.com/v2/contact/add?publicAccountID=EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F&email=mail@example.com&publicListID=public-id-of-your-list&listName=My List 1&title=Mrs./Mr.&firstName=FIRSTNAME&lastName=LASTNAME&phone=1234567890&mobileNumber=1234567890&notes=Contact is extremely important!&gender=F/M&birthDate=2001-01-01&city=CITY&state=STATE&postalCode=ZIP/POSTAL&country=Canada&organizationName=ABC Inc.&website=http://example.com&annualRevenue=75000&industry=Finance&numberOfEmployees=100&type=&return_Url=http://yourdomain.com&source_Url=http://cname&activation_Return_Url=http://yourwebsite.com/thankyou&activation_Template=Sent&requiresActivation=true

Back To Top

AddBlocked

Manually add or update a contacts status to Abuse, Bounced or Unsubscribed status (blocked).

/contact/addblocked

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
email string Proper email address.
status ContactStatus Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/addblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&status=Bounced

Back To Top

ChangeProperty

Change any property on the contact record.

/contact/changeproperty

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
email string Proper email address.
name string Name of the contact property you want to change.
value string Value you would like to change the contact property to.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/changeproperty?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&name=&value=

Back To Top

ChangeStatus

Changes status of selected Contacts. You may provide RULE for selection or specify list of Contact IDs.

/contact/changestatus

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
status ContactStatus Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/changestatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&status=Bounced&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

CountByStatus

Returns number of Contacts, RULE specifies contact Status.

/contact/countbystatus

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
rule string null Query used for filtering.

Response

{"success": true, "error": null, "data": { ContactStatusCounts } }

Example

https://api.emailwiz.com/v2/contact/countbystatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged

Back To Top

Delete

Permanantly deletes the contacts provided. You can provide either a qualified rule or a list of emails (comma separated string).

/contact/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

Export

Export selected Contacts to JSON.

/contact/export

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
fileFormat ExportFileFormats ApiTypes.ExportFileFormats.Csv
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails
compressionFormat CompressionFormat ApiTypes.CompressionFormat.None FileResponse compression format. None or Zip.
fileName string null Name of your file.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileFormat=&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&compressionFormat=Zip&fileName=filename.txt

Back To Top

List

List of all contacts. If you have not specified RULE, all Contacts will be listed.

/contact/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
rule string null Query used for filtering.
limit int 20 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { List of Contact } }

Example

https://api.emailwiz.com/v2/contact/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged&limit=100&offset=20

Back To Top

LoadBlocked

Load blocked contacts

/contact/loadblocked

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
search string Text fragment used for searching.
status ContactStatus? null Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.
limit int 0 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { List of BlockedContact } }

Example

https://api.emailwiz.com/v2/contact/loadblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&search=text&status=Bounced&limit=100&offset=20

Back To Top

LoadContact

Load detailed contact information

/contact/loadcontact

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
email string Proper email address.

Response

{"success": true, "error": null, "data": { Contact } }

Example

https://api.emailwiz.com/v2/contact/loadcontact?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com

Back To Top

LoadHistory

Shows detailed history of chosen Contact.

/contact/loadhistory

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
email string Proper email address.

Response

{"success": true, "error": null, "data": { List of ContactHistory } }

Example

https://api.emailwiz.com/v2/contact/loadhistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com

Back To Top

QuickAdd

Add new Contact to one of your Lists.

/contact/quickadd

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
emails List of string Comma delimited list of contact emails
firstName string null First name.
lastName string null Last name.
title string null Title
organization string null Name of organization
city string null City.
country string null Name of country.
state string null State or province.
zip string null Zip/postal code.
listID int 0 ID number of selected list.
status ContactStatus ApiTypes.ContactStatus.Active Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/contact/quickadd?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&firstName=FIRSTNAME&lastName=LASTNAME&title=Mrs./Mr.&organization=ABC Inc.&city=CITY&country=Canada&state=STATE&zip=ZIP/POSTAL&listID=1234&status=Bounced

Back To Top

Update

Update selected contact

/contact/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
email string Proper email address.
newEmail string null New email address.
firstName string null First name.
lastName string null Last name.
company string null Company name.
title string null Title
city string null City.
state string null State or province.
country string null Name of country.
zip string null Zip/postal code.
birthDate string null Date of birth in YYYY-MM-DD format
gender string null Your gender
phone string null Phone number
activate string null True, if Contact should be activated. Otherwise, false
industry string null Industry contact works in
numberOfEmployees int 0 Number of employees
annualRevenue string null Annual revenue of contact
purchaseCount int 0 Number of purchases contact has made
firstPurchase string null Date of first purchase in YYYY-MM-DD format
lastPurchase string null Date of last purchase in YYYY-MM-DD format
notes string null Free form field of notes
websiteUrl string null Website of contact
mobileNumber string null Mobile phone number
faxNumber string null Fax number
linkedInBio string null Biography for Linked-In
linkedInConnections int 0 Number of Linked-In connections
twitterBio string null Biography for Twitter
twitterUsername string null User name for Twitter
twitterProfilePhoto string null URL for Twitter photo
twitterFollowerCount int 0 Number of Twitter followers
pageViews int 0 Number of page views
visits int 0 Number of website visits

Response

{"success": true, "error": null, "data": { Contact } }

Example

https://api.emailwiz.com/v2/contact/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&newEmail=newmail@example.com&firstName=FIRSTNAME&lastName=LASTNAME&company=COMPANY&title=Mrs./Mr.&city=CITY&state=STATE&country=Canada&zip=ZIP/POSTAL&birthDate=2001-01-01&gender=F/M&phone=1234567890&activate=false&industry=Finance&numberOfEmployees=100&annualRevenue=75000&purchaseCount=2&firstPurchase=2014-01-01&lastPurchase=2015-01-01&notes=Contact is extremely important!&websiteUrl=http://&mobileNumber=1234567890&faxNumber=1234567890&linkedInBio=Short biography for Link-In Profile&linkedInConnections=50&twitterBio=Short biography for Twitter Profile&twitterUsername=@elastic_email&twitterProfilePhoto=http://&twitterFollowerCount=50&pageViews=50&visits=100

Back To Top

Upload

Upload contacts in CSV file.

/contact/upload

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listID int ID number of selected list.
status ContactStatus ApiTypes.ContactStatus.Active Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

File Content: POST multipart/form-data file upload or PUT file upload with content-disposition header

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/v2/contact/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listID=1234&contactFile=contacts.csv&status=Bounced

Back To Top

Domain

Add

Add new domain to account

/domain/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

Delete

Deletes configured domain from account

/domain/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

List

Lists all domains configured for this account.

/domain/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of DomainDetail } }

Example

https://api.emailwiz.com/v2/domain/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

SetDefault

Verification of email addres set for domain.

/domain/setdefault

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Default email sender, example: mail@yourdomain.com

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/setdefault?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=

Back To Top

VerifyDkim

Verification of DKIM record for domain

/domain/verifydkim

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/verifydkim?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

VerifyMX

Verification of MX record for domain

/domain/verifymx

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/verifymx?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

VerifySpf

Verification of SPF record for domain

/domain/verifyspf

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/verifyspf?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

VerifyTracking

Verification of tracking CNAME record for domain

/domain/verifytracking

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
domain string Name of selected domain.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/domain/verifytracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

Back To Top

Email

GetStatus

Get email batch status

/email/getstatus

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
transactionID string Transaction identifier
showFailed boolean false Include Bounced email addresses.
showDelivered boolean false Include Sent email addresses.
showPending boolean false Include Ready to send email addresses.
showOpened boolean false Include Opened email addresses.
showClicked boolean false Include Clicked email addresses.
showAbuse boolean false Include Reported as abuse email addresses.
showUnsubscribed boolean false Include Unsubscribed email addresses.
showErrors boolean false Include error messages for bounced emails.

Response

{"success": true, "error": null, "data": { EmailJobStatus } }

Example

https://api.emailwiz.com/v2/email/getstatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&transactionID=&showFailed=&showDelivered=&showPending=&showOpened=&showClicked=&showAbuse=&showUnsubscribed=&showErrors=

Back To Top

Send

Submit emails

/email/send

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
subject string null Email subject
from string null From email address
from_name string null Display name for from email address
sender string null Email address of the sender
sender_name string null Display name sender
msg_from string null Optional parameter. Sets FROM MIME header.
msg_from_name string null Optional parameter. Sets FROM name of MIME header.
reply_to string null Email address to reply to
reply_to_email string null Display name of the reply to address
to List of string null List of email recipients (each email is treated separately, like a BCC). Separated by comma or semicolon.
msg_to Repeated list of string null Optional parameter. List of email recipients (visible to all other recipients of the message as TO MIME header). Separated by comma or semicolon.
msg_cc Repeated list of string null Optional parameter. List of email recipients (visible to all other recipients of the message as CC MIME header). Separated by comma or semicolon.
msg_bcc Repeated list of string null Optional parameter. List of email recipients (each email is treated seperately). Separated by comma or semicolon.
lists List of string null The name of a contact list you would like to send to. Separate multiple contact lists by commas or semicolons.
segments List of string null The name of a segment you would like to send to. Separate multiple segments by comma or semicolon.
mergesourcefilename string null File name one of attachments which is a CSV list of Recipients.
channel string null An ID field (max 60 chars) that can be used for reporting [will default to HTTP API or SMTP API]
body_html string null Html email body
body_text string null Text email body
charset string null Text value of encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more…
encodingtype EncodingType ApiTypes.EncodingType.None 0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as “Raw7Bit” for value 1. NOTE: Base64 or QuotedPrintable is recommended if you are validating your domain(s) with DKIM.
template string null The name of an email template you have created in your account.
attachmentfiles List of POST form-data file null Attachment files. Should also includes merge CSV file
headers Repeated list of string prefixed by parameter name null Optional Custom Headers. Request parameters prefixed by headers_ like headers_customheader1, headers_customheader2. Note: a space is required after the colon before the custom header value. headers_customheader1=customheader1: header-value1 headers_customheader2 = customheader2: header-value2
postback string null Optional header returned in notifications.
merge Repeated list of string prefixed by parameter name null Request parameters prefixed by merge_ like merge_firstname, merge_lastname. If sending to a template you can send merge_ fields to merge data with the template. Template fields are entered with {firstname}, {lastname} etc.
time_offset_minutes string null Number of minutes in the future this email should be sent

Response

{"success": true, "error": null, "data": { EmailSend } }

Example

https://api.emailwiz.com/v2/email/send?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&subject=&from=&from_name=&sender=&sender_name=&msg_from=&msg_from_name=&reply_to=&reply_to_email=&to=&msg_to=&msg_cc=&msg_bcc=&lists=&segments=&mergesourcefilename=&channel=&body_html=&body_text=&charset=&encodingtype=&template=&attachmentfiles=&headers=&postback=&merge=&time_offset_minutes=

Back To Top

View

View email

/email/view

Parameters

Name Type Default Description
msgID string Message identifier

Response

{"success": true, "error": null, "data": { EmailView } }

Example

https://api.emailwiz.com/v2/email/view?msgID=

Back To Top

Export

CheckStatus

Check the current status of the export.

/export/checkstatus

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
publicExportID GUID

Response

{"success": true, "error": null, "data": { ExportStatus } }

Example

https://api.emailwiz.com/v2/export/checkstatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicExportID=

Back To Top

CountByType

Summary of export type counts.

/export/countbytype

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { ExportTypeCounts } }

Example

https://api.emailwiz.com/v2/export/countbytype?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

Delete

Delete the specified export.

/export/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
publicExportID GUID

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/export/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicExportID=

Back To Top

List

Returns a list of all exported data.

/export/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
limit int 0 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { List of Export } }

Example

https://api.emailwiz.com/v2/export/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

Back To Top

List

Add

Create new list, based on filtering rule or list of IDs

/list/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
addAllContacts boolean false True: Add every Contact to this list. Otherwise, false
allowUnsubscribe boolean false True: Allow unsubscribing from this list. Otherwise, false
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/v2/list/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&addAllContacts=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

AddContacts

Add Contacts to chosen list

/list/addcontacts

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/list/addcontacts?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

CreateNthSelectionLists

Create a series of nth selection lists from an existing list or segment

/list/createnthselectionlists

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
numberOfLists int The number of evenly distributed lists to create.
excludeBlocked boolean true True if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
allowUnsubscribe boolean false True: Allow unsubscribing from this list. Otherwise, false
rule string null Query used for filtering.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/list/createnthselectionlists?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&numberOfLists=3&excludeBlocked=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged

Back To Top

CreateRandomList

Create a new list with randomized contacts from an existing list or segment

/list/createrandomlist

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
count int Number of items.
excludeBlocked boolean true True if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
allowUnsubscribe boolean false True: Allow unsubscribing from this list. Otherwise, false
rule string null Query used for filtering.

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/v2/list/createrandomlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&count=100&excludeBlocked=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged

Back To Top

Delete

Deletes List and removes all the Contacts from it (does not delete Contacts).

/list/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/list/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1

Back To Top

list

Shows all your existing lists

/list/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.

Response

{"success": true, "error": null, "data": { List of List } }

Example

https://api.emailwiz.com/v2/list/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Back To Top

Load

Returns detailed information about specific list.

/list/load

Parameters

Name Type Default Description
accountid int ID of selected account.
listName string Name of your list.

Response

{"success": true, "error": null, "data": { List } }

Example

https://api.emailwiz.com/v2/list/load?accountid=1234567&listName=My List 1

Back To Top

RemoveContacts

Remove selected Contacts from your list

/list/removecontacts

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
rule string null Query used for filtering.
emails List of string null Comma delimited list of contact emails

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/list/removecontacts?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Back To Top

Update

Update existing list

/list/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
listName string Name of your list.
newListName string Name of your list if you want to change it.
allowUnsubscribe boolean True: Allow unsubscribing from this list. Otherwise, false

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/list/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&newListName=My List 2&allowUnsubscribe=true/false

Back To Top

Log

CancelInProgress

Cancels emails that are waiting to be sent.

/log/cancelinprogress

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelID int? null ID number of selected Channel.
transactionID string null ID number of transaction

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/log/cancelinprogress?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456&transactionID=TransactionID

Back To Top

LinkTracking

Track link clicks

/log/linktracking

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
channelID int ID number of selected Channel.
from datetime? Starting date for search in YYYY-MM-DDThh:mm:ss format.
to datetime? Ending date for search in YYYY-MM-DDThh:mm:ss format.
limit int 0 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { LinkTrackingDetails } }

Example

https://api.emailwiz.com/v2/log/linktracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&limit=100&offset=20

Back To Top

Load

Returns logs filtered by specified parameters.

/log/load

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
statuses string List of comma separated message statuses: 0 or all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report
from datetime? null Starting date for search in YYYY-MM-DDThh:mm:ss format.
to datetime? null Ending date for search in YYYY-MM-DDThh:mm:ss format.
channelID int 0 ID number of selected Channel.
limit int 0 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.
includeEmail boolean true True: Search includes emails. Otherwise, false.
includeSms boolean true True: Search includes SMS. Otherwise, false.
messagecategory int -1 ID of message category

Response

{"success": true, "error": null, "data": { Log } }

Example

https://api.emailwiz.com/v2/log/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelID=123456&limit=100&offset=20&includeEmail=true/false&includeSms=true/false&messagecategory=1

Back To Top

RetryNow

Retry sending of temporarily not delivered message.

/log/retrynow

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
msgID string ID number of selected message.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/log/retrynow?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&msgID=MessageID

Back To Top

Summary

Loads summary information about activity in chosen date range.

/log/summary

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
from datetime Starting date for search in YYYY-MM-DDThh:mm:ss format.
to datetime Ending date for search in YYYY-MM-DDThh:mm:ss format.
channelName string null Name of selected channel.
channelID int 0 ID number of selected Channel.
interval string “summary” ‘Hourly’ for detailed information, ‘summary’ for daily overview
transactionID string null ID number of transaction

Response

{"success": true, "error": null, "data": { LogSummary } }

Example

https://api.emailwiz.com/v2/log/summary?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&channelID=123456&interval=daily&transactionID=TransactionID

Back To Top

Segment

Add

Create new segment, based on specified RULE.

/segment/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
segmentName string Name of your segment.
rule string Query used for filtering.

Response

{"success": true, "error": null, "data": { Segment } }

Example

https://api.emailwiz.com/v2/segment/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1&rule=Status%20=%20Engaged

Back To Top

Delete

Delete existing segment.

/segment/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
segmentName string Name of your segment.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/segment/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1

Back To Top

List

Lists all your available Segments

/segment/list

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
includeHistory boolean false True: Include history of last 30 days. Otherwise, false.

Response

{"success": true, "error": null, "data": { List of Segment } }

Example

https://api.emailwiz.com/v2/segment/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&includeHistory=true/false

Back To Top

Update

Rename or change RULE for your segment

/segment/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
segmentName string Name of your segment.
newSegmentName string null New name of your segment if you want to change it.
rule string null Query used for filtering.

Response

{"success": true, "error": null, "data": { Segment } }

Example

https://api.emailwiz.com/v2/segment/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1&newSegmentName=My Segment 2&rule=Status%20=%20Engaged

Back To Top

SMS

Callback

Checking the return status of sent SMS

/sms/callback

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
messageSid string Comma separated ID numbers of messages.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/sms/callback?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&messageSid=12345678,1234567890

Back To Top

Send

Send a short SMS Message (maximum of 1600 characters) to any mobile phone.

/sms/send

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
to string Mobile number you want to message. Can be any valid mobile number in E.164 format. To provide the country code you need to provide “+” before the number. If your URL is not encoded then you need to replace the “+” with “%2B” instead.
body string Body of your message. The maximum body length is 160 characters. If the message body is greater than 160 characters it is split into multiple messages and you are charged per message for the number of message required to send your length

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/sms/send?apikey=your-apikey&to=%2b100000000&body=text_body_of_your_message

Back To Top

Template

Add

Create new Template. Needs to be sent using POST method

/template/add

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateType TemplateType 0 for API connections
templateName string Name of template.
subject string Default subject of email.
fromEmail string Default From: email address.
fromName string Default From: name.
templateScope TemplateScope ApiTypes.TemplateScope.Private Enum: 0 – private, 1 – public, 2 – mockup
bodyHtml string null HTML code of email (needs escaping).
bodyText string null Text body of email.
css string null CSS style
originalTemplateID int 0 ID number of original template.

Response

{"success": true, "error": null, "data": { int } }

Example

https://api.emailwiz.com/template/add?version=2

Back To Top

CheckUsage

Check if template is used by campaign.

/template/checkusage

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": { boolean } }

Example

https://api.emailwiz.com/v2/template/checkusage?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

Back To Top

Copy

Copy Selected Template

/template/copy

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.
templateName string Name of template.
subject string Default subject of email.
fromEmail string Default From: email address.
fromName string Default From: name.

Response

{"success": true, "error": null, "data": { Template } }

Example

https://api.emailwiz.com/v2/template/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234&templateName=Template01&subject=Hello!&fromEmail=sender@yourdomain.com&fromName=Sender

Back To Top

Delete

Delete template with the specified ID

/template/delete

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/template/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

Back To Top

GetEmbeddedHtml

Search for references to images and replaces them with base64 code.

/template/getembeddedhtml

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": { string } }

Example

https://api.emailwiz.com/v2/template/getembeddedhtml?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

Back To Top

GetList

Lists your templates

/template/getlist

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
limit int 200 Maximum of loaded items.
offset int 0 How many items should be loaded ahead.

Response

{"success": true, "error": null, "data": { TemplateList } }

Example

https://api.emailwiz.com/v2/template/getlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

Back To Top

LoadTemplate

Load template with content

/template/loadtemplate

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": { Template } }

Example

https://api.emailwiz.com/v2/template/loadtemplate?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

Back To Top

RemoveScreenshot

Removes previously generated screenshot of template

/template/removescreenshot

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/v2/template/removescreenshot?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

Back To Top

SaveScreenshot

Saves screenshot of chosen Template

/template/savescreenshot

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
base64Image string Image, base64 coded.
templateID int ID number of template.

Response

{"success": true, "error": null, "data": { string } }

Example

https://api.emailwiz.com/v2/template/savescreenshot?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&base64Image=&templateID=1234

Back To Top

Update

Update existing template, overwriting existing data. Needs to be sent using POST method.

/template/update

Parameters

Name Type Default Description
apikey string ApiKey that gives you access to our SMTP and HTTP API’s.
templateID int ID number of template.
templateScope TemplateScope ApiTypes.TemplateScope.Private Enum: 0 – private, 1 – public, 2 – mockup
templateName string null Name of template.
subject string null Default subject of email.
fromEmail string null Default From: email address.
fromName string null Default From: name.
bodyHtml string null HTML code of email (needs escaping).
bodyText string null Text body of email.
css string null CSS style
removeScreenshot boolean true

Response

{"success": true, "error": null, "data": "" }

Example

https://api.emailwiz.com/template/update?version=2

Back To Top

in Developers

0

0

Leave a Reply