The submit URL for the return formats supported are relatively the same. Specifically, use these:
Campaign Related Methods |
static string |
emailCopy (string token, string emailid)
Duplicate an existing Email and return the ID of the newly created Email.
|
static string |
emailCreate (string token, array emailDetails)
Create a new Email based on the details provided. Return the ID of the newly created Email.
|
static string |
emailRssCreate (string token, array emailDetails)
Create a new Rss Email based on the details provided. Return the ID of the newly created Rss Email.
|
static bool |
emailDelete (string token, string emailID)
Delete the Email for given ID. Returns true if the email was deleted.
|
static array |
emailGet (
string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of emails using the filter and paging limits, order by the name or date of the email.
|
static array |
emailGetDetail (
string token, string emailID)
Get all the details for given Email ID.
|
static array |
emailRssGet (
string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of Rss emails using the filter and paging limits, order by the name or date of the email.
|
static array |
emailRssGetDetail (string token, string emailID)
Get all the details for given Rss Email ID.
|
static array |
emailGetList (string token, string emailID)
Get the list of contact lists being used in an email.
|
static bool |
emailSchedule (string token, string emailID, string scheduleDate)
Schedule an email for delivery for the given date time.
|
static bool |
emailRssSchedule (string token, string emailID, string scheduleDate, string interval)
Schedule an Rss email for delivery for the given date time and interval.
|
static bool |
emailSendNow (string token, string emailID)
Schedule an email for immediate delivery.
|
static bool |
emailSendTest (string token, string emailID, string testEmail)
Send a test email for the given Email ID
|
static bool |
emailUnSchedule (string token, string emailID)
Set an email as draft. This would clear its delivery schedule.
|
static bool |
emailUpdate (string token,array emailDetails)
Update an existing email with the given details.
|
static bool |
emailRssUpdate (string token,array emailDetails)
Update an existing email with the given details.
|
static bool |
emailAssignList (string token, string emailID, array contacts)
Assign the given contact/segments to the email.
|
static bool |
emailReassignList (string token, string emailID, array contacts)
Reassign the given contact/segments to the email.
|
static string |
emailResend (string token, string emailID,string scheduleDate)
Resend an email campaign to contacts that were added since the campaign was last sent .
|
static string |
emailQuickSend (string token, string emailID , string ListName , array emails , string scheduleDate)
Quick send the email campaign to a list of contacts .
|
static array |
emailCategoryGetList (string token)
Gets all the available email Template Categories.
|
static string |
autoresponderCreate (string token, array Autoresponder)
Create an Autoresponder campaign .
|
static bool |
autoresponderUpdate (string token, string autoresponderID, int status , array Autoresponder)
Update an Autoresponder campaign .
|
static bool |
autoresponderDelete (string token , string autoresponderID )
Delete an Autoresponder campaign .
|
static bool |
autoresponderDetailDelete (string token , string autoresponderID , string autoresponderDetailID )
Delete an Autoresponder email .
|
static array |
autoresponderGetList (
string token, integer pageNumber, integer pageSize, string orderBy , string filter , string sortOrder)
Get the list of Autoresponders using the filter and paging limits, order by the name or date of the autoresponder.
|
static array |
autoresponderGetEmailDetail (string token , string autoresponderID , string autoresponderDetailID )
Get details of the Autoresponder email .
|
static array |
autoresponderGetDetail (string token , string autoresponderID )
Get details of the Autoresponder.
|
static string |
autoresponderDetailCreate (string token, array AutoresponderDetail)
Create Autoresponder email template and Returns the ID of the newly created Autoresponder email template.
|
Contact List Related Methods |
static integer |
listAddContacts (string token, string listID, array contacts)
Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items. |
static array |
listAddContactsRetID (string token, string listID, array contacts)
Add the contact details to the given contact list and returns contacts ID's in CSV format. |
static integer |
listAddContactsOptin (string token, string listID, array contacts, string optin)
Add the contact details to the given contact list after confirmation. Multiple contacts would be added if the details has more than one items. |
static string |
batchAddContacts (string token, string listID, array contacts)
Adding Multiple Contacts to a Email List and returns batch ID. |
static string |
batchGetStatus (string token, string listID, string batchID)
Returns status for the batch upload based on the batch ID. |
static string |
listCreate (string token, string listName)
Create a new contact list with the given name. Returns the ID of the newly created list. |
static bool |
listUpdate (string token, string listID, string listName, string listDiscription)
Update an existing contact list with the given name and discription. |
static bool |
listDelete (string token, string listID)
Delete an existing contact list. |
static array |
listSearchContacts (string token, string emailID)
Get the contact list Details for the given email ID. |
static array |
listGet (string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of contact lists using the filter and paging limits, ordered by the name or date of the contact list. |
static array |
listGetContactDetails (string token, string listID, string email)
Get the contact details from the contact list for the given email address. |
static array |
listGetContacts (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of contacts in the given list using the filter and paging limits, ordered by the email or date of the contact. |
static array |
listGetContactsAllFields (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of contacts in the given list using the filter and paging limits, ordered by the email or date of the contact. |
static array |
listGetContactsByType (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder, string Type)
Get the list of contacts in the given list of specific type may be(Optin or NotOptedIn or ConfirmedBounces or Active or Unsubscribe) using the filter and paging limits, ordered by the email or date of the contact. |
static array |
listUpdateContactDetails (string token, string listID, string contactID, array contactDetail)
Update the given contact in the list based on the details provided. |
static integer |
listUnsubscribeContacts (string token, string listID, array contacts)
Unsubscribe the contacts from the given contact list. |
static bool |
listDeleteContacts (string token, string listID, string contactids)
Delete contacts from the given contact list. |
static bool |
listDeleteEmailContact (string token, string listID, string email)
Delete a contact which matches the email from the given contact list. |
static integer |
listAddContactsForm (string token, string signupFormID, array contacts)
Add the contact details using the given signup form. |
static int |
contactsGetUniqueActiveCount (string token)
Calculates count of total unique active contacts |
static string |
segmentCreate (string token, array segmentDetail)
Create a new segment based on the given details |
static bool |
segmentDelete (string token, string segmentID)
Delete a segment based on the given ID |
static array |
segmentGet (string token, string filter, int pageNumber, int pageSize, string orderBy)
Get the list of segments using the paging limits, ordered by the name or date of the segment |
static array |
segmentGetDetail (string token, string segmentID)
Get the details of segment based on the segment ID |
static array |
segmentGetCriteriaList (string token, string segmentID)
Get the list of segment criteria |
static string |
segmentCreateCriteria (string token, string segmentID, array segmentCriteria)
Create a segment criteria |
static string |
segmentGetContacts (string token, string segmentID, string filter, int pageNumber, int pageSize, string orderBy, string sortOrder)
Get the contacts for a segment |
static int |
segmentGetCount (string token, string filter)
Get the count of segments |
Reports Related Methods |
static array |
reportGet (string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of sent campaign using the filter and paging limits, ordered by the name or date of the campaign. |
static array |
reportGetBounces (string token, string emailID, integer pageNumber, integer pageSize, string Filter,string orderBy,string sortOrder)
Get the email addresses which bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record. |
static array |
reportGetClicks (string token, string emailID)
Get the click URL stats for the given campaign. |
static array |
reportGetEmailLinks (string token, string emailID)
Get the Link URLS for the given campaign. |
static array |
reportGetClickEmails (string token, string emailID,string ClickURL, int PageNumber, int pageSize, string orderBy, string sortOrder)
Get the email address which have clicked on URLs for the given campaign. |
static array |
reportGetForwards (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses to which the given campaign was forwarded,using the paging limits, ordered by the email or date of the forwarded record. |
static array |
reportGetHardBounces (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses which hard bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record. |
static array |
reportGetSoftBounces (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses which soft bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record. |
static array |
reportGetOpens (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses which were opened in a given campaign,using the paging limits, ordered by the email or date of the opened record. |
static array |
reportGetUnopens (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses which neither opened nor bounced in a given campaign,using the paging limits, ordered by the email or date of the opened record. |
static array |
reportGetUnsubscribes (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the email addresses which unsubscribed in a given campaign,using the paging limits, ordered by the email or date of the unsubscribe record. |
static array |
reportGetSummary (string token, string emailID)
Get the summary statistics for a given campaign. |
static array |
reportCompare (string token, string emailIDs)
Get the summary statistics for more than one campaign. |
static array |
reportGetOpenCountry (string token, string emailID)
Get the list of Countries with there region code and opent Count |
static array |
reportGetOpenForCountry (string token, string emailID,string CountryCode)
Retrives Open Count for each region of the country |
Survey Methods |
static string |
surveyCreate (string token, SurveyStructure surveyData)
Create a new Survey based on the details provided. Return the ID of the newly created Survey. |
static string |
surveyUpdate (string token,string SurveyID, SurveyStructure surveyData)
Update an existing Survey based on the details provided. Return the ID Updated Survey. |
static string |
surveyDelete (string token, string SurveyID)
Delete an existing Survey based on the details provided. Return the ID of Deleted Survey. |
static string |
surveyQuestionCreate (string token,string SurveyID, SurveyQuestionStructure surveyQuestionData)
Create a new Survey Question based on the details provided. Return the ID of the newly created Survey Question. |
static string |
surveyQuestionDelete (string token, string SurveyID, string QuestionID)
Delete an existing Survey Question based on the details provided. Return the ID of the Deleted Survey Question. |
static string |
surveyQuestionUpdate (string token, string SurveyID, SurveyQuestionStructure surveyQuestionData)
Update an existing Survey Question based on the details provided. Return the ID of the updated Survey Question. |
static string |
surveyColorUpdate (string token, string SurveyID, SurveyColorStructure surveyColorData)
Update Survey Color based on the details provided. Return the ID of the updated Survey. |
static integer |
surveyStatusUpdate (string token, string SurveyID, string Status)
Update Survey Status based on the details provided. Returns 1 if the survey is updated else 0. |
static array |
surveyGetList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
Get the list of Surveys using the filter and paging limits, order by the name or date of the surveys. |
static array |
surveyGetColor (string token, string SurveyID)
Get the color of Surveys. |
static array |
surveyGetQuestionList (string token, string SurveyID)
Generates the report of all the available survey questions |
static array |
surveyReportList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
Get the report of Survey. |
static array |
surveyResponseReport (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
Get the list of Survey Questions with answers and there responses. |
static array |
surveyTemplateGetList (string token)
Provide all available templates for the survey. |
static string |
surveyCopy (string token,string SurveyID,string NewSurveyName)
Create a new Survey using existing survey. Return the ID of the newly created Survey. |
static string |
surveyCopyTemplate (string token,string SurveyID,string NewSurveyName)
Create a new Survey using existing survey template. Return the ID of the newly created Survey. |
Poll Methods |
static string |
pollCreate (string token, PollStructure pollData)
Create a new Poll based on the details provided. Return the ID of the newly created Poll. |
static string |
pollUpdate (string token,string PollID, PollStructure pollData)
Update an existing Poll based on the details provided. Return the ID of the Updated Poll. |
static string |
pollDelete (string token, string PollID)
Delete an existing Poll based on the details provided. Return the ID of the Deleted Poll. |
static integer |
pollStatusUpdate (string token, string PollID, string Status)
Update Poll Status based on the details provided. Return 1 if the poll is updated else 0. |
static array |
pollGetList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
Get the list of Polls using the filter and paging limits, order by the name or date of the polls. |
static string |
pollCopy (string token,string PollID,string NewPollName)
Create a new Poll using existing poll. Return the ID of the newly created Poll. |
static array |
pollReportList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
Generates the report of all the available poll. |
static array |
pollResponseReport (string token, string PollID)
Get the list of Poll Options with their responses. |
SignUp Form Methods |
static string |
signupFormCreate (string token, SignupFormDataStructure signupForm)
Create a new Signup Form based on the details provided. Return the ID of the newly created SignUpForm. |
static bool |
signupFormUpdateColor (string token,string signupFormID, SignupFormColorStructure signupForm)
Update Colors,background and font of an existing SignUp Form based on the details provided. Return Boolean value true if form updated else false |
static bool |
signupFormUpdate (string token,string signupFormID, SignupFormDataStructure signupForm)
Update an existing SignUp Form based on the details provided. Return Boolean value true if SignupForm updated. |
static bool |
signupFormUpdateMessage (string token,string signupFormID, SignupFormDataStructure signupForm)
Update various custom fields of an existing SignUp Form based on the details provided. Return Boolean value true if form updated else false |
static array |
signupFormGet (string token,string signupFormID)
Retrive an existing SignUp Form based on the details provided. Return SignupFormDataStructure |
static string |
signupFormGetCode (string token, string signupFormID, string Codetype)
Retrive an existing SignUp Form's Code based on the details provided. Returns code as the string. |
static bool |
signupFormDelete (string token, string signupFormID)
Delete an existing SignUp Form based on the details provided. Returns boolean true if deleted else false |
static array |
listGetSignupForms (string token, integer pageNumber, integer pageSize, string orderBy)
Get the list of signup forms using the paging limits, ordered by the name or date of the signup form. |
User Management Methods |
static string |
login (string username, string password)
Authenticate the user and returns a token. |
static bool |
tokenAdd (string username, string password, string token)
Add a token for the user. |
static bool |
tokenDelete (string username, string password, string token)
Delete an existing token for the user. |
static integer |
subAccountCreate ( string token, array accountstruct)
Register a new SubAccount for the user |
static integer |
subAccountUpdate ( string token, array accountstruct)
Update SubAccount details for the user |
static array |
subAccountGetList ( string token)
Get the list of SubAccounts for the user |
|
subAccountUpdateStatus ( string token, string ID , string status )
Update SubAccount status for the user |
static array |
confirmEmailList ( string token)
Get the list of emails sent for confirmation by the user |
static string |
confirmEmailAdd ( string token, string targetEmailID)
Adding emails for confirmation for the user |
Event Related Methods |
static array |
eventGetList (string token, string filtertype, string filterdetail, string pageNumber, string pageSize, string orderBy, string sortOrder)
Get the list of Events using the filter and paging limits, order by the name of the events.
|
static array |
eventGet (string token, string eventid)
Get the details of an Event.
|
static array |
eventGetTicketType (string token, string eventid)
Get the tickets of the event.
|
static array |
eventTemplateGetList (string token, string categoryID, string filter, string lang)
Get the list of event templates.
|
static bool |
eventUpdatePage (string token, string eventID, string templateID, string content, string css, string csscode )
Update the page for the event.
|
static bool |
eventInviteCampaignUpdate (string token, string eventID, string emailID, string content, string contentRaw, string address, string city, string state, string zip, string intlAddress, string isIntl, string textVersion, string templateID, string senderName, string replyEmail, string subject, string listIDs)
Update the invite for the event.
|
static array |
ticketGetList (string token, string eventID, string filtertype, string dateID, string filterdetail, string pageNumber, string pageSize, string orderBy, string sortOrder)
Get the event Ticket List.
|
static array |
ticketGetByID (string token, string eventID, string ticketID)
Get the event Ticket By ID.
|
static bool |
attendeeCheckIn (string token, string eventID, string ticketitemID)
Attendee Checkin
|
static bool |
attendeeCheckOut (string token, string eventID, string ticketitemID)
Attendee Checkout
|
static string |
eventUpdatePayStatus (string token, string EventID, string orderid, int status)
Set the Event Order Pay Status
|
static string |
eventUpdateTicketItemPayStatus (string token, string EventID, string TicketItemID, int status)
Set the Event Ticket Pay Status
|
static string |
eventUpdateUrl (string token, string EventID, string EventURL)
Update the event Url
|
static int |
eventUpdatePaypalEmail (string token, string EmailID, string OldEmailID)
Update the Paypal Email
|
static string |
eventUpdateEventGoogleMerchant (string token, string GoogleMID, string GoogleMKEY, string OldGoogleMID, string OldGoogleMKEY)
Update the Google Merchant
|
static string |
eventRefund (string token, string EventID, string orderID)
Set the order status refund
|
static string |
eventTicketItemRefund (string token, string EventID, string ticketitemID)
Set the ticket status refund
|
static string |
eventResendTicket (string token, string EventID, string orderID)
Resend event Ticket
|
static string |
eventCopy (string token, string eventID, string eventName)
Copy the event
|
static int |
eventCreateFBEvent (string token, string EventID, string PageID, string PageName , string PageToken , string Eventname , string StartTime , string Location , string Description)
Create the event on Facebook
|
static int |
eventUpdateFBEvent (string token, string EventID, string StartTime , string Location , string Description)
Update the event on Facebook
|
static int |
eventCancelFBEvent (string token, string EventID)
Cancel the event on Facebook
|
static string |
eventValidatePayPalEmail (string token, string Email)
Validate the PayPal Email
|