MyBizMailer API Version 1.0 Documentation.

Output Formats for Serialized calls

MyBizMailer API returns XML and JSON data formats. The format for the data is based on the URL requested.Samples for each data type are given on specific examples.

For XML-RPC, simply tell your client to connect to:

For JSON, simply tell your client to connect to:

Please note: As of Jan 28 2015 all request to API should be through SSL (HTTPS). All other calls will generate an error.

Any HTML content must be encoded with URL Encoding HttpUtility.UrlEncode(HtmlContent)

Campaign Related Methods

Campaigns(string apikey, string campaignid)
Get the list of campaigns and their details matching the specified filters. CampaignContent(string apikey, string campaignid)
Get the html and text content for the campaign either as it would appear in the campaign archive or as the raw, original content. CampaignAdd(string apikey, string campaignname, string subject, string fromemail, string fromname, string campaignhtml, string campaigntext, string campaigntext, string scheduledtime, bool saveasdraft, string listid)
Schedule a campaign to be sent in the future or just save it as draft to be sent latter. CampaignDelete(string apikey, string campaignid)
Deletes a campaign. CampaignSend(string apikey, string campaignid)
Sends an existing campaigns that is sent on draft mode. CampaignScheduleNow(string apikey, string campaignid, string scheduletime)
Schadules an existing campaign to be sent at scheduled time. CampaignUnscheduleNow(string apikey, string campaignid, string campaignid, )
Unschedule a campaign that is scheduled to be sent in the future and saves it on draft. CampaignsUpdate(string apikey, string campaignid, string campaignname, string subject, string fromemail, string fromname, string campaignhtml, string campaigntext, string campaigntext, string scheduledtime, string listid)
Get the content (both html and text) for a campaign either as it would appear in the campaign archive or as the raw, original content CampaignSendTestNow(string apikey, string campaignid, string array testemails)
Sends a test campaigns to the list of test emails. CampaignCopyNow(string apikey, string campaignid, string campaignname)
Replicates an existing campaign into a new campaign.

Campaign Report Related Methods

CampaignClickGet(string apikey, string campaignid)
Get a lists of campaigns links with the click count for each link. CampaignDeliveryGet(string apikey, string campaignid, string deliverystatus)
Gets the delivery report details for each email on the campaign. CampaignReportGet(string apikey, string campaignid)
Get the delivery report on the campaign(delivered, soft bounce, hard bounce numbers).

List Related Methods

GetList(string apikey, string listid, string listname)
Get lists from the account. ListSubscribeNow(string apikey, string listid, string subscriberid, string emailaddress)
Updates the lists for a subscriber.

Subscriber Related Methods

ListSubscribersGet(string apikey, string listid, string status)
Gets subscribers on the list. SubscriberListsGet(string apikey, string subscriberid, string emailaddress)
Gets the list ID for the subscriber based on email addresss or subscriber id ListUnSubscribeNow(string apikey, string subscriberid, string emailaddress)
Unsubscribes a subscriber from the list, based on subscriber id or email address. SubscriberAdd(string apikey, string listid, string emailaddress, string firstname, string lastname, string title, string company,string phone, string address, string city, string state, string country, string dob)
Adds a new subscriber to the list specified. SubscriberUpdate(string apikey, string subscriberid, string listid, string emailaddress, string firstname, string lastname, string title, string company,string phone, string address, string city, string state, string country, string dob)
Adds a new subscriber to the list specified. SubscriberDeleteNow(string apikey, string subscriberid)
Deletes a subscriber from the account. SubscriberCampaignsGet(string apikey, string subscriberid, string emailaddress)
Get the list of campaigns that were sent to subscriber. UnsubscribeSubscriber(string apikey, string subscriberid, string emailaddress)
Unsubscribes a subscriber from any list.

Transaction Emails

SendMail(string apikey, string fromemail, string fromname, string toemail, string subject, string htmlpart, string textpart, string textonly)
Sends the transactional email.

System Checking Method

PingGet(string apikey)
Pings the system to see status.