XMLAPI



The following methods are supported:

method abreportGet

Get the list of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the results
integerpageNumber - The page number from which you want the results
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns true.

method abtestGet

Get the list of emails using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct AbTestStructureReturns the list of emails.

method attendeeCheckIn

Attendee Checkin

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringticketitemID - The TicketItem ID

Return Value

booleanReturns the event ticket

method attendeeCheckOut

Get the event Ticket

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringticketitemID - The TicketItem ID

Return Value

booleanReturns the event ticket

method autoresponderCreate

Create a new Autoresponder based on the details provided. Return the ID of the newly created Autoresponder.

Parameters

stringtoken - Your Benchmark Email Token
struct AutoResponderDataStructureAutoresponder - The details for the email

Return Value

stringReturns the ID of the newly created Autoresponder.

method autoresponderDelete

delete the autoresponder whose id has been specified

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Id of the autoresponder

Return Value

booleanReturns True

method autoresponderDetailCreate

Create Autoresponder Details.

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Your Benchmark Email Token
struct AutoResponderDetailDataStructureAutoresponderDetail - The details for the email

Return Value

stringReturns the ID of the newly created Autoresponder Details.

method autoresponderDetailDelete

delete the autoresponder email whose id has been specified

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Id of the autoresponder
stringautoresponderDetailID - Id of the autoresponder email detail

Return Value

booleanReturns True

method autoresponderDetailHistoryDelete

deletes the eamil address from Autoresponder history whose id has been specified and email address have been specified

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Id of the autoresponder
stringautoresponderDetailID - Id of the autoresponder email detail
stringemail - email address to be deleted

Return Value

booleanReturns True

method autoresponderGetDetail

get the details of the autoresponder whose id has been specified

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Id of the autoresponder

Return Value

struct AutoResponderDetailedStructureReturns autoresponder details.

method autoresponderGetEmailDetail

Get all the details for given AutoresponderID and AutoresponderdetailID .

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - The ID for your Autoresponder
stringautoresponderDetailID - The ID for your Autoresponder Detail

Return Value

struct EmailStructureReturns the structure with the details of the email.

method autoresponderGetList

Get the list of autoresponders using the filter and paging limits.

Parameters

stringtoken - Your Benchmark Email Token
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringfilter - The filter you want to apply when fetching the lists of autoresponders
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct AutoresponderStructureReturns the list of autoresponders.

method autoresponderUpdate

Update the autoresponder whose id has been specified

Parameters

stringtoken - Your Benchmark Email Token
stringautoresponderID - Id of the autoresponder
integerstatus - Status of the Autoresponder
struct AutoResponderDataStructureAutoresponder - The details for the email

Return Value

booleanReturns 1 if successful or 0 if unsuccessful.

method batchAddContacts

BETA

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information

Return Value

stringBETA

method clientGetContactInfo

Get Client Info

Parameters

stringtoken - Your Benchmark Email Token

Return Value

struct ClientSettingsStructurereturns Client settings structure

method clientGetPlanInfo

Get Plan Info

Parameters

stringtoken - Your Benchmark Email Token

Return Value

struct ClientPlanInfoStructurereturns Client Plan Info

method clientGetYouTubeInfo

Get YouTube Authorization for the account

Parameters

stringtoken - Your Benchmark Email Token

Return Value

struct ClientMasterStructureReturns the authorization data

method clientGetYouTubeVideos

Get YouTube Videos for the account

Parameters

stringtoken - Your Benchmark Email Token
stringYTLogin - YouTube Login
stringPageNumber - Page Number
stringPageSize - Page Size

Return Value

array of struct YouTubeVideoStructureReturns the list of videos

method clientSetContactInfo

Set Client Info

Parameters

stringtoken - Your Benchmark Email Token
struct ClientSettingsStructurecltStruct - Client settings structure

Return Value

integerSets Client settings

method clientSetYouTubeInfo

Set YouTube Authorization for the account

Parameters

stringtoken - Your Benchmark Email Token
stringUsername - Login for the YouTube Account
stringPassword - Password for the YouTube Account

Return Value

booleanReturns true if the data is saved

method clientUpdateExtra

Update Client Extra

Parameters

stringtoken - Your Benchmark Email Token
stringclientID - The Client ID
stringcolname - The Column Name
stringcolval - The Column Value

Return Value

stringUpdate result

method confirmEmailAdd

Add emails for Confirmation

Parameters

stringtoken - Your Benchmark Email Token
stringtargetEmailID - List of emails to be confirmed

Return Value

stringreturns List of Confirmed Emails

method confirmEmailList

Get Confirmed Emails

Parameters

stringtoken - Your Benchmark Email Token

Return Value

array of struct ConfirmEmailStructurereturns List of Confirmed Emails

method emailAssignList

Assign contact lists to the email

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The email ID
array of struct EmailContactStructurelists - The contact lists

Return Value

booleanReturns true.

method emailBadgeUpdate

Update the email badge

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - ID for the email
stringbadge - The Badge URL

Return Value

stringReturns status of the update

method emailCategoryGetList

Get the list of email templates Categories

Parameters

stringtoken - Your Benchmark Email Token

Return Value

array of struct EmailTemplateCategoryStructureReturns the list of email templates Category.

method emailCheckName

Check the name of an Email to determine if it is taken. Return 1 if it is unique.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The email ID to check
stringemailName - The email name to check

Return Value

integerReturns 1 if the name is unique.

method emailCopy

Duplicate an existing Email and return the ID of the newly created Email.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to copy

Return Value

stringReturns the Email ID of the newly created email.

method emailCopyAs

Duplicate an existing Email and return the ID of the newly created Email.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to copy
stringnewName - The New Name for the email copy

Return Value

stringReturns the Email ID of the newly created email.

method emailCreate

Create a new Email based on the details provided. Return the ID of the newly created Email.

Parameters

stringtoken - Your Benchmark Email Token
struct EmailStructureemail - The details for the email

Return Value

stringReturns the ID of the newly created email.

method emailDelete

Delete the Email for given ID. Returns true if the email was deleted.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID you want to delete

Return Value

booleanReturns true.

method emailDeleteV4

Delete the Email for given ID. Returns true if the email was deleted.

Parameters

stringtoken - Your Benchmark Email Token
stringemailIDList - The Email IDs you want to delete

Return Value

struct GenericResponseStructureReturns true.

method emailGet

Get the list of emails using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns the list of emails.

method emailGetCount

Get the count of email using the filter and status.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email

Return Value

doubleReturns number of campaigns.

method emailGetCountV4

Get the list of emails

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The emailID to exclude
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email

Return Value

integerReturns number of records

method emailGetDetail

Get all the details for given Email ID.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The ID for your Email

Return Value

struct EmailStructureReturns the structure with the details of the email.

method emailGetDetailIPhone

Get all the details for given Email ID.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The ID for your Email

Return Value

struct EmailStructureReturns the structure with the details of the email.

method emailGetDetailV4

Get all the details for given Email ID.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The ID for your Email

Return Value

struct EmailStructureReturns the structure with the details of the email.

method emailGetList

Get all the Lists for given Email ID.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The ID for your Email

Return Value

array of struct EmailContactStructureReturns the structure with the lists for the email.

method emailGetListV4

Get the list of emails

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The emailID to exclude
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns status of the save

method emailGetMyTemplateList

Get the list of email templates

Parameters

stringtoken - Your Benchmark Email Token
stringlanguage - The Langauge
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct EmailTemplateStructureReturns the list of email templates.

method emailGetTemplateCountV4

Get the list of emails

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
stringfilterCat - The category filter
stringlanguage - The language for the emails

Return Value

integerReturns number of records

method emailGetTemplateListV4

Get the list of emails

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
stringfilterCat - The category filter
stringlanguage - The language for the emails
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailTemplateStructureReturns number of records

method emailPreview

Get the preview for an email

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for the preview
stringemailAddress - The email address for which to preview. Leave it blank for the first contact in the associated list
stringhtmlContent - The HTML Content for the preview
stringtextContent - The Text Content for the preview

Return Value

struct EmailStructureReturns the preview of the email

method emailPreviewTest

Send the test email for a preview

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for the preview
stringemailAddresses - The email addresses for which to send test
stringhtmlContent - The HTML Content for the preview
stringtextContent - The Text Content for the preview
stringpersonalMessage - Personal Message in the email

Return Value

stringReturns true if email is sent

method emailQuickSend

Resend an Email campaign to a list of email addresses

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID of the campaign
stringListName - Name of the list that will be created
array of structemails - List of Email addresses to whom the campaign should be sent
stringscheduleDate - The Datetime for which the campaign is to be rescheduled

Return Value

stringReturns true if email is sent

method emailReassignList

Reassign contact lists to the email. Previous selection is removed

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The email ID
array of struct EmailContactStructurelists - The contact lists

Return Value

booleanReturns true.

method emailRemoveSchedule

Set an email which is resend as draft. This would clear its delivery schedule.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to schedule

Return Value

booleanReturns true if the email was unscheduled.

method emailResend

Resend an Email campaign so that it goes to contacts that were added since the campaign was first sent

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID of the campaign
stringscheduleDate - The Datetime for which the campaign is to be rescheduled

Return Value

stringReturns true if email is resent

method emailRssCreate

Create a new Email based on the details provided. Return the ID of the newly created Email.

Parameters

stringtoken - Your Benchmark Email Token
struct EmailStructureemail - The details for the email

Return Value

stringReturns the ID of the newly created email.

method emailRssGet

Get the list of RSS emails using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns the list of emails.

method emailRssGetDetail

Get all the details for given Email ID.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The ID for your Email

Return Value

struct EmailStructureReturns the structure with the details of the email.

method emailRssSchedule

Schedule an email for delivery for the given date time

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to schedule
stringscheduleDate - The Datetime for which the rss campaign is to be scheduled
stringinterval - Interval for rss campaign, can be either 1 , 7 or 30

Return Value

booleanReturns true if the email was scheduled.

method emailRssUpdate

Update an existing email with the given details.

Parameters

stringtoken - Your Benchmark Email Token
struct EmailStructureemail - The details for the email

Return Value

booleanReturns true.

method emailSchedule

Schedule an email for delivery for the given date time

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to schedule
stringscheduleDate - The Datetime for which the campaign is to be scheduled

Return Value

booleanReturns true if the email was scheduled.

method emailScheduleForTimeZone

Schedule an email for delivery for the given date time and timezone

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to schedule
stringscheduleDate - The Datetime for which the campaign is to be scheduled
stringtimeZone - The Timezone for which the campaign is to be scheduled. Available Timezones are (ADT, AST, CDT, CST, EDT, EST, MDT, MST, PDT, PST, ACDT, ACST, AEDT, AEST, SAD, SAST, AWDT, AWST, BT, BET, BZT2, BDST, BST, CAT, CED, CET, CCT, CAF, EED, EET, EEST, MED, MET, MEST, MEWT, FST, FWT, GMT, GST, HDT, HST, IDLE, IDLW, IST, IT, JST, JT, MT, NDT, NFT, NT, NST, NZST, NZDT, ROK, SST, SWT, USZ3, USZ4, USZ5, USZ6, UTC, UZ10, WAT, WET, YDT, YST).

Return Value

booleanReturns true if the email was scheduled.

method emailSchemeDelete

Delete the email scheme

Parameters

stringtoken - Your Benchmark Email Token
stringschemeID - ID for the color scheme

Return Value

stringReturns status of the delete

method emailSchemeListGet

Get the email template by the template ID

Parameters

stringtoken - Your Benchmark Email Token
stringlanguage - Language
stringfilterType - Filter Type
stringfilter - Filter
stringpageNumber - The Page Number
stringpageSize - The Page Size
stringorderBy - The Sort Field
stringsortOrder - The Sort Order

Return Value

array of struct EmailSchemeStructureReturns the list of Schemes for the email.

method emailSchemeSave

Save the email scheme

Parameters

stringtoken - Your Benchmark Email Token
stringschemeName - Name for the color scheme
stringcssCode - The CSS Code
stringoverwrite - Overwrite old scheme
stringlanguage - Language

Return Value

struct GenericResponseStructureReturns status of the save

method emailSendNow

Schedule an email for immediate delivery

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to send

Return Value

booleanReturns true if the email was sent.

method emailSendTest

Send a test email for the given Email ID

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to test
stringtestEmail - The email address to which the test is to be sent

Return Value

booleanReturns true if the email was sent.

method emailTemplateGet

Get the email template by the template ID

Parameters

stringtoken - Your Benchmark Email Token
stringtemplateID - The ID for the template

Return Value

stringReturns the HTML for the template.

method emailTemplateGetCount

Get the count of email templates for iPhone Users

Parameters

stringtoken - Your Benchmark Email Token

Return Value

integerReturns the count of templates.

method emailTemplateGetList

Get the list of email templates for iPhone user

Parameters

stringtoken - Your Benchmark Email Token
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct EmailTemplateStructureReturns the list of email templates.

method emailTemplateGetList1

Get the list of email templates for iPhone user

Parameters

stringtoken - Your Benchmark Email Token
stringlanguage - The Langauge
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct EmailTemplateStructureReturns the list of email templates.

method emailUnSchedule

Set an email as draft. This would clear its delivery schedule.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID which you want to schedule

Return Value

booleanReturns true if the email was unscheduled.

method emailUpdate

Update an existing email with the given details.

Parameters

stringtoken - Your Benchmark Email Token
struct EmailStructureemail - The details for the email

Return Value

booleanReturns true.

method eventAttendeeGetCode

Get the event attendees code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringreportType - The report type
stringfilter - The filter you want to apply when fetching the events
stringfilterDetail - The filter details
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order
stringsortOrder - The sort order (asc / desc)

Return Value

stringReturns the event list

method eventAttendeePreview

Get the event attendee preview code

Parameters

stringtoken - Your Benchmark Email Token
stringattendeeID - The attendee ID

Return Value

stringReturns the event attendee

method eventCancelFBEvent

Cancel the event on Facebook

Parameters

stringtoken - token
stringEventID - Event ID
stringProfileID - FB Profile ID

Return Value

integerReturns Cancel Event

method eventCommentShow

Show/ Hide comment on Facebook

Parameters

stringtoken - token
stringEventID - Event ID
stringPostID - Post ID
stringshow - Show = 1 / Hide = 0

Return Value

stringReturns posted comment ID

method eventCopy

Copy the event

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringeventName - The event Name

Return Value

stringReturns the URL for edit

method eventCreateFBEvent

Post the event on Facebook

Parameters

stringtoken - token
stringEventID - Event ID
stringPageID - Page ID
stringPageName - Page name
stringPageToken - Page Access Token
stringEventname - Event Name
stringStartTime - Event StartTime
stringLocation - Event Location
stringDescription - Event description
stringProfileID - Profile ID

Return Value

integerReturns posted Event ID

method eventDeleteDiscountCode

Delete the Discount Code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringdiscountID - The Discount ID

Return Value

integerReturns the Discount Code deleted ot not

method eventEmailGet

Get the list of event emails using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns the list of event emails.

method eventGet

Get the details of an Event

Parameters

stringtoken - Your Benchmark Email Token
stringeventid - The event id of the event you want to fetch

Return Value

struct EventGetStructureReturns the event

method eventGetAttendeeEmailPreview

Get the attendee email preview

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringemailID - The email ID

Return Value

stringReturns the attendee email preview

method eventGetChartsCode

Get the event charts code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringreportType - The report type
stringfromDate - The start date filter you want to apply when fetching the events
stringtoDate - The end date filter you want to apply when fetching the events
stringorderBy - The field you want to order
stringsortOrder - The sort order (asc / desc)
stringchartType - The Chart type
stringemailID - The Email ID
stringType - The Invite stats part to load
stringcountry - The country

Return Value

stringReturns the event ticket type and count

method eventGetEncodeParameter

Get the event Encode Parameter

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID

Return Value

stringReturns the event Encode Parameter

method eventGetExcelUrl

Get the event Excel Url

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringdateID - The Date ID
stringClientID - The Client ID
stringorderBy - The field you want to order
stringreportType - The Report Type
stringfilterType - The Filter Type
stringfilterDetail - The Filter Detail

Return Value

stringReturns the event Excel Url

method eventGetFBEvents

Get the FB Events

Parameters

stringtoken - Your Benchmark Email Token
stringTokenSecret - The FB TokenSecret
stringSN - The FB ScreenName

Return Value

stringReturns the FB EventList

method eventGetFBPages

Get the FB Pages

Parameters

stringtoken - Your Benchmark Email Token
stringTokenSecret - The FB TokenSecret
stringSN - The FB ScreenName
stringProfileID - The FB Profile ID

Return Value

stringReturns the FB Pages

method eventGetInviteContactList

Get the event invite contacts

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringemailID - The Email ID
stringreportType - The Type of the Report
stringfilter - The Filter
integerpageNumber - The page number from which you want the signup forms
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (name / date)
stringsortOrder - The sort order (asc / desc)

Return Value

stringReturns the event contact list

method eventGetList

Get the list of Events using the filter and paging limits, order by the name of the events.

Parameters

stringtoken - Your Benchmark Email Token
stringfiltertype - The filtertype you want to apply when fetching the events
stringfilterdetail - The filterdetail you want to apply when fetching the events
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EventStructureReturns the event list

method eventGetPDFUrl

Get the event PDF Url

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringClientID - The Client ID
stringorderBy - The field you want to order
stringpagename - The pdf report name
stringbarcode - The barcode print or not
stringDateID - The Date id
stringHTMLData - The HTML Data
stringreportType - The Report Type
stringticketType - The Ticket Types
stringticketItems - The Attendees
stringmode - The Badge Style

Return Value

stringReturns the event PDF Url

method eventGetReportCode

Get the event report code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringdateID - The Date ID
stringreportType - The report Type
stringfilterType - The Filter Type
stringfilterDetail - The Filter Detail
stringpageNumber - The Page Number
stringpageSize - The Page Size
stringorderBy - The Order
stringsort - The Sort
stringLanguage - The Langauge

Return Value

Returns the event report

method eventGetReportsCode

Get the event Reports code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringreportType - The report type
stringfilter - The filter you want to apply when fetching the events
stringfromDate - The start date filter you want to apply when fetching the events
stringtoDate - The end date filter you want to apply when fetching the events
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order
stringsortOrder - The sort order (asc / desc)
stringchartType - The Chart type

Return Value

stringReturns the event ticket type and count

method eventGetTicketType

Get the tickets of the event

Parameters

stringtoken - Your Benchmark Email Token
stringeventid - The event id of the event you want to fetch

Return Value

array of struct EventTicketTypeStructureReturns Tickets for the event

method eventInviteCampaignUpdate

Update the invite for the event

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringemailID - The Email ID
stringcontent - Content of the email
stringcontentRaw - Content Raw of the email
stringaddress - Address
stringcity - City
stringstate - State
stringzip - Zip
stringintlAddress - Intl Address
stringisIntl - Is Intl
stringtextVersion - Text Version
stringtemplateID - Template ID
stringsenderName - Sender Name
stringreplyEmail - Reply Email
stringsubject - Subject
stringlistIDs - List IDs

Return Value

booleanReturns true if the event invite is saved.

method eventOrderPreview

Get the event order preview code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringorderID - The order ID

Return Value

stringReturns the event order

method eventPostComment

Post the event comment

Parameters

stringtoken - token
stringEventID - Event ID
stringAccountType - Account Type
stringParentPostID - Parent Post ID
stringPostID - Post ID
stringMessage - Message to post
stringProfileID - Profile ID
stringProfileName - Profile Name
stringProfileImage - Profile Image

Return Value

Returns posted comment ID

method eventPostGoing

Post the Event Going Detail

Parameters

stringtoken - token
stringEventID - Event ID
stringAccountType - Account Type
stringProfileID - Profile ID
stringProfileName - Profile Name
stringProfileImage - Profile Image

Return Value

Returns posted comment ID

method eventRefund

Set the event refund

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringorderID - The order ID

Return Value

stringRefunds the event order

method eventResendTicket

Resend event Ticket

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringorderID - The order ID

Return Value

stringResend event Ticket

method eventSetAttendeeDetails

Update the given details for the attendee

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The ID of the event
stringorderID - The ID of the order
stringticketID - The ID of the ticket
structattendeeDetail - The details of the attendee

Return Value

booleanReturns the details for the contact

method eventSetAttendeesCheckIn

Set the Event Attendees CheckIn

Parameters

stringtoken - Your Benchmark Email Token
stringticketitemid - The Event Ticket Item ID
integerstatus - The Event Attendees status
integerquantity - The Event Attendees quantity
stringfilter - The Event Attendees filter
stringfilterdetail - The Event Attendees filterdetail

Return Value

stringReturns the event checkin count

method eventSetDataReport

Set the event data report

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringdateID - The Date ID
stringStatus - The Data Report Status
stringEmail - The Email

Return Value

integerSet the event data report

method eventSetFBToken

Set the FB Token

Parameters

stringtoken - Your Benchmark Email Token
stringTokenSecret - The FB TokenSecret
stringSN - The FB ScreenName
stringPageID - The FB Page ID
stringAppMasterID - The App Master ID
stringEventID - The Event ID
stringProfileID - The FB Profile ID

Return Value

integerSet the FB Token

method eventSetFeedback

Set the event feedback

Parameters

stringeventID - The event ID
stringClientID - The client ID
stringname - The senders name
stringemail - The senders email
stringmessage - The senders message

Return Value

stringReturns true

method eventSetShare

Set the event Share

Parameters

stringeventID - The event ID
stringClientID - The client ID
stringname - The senders name
stringemail - The senders email
stringmessage - The senders message
stringsubject - The senders subject
stringtoemail - The receivers email

Return Value

stringReturns true

method eventTemplateCategoryGetList

Get the list of event template category

Parameters

stringtoken - Your Benchmark Email Token
stringlang - Language

Return Value

stringReturns the event template category.

method eventTemplateGetEmailList

Get the list of event email templates

Parameters

stringtoken - Your Benchmark Email Token
stringcategoryID - The Category ID
stringfilter - Filter for event templates

Return Value

array of struct EventTemplateStructureReturns the event email templates.

method eventTemplateGetList

Get the list of event templates

Parameters

stringtoken - Your Benchmark Email Token
stringcategoryID - The Category ID
stringfilter - Filter for event templates
stringlang - Language for event templates

Return Value

array of struct EventTemplateStructureReturns the event templates.

method eventTicketItemRefund

Set the event Ticket Item refund

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringticketitemID - The Ticket Item ID

Return Value

stringRefunds the event Ticket Item

method eventTicketPreview

Get the event order preview code

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringorderID - The order ID
stringticketID - The ticket ID

Return Value

stringReturns the event ticket

method eventUpdateEventGoogleMerchant

Update the Google Merchant

Parameters

stringtoken - Your Benchmark Email Token
stringGoogleMID - The Google Merchant ID
stringGoogleMKEY - The Google Merchant KEY
stringOldGoogleMID - The Google Old Merchant ID
stringOldGoogleMKEY - The Google Old Merchant KEY

Return Value

integerReturns the Google Merchant updated or not

method eventUpdateFBEvent

Post the event on Facebook

Parameters

stringtoken - token
stringEventID - Event ID
stringStartTime - Event StartTime
stringLocation - Event Location
stringDescription - Event description
stringProfileID - FB Profile ID

Return Value

integerReturns posted Event ID

method eventUpdatePage

Update the page for the event

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringtemplateID - The Template ID
stringcontent - Content of the page
stringcss - CSS If Custom
stringcsscode - CSS Json If Custom

Return Value

booleanReturns true if the event page is saved.

method eventUpdatePaypalEmail

Update the Paypal Email

Parameters

stringtoken - Your Benchmark Email Token
stringEmailID - The Email ID
stringOldEmailID - The Old Email ID

Return Value

integerReturns the Paypal Email updated or not

method eventUpdatePayStatus

Set the Event Order Pay Status

Parameters

stringtoken - Your Benchmark Email Token
stringEventID - The Event ID
stringorderid - The Event Order ID
integerstatus - The Event Order Pay status

Return Value

stringReturns the Pay status updated or not

method eventUpdateShareEvent

Set the event share category

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringbmeCategoryID - The BME Directory Category ID
stringamericaCategoryID - The America Directory Category ID
stringamericaSubcategoryID - The America Directory Subcategory ID

Return Value

stringEvent category updated

method eventUpdateTicketItemPayStatus

Set the Event Ticket Item Pay Status

Parameters

stringtoken - Your Benchmark Email Token
stringEventID - The Event ID
stringTicketItemID - The Event Ticket Item ID
integerstatus - The Event Order Pay status

Return Value

stringReturns the Pay status updated or not

method eventUpdateUrl

Update the event Url

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringEventURL - The Event URL

Return Value

booleanReturns the event Url

method eventValidatePayPalEmail

Validate the PayPal Email

Parameters

stringtoken - token
stringEmail - Email

Return Value

stringReturns Email valid or not

method facebookForm

Get the signup form for the Facebook user's ID.

Parameters

stringfacebookID - The facebook page ID

Return Value

stringReturns the code for the signup form.

method facebookFormAdmin

Get the configuration for the facebook form.

Parameters

stringfacebookID - The facebook page ID

Return Value

struct FacebookFormStructureReturns the configuration for the signup form.

method facebookFormSave

Save the signup form for the Facebook user's ID.

Parameters

stringfacebookID - The facebook page ID
struct FacebookFormSavefields - The facebook page ID

Return Value

stringReturns the code for the signup form.

method facebookFormUser

Update the user for the facebook form.

Parameters

stringtoken - Your Benchmark Email Token
stringfacebookID - The facebook page ID

Return Value

booleanReturns true if the assignment is successful.

method facebookFormUserRemove

Remove the user for the facebook form.

Parameters

stringfacebookID - The facebook page ID

Return Value

booleanReturns true if the disassociation is successful.

method facebookSetForm

Update the signup form for the facebook page.

Parameters

stringtoken - Your Benchmark Email Token
stringfacebookID - The facebook page ID
stringsignupFormID - The signup Form ID

Return Value

booleanReturns true if the assignment is successful.

method fileAdd

Add a file for the user

Parameters

stringtoken - The token you want to add
struct FileDatafileData - Binary File Data

Return Value

booleanReturns true

method fileGet

Get details for a file

Parameters

stringtoken - The token you want to add
stringfileID - The file ID

Return Value

struct FileDataReturns File data

method fileGetSearchResult

Get the list of Files in the client's Document Library

Parameters

stringtoken - Your Benchmark Email Token
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringfilter - The filter
stringorderBy - The column to order by
stringsortOrder - The sort order

Return Value

array of struct FileDataReturns the list of files.

method getLogin

Get Login Of the token.

Parameters

stringtoken - Your Benchmark Email Token

Return Value

stringReturns the Login of the token.

method getUserManagementHistory

Get the list of emails using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringhistory_id - The filter you want to apply when fetching the emails
stringstart_date - The filter you want to apply when fetching the emails
stringend_date - The filter you want to apply when fetching the emails

Return Value

array of struct UserManagementHistoryStructureReturns the list of emails.

method imageAdd

Add a image for the user

Parameters

stringtoken - The token you want to add
struct ImageDataimgdata - Binary Image Data

Return Value

booleanReturns true

method imageAddFromURL

Add an Image from URL to the client's account

Parameters

stringtoken - Your Benchmark Email Token
stringImageName - The Name of the Image
stringImageURL - The URL of the Image

Return Value

booleanReturns true if image has been added or else throws an exception

method imageDelete

Delete an Image from the client's account

Parameters

stringtoken - Your Benchmark Email Token
stringImageID - The ID of the Image

Return Value

booleanReturns true if image has been deleted or else throws an exception

method imageGet

Get details for an image

Parameters

stringtoken - The token you want to add
stringimageID - The image ID

Return Value

struct ImageDataReturns Image data

method imageGetCount

Get the count of images in the client's Image Gallery

Parameters

stringtoken - Your Benchmark Email Token

Return Value

integerReturns the count of Images.

method imageGetFlickrResult

Get the list of Images in the client's Flickr Image Gallery

Parameters

stringtoken - Your Benchmark Email Token
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringfilter - The filter
stringorderBy - The column to order by
stringsortOrder - The sort order

Return Value

array of struct ImageStructureReturns the list of Images.

method imageGetList

Get the list of Images in the client's Image Gallery

Parameters

stringtoken - Your Benchmark Email Token
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct ImageStructureReturns the list of Images.

method imageGetSearchResult

Get the list of Images in the client's Image Gallery

Parameters

stringtoken - Your Benchmark Email Token
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringfilter - The filter
stringorderBy - The column to order by
stringsortOrder - The sort order

Return Value

array of struct ImageStructureReturns the list of Images.

method imageUpdate

Update an Image from the client's account

Parameters

stringtoken - Your Benchmark Email Token
stringImageID - The ID of the Image
stringImageURL - The URL of the Image

Return Value

booleanReturns true if image has been update or else throws an exception

method imageUpdateName

Update an Image Name from the client's account

Parameters

stringtoken - Your Benchmark Email Token
stringImageID - The ID of the Image
stringImageName - The Name of the Image

Return Value

struct GenericResponseStructureReturns true if image name has been update or else throws an exception

method InboxGet

Get the list of test using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the test
stringfilterType - The filter type you want to apply when fetching the tests
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct InboxStructureReturns the list of tests

method listAddContacts

Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information

Return Value

integerReturns the number of successfully added contacts.

method listAddContactsForm

Add the contact details to the given contact list using an existing signup form.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - The ID of the signup form you want to use
structcontactDetails - The array containing the contact information

Return Value

integerReturns the number of successfully added contacts.

method listAddContactsOptin

Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information
stringuseDoubleOptin - Use Double Optin

Return Value

integerReturns the number of successfully added contacts.

method listAddContactsOptinRetID

Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information
stringuseDoubleOptin - Use Double Optin

Return Value

array of struct ContactStructureReturns the number of successfully added contacts.

method listAddContactsRetID

Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information

Return Value

array of struct ContactStructureReturns the ID of added contacts.

method listAddSingleContact

Add the contact details to the given contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of structcontactDetails - The array containing the contact information
stringuseDoubleOptin - Use Double Optin

Return Value

stringReturns the number of successfully added contacts.

method listCreate

Create a new contact list with the given name. Returns the ID of the newly created list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistname - The name of the new contact list

Return Value

stringReturns the ID of the newly created contact list.

method listCreateLang

Create a new contact list with the given name. Returns the ID of the newly created list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistname - The name of the new contact list
stringlanguage - The language for the list

Return Value

stringReturns the ID of the newly created contact list.

method listDelete

Delete an exising contact list with the given ID.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the contact list

Return Value

booleanReturns true on success.

method listDeleteContacts

Delete contacts from the given contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
stringcontacts - The contact ids (comma seperated) to delete

Return Value

booleanReturns true in case contacts were deleted.

method listDeleteEmailContact

Delete a contact which matches the email from the given contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
stringemail - The email to delete

Return Value

booleanReturns true in case contact were deleted.

method listGet

Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the contact lists
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ContactListStructureReturns the list of contact lists.

method listgetall

Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the contact lists
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ContactListStructureReturns the list of contact lists.

method listGetByStatus

Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the contact lists
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)
stringstatus - The status

Return Value

array of struct ContactListStructureReturns the list of contact lists.

method listGetContactDetails

Get the contact details from the contact list for the given email address.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringemail - The email of the contact for whom you want the details

Return Value

structReturns the details for the contact

method listGetContactFields

Get the contact fields from the contact list for the given email address.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from

Return Value

structReturns the details for the contact

method listGetContactFieldsHTMLSafe

Get the contact fields from the contact list for the given email address.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from

Return Value

structReturns the details for the contact

method listGetContacts

Get the contacts from the contact list

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringfilter - The filter you want to apply when fetching the contacts
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ContactStructureReturns the number of successfully added contacts.

method listGetContactsAllFields

Get the contacts from the contact list

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringfilter - The filter you want to apply when fetching the contacts
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of structReturns the number of successfully added contacts.

method listGetContactsByType

Get the contacts from the contact list

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringfilter - The filter you want to apply when fetching the contacts
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)
stringType - The Type of the Contacts required ie Optin,NotOptedIn,ConfirmedBounces,Active,Unsubscribe

Return Value

array of struct ContactStructureReturns the number of successfully added contacts.

method listGetContactsCount

Get the count of the contacts from the contact list

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringfilter - The filter you want to apply when fetching the contacts

Return Value

doubleReturns the number of contacts.

method listGetCount

Get the count of contact lists using the filter and paging limits, order by the name or date of the contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the contact lists

Return Value

doubleReturns the number of contact lists.

method listGetSignupForms

Get the existing signup forms

Parameters

stringtoken - Your Benchmark Email Token
integerpageNumber - The page number from which you want the signup forms
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (name / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct SignupFormStructureReturns the number of successfully added contacts.

method listSearchContacts

Search contacts

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - email ID which you want to search

Return Value

array of struct ContactListStructureReturns ContactList details for this emailID if it is present in any contactList else return message.

method listUnsubscribeContacts

Unsubscribe the contacts from the given contact list.

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to add to
array of stringcontacts - The array containing the contact information

Return Value

integerReturns the number of contacts left in the list.

method listUpdate

Update the contact list with the given name & description

Parameters

stringtoken - Your Benchmark Email Token
stringlistid - The ID for the contact list
stringlistname - The name for the contact list
stringlistdescription - The description for the contact list

Return Value

booleanReturns true if the update is done.

method listUpdateContactDetails

Update the given contact in the list based on the details provided

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
stringcontactID - The ID of the contact which you want to edit
structcontactDetail - The details of the contact

Return Value

structReturns the details for the contact

method ListUpdateContactDetailsByEmail

Update the given contact in the list based on the details provided

Parameters

stringtoken - Your Benchmark Email Token
stringlistID - The ID of the list you want to fetch the contacts from
structcontactDetail - The details of the contact

Return Value

structReturns the details for the contact

method logApp

Log App

Parameters

stringtoken - Your Benchmark Email Token
stringfilterType - App type

Return Value

booleanReturns true

method login

Authenticate the user and returns a token.

Parameters

stringusername - Your Benchmark Email user name
stringpassword - Your Benchmark Email password

Return Value

stringReturns the token to be used in subsequent API calls.

method logindevice

Authenticate the user and returns a token.

Parameters

stringusername - Your Benchmark Email user name
stringpassword - Your Benchmark Email password
stringdevicename - Device used for accessing api

Return Value

stringReturns the token to be used in subsequent API calls.

method planGetList

Get Plans

Parameters

stringtoken - Your Benchmark Email Token

Return Value

array of struct PlanDetailStructurereturns Plans Info

method planUpgrade

Upgrade to IPhone Premium Plan

Parameters

stringtoken - Your Benchmark Email Token
stringplanToken - Plan Token

Return Value

integerreturns Flag

method pollCopy

Copy an existing Poll to new Poll

Parameters

stringtoken - Your Benchmark Email Token
stringPollID - ID of the existing poll
stringNewPollName - Name of the new Poll

Return Value

stringReturns the id of newly created Poll.

method pollCreate

Create a new Poll based on the details provided. Return the ID of the newly created Poll.

Parameters

stringtoken - Your Benchmark Email Token
struct PollStructurepoll - The details for the poll

Return Value

stringReturns the ID of the newly created poll.

method pollDelete

Delete an existing Poll based on the details provided.

Parameters

stringtoken - Your Benchmark Email Token
stringPollID - The pollid for the poll

Return Value

stringReturns the ID of the deleted poll.

method pollGetList

Get the list of Polls using the filter and paging limits, order by the name or date of the polls.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the polls
stringstatus - The status of the poll
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct PollStructureReturns the list of polls.

method pollReportList

Get the report of Poll.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the Poll Report
stringstatus - The status of the poll
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct PollStructureReturns the list of Polls.

method pollResponseReport

Get the list of Poll Options with their responses

Parameters

stringtoken - Your Benchmark Email Token
stringPollID - The poll id of the poll

Return Value

array of struct PollStructureReturns the list of poll.

method pollStatusUpdate

Update Poll Status based on the details provided. Return 1 if the poll is updated else 0.

Parameters

stringtoken - Your Benchmark Email Token
stringPollID - The PollId of the Survey
stringStatus - Status for the Poll

Return Value

integerReturns 1 if the poll is updated else 0

method pollUpdate

Update an existing Poll based on the details provided. Return the ID of the updated Poll.

Parameters

stringtoken - Your Benchmark Email Token
stringPollID - The ID for the poll to update
struct PollStructurepoll - The details for the poll

Return Value

stringReturns the ID of the updated poll.

method register

Register a new client

Parameters

struct ClientMasterStructureclientstruct - The structure containing the client information

Return Value

integerReturns 1 if the register action was successful and -1 if it was not

method reportCompare

Get the summary for multiple campaigns

Parameters

stringtoken - Your Benchmark Email Token
stringemailIDs - The email IDs for which the comparison is required

Return Value

array of struct ReportSummaryStructureReturns the summary record for mulitple campaigns.

method reportGet

Get the list of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the results
integerpageNumber - The page number from which you want the results
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EmailStructureReturns true.

method reportGetBounces

Get the emails which bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record.

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringFilter - Either requires Hard or soft Bounce
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportBounceStructureReturns the bounce details for the campaign.

method reportGetClickEmails

Get the Emails of the receipients clicking on URLs for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
stringClickURL - The ClickeUrl for the email
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportDataStructureReturns the click emails details for the campaign.

method reportGetClicks

Get the click URL stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required

Return Value

array of struct ReportClickStructureReturns the click URL details for the campaign.

method reportGetCount

Get the count of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the results

Return Value

doubleReturns number of campaigns.

method reportGetEmailByDate

Return Emails

Parameters

stringtoken - Your Benchmark Email Token
stringtype - Opens | Clicks | Bounces
stringfilterdate - The date filter
stringsubaccountlogin - Login of sub account
stringPageNumber - The page number from which you want the list
stringPageSize - The number of results per page

Return Value

array of struct ReportEmailGetStructureReturns the list of contact lists.

method reportGetEmailByDateCount

Get the count of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.

Parameters

stringtoken - Your Benchmark Email Token
stringtype - Opens | Clicks | Bounces
stringfilterdate - The date filter
stringsubaccountlogin - Login of sub account

Return Value

doubleReturns number of campaigns.

method reportGetEmailLinks

Get the link URL for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required

Return Value

array of struct EmailLinkStructureReturns the link URLS for the campaign.

method reportGetForwards

Get the Forward stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportDataStructureReturns the forwards details for the campaign.

method reportGetHardBounces

Get the Hard Bounce stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportBounceStructureReturns the Hard Bounce details for the campaign.

method reportGetOpenCountry

Get the Countrywise open stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required

Return Value

array of struct ReportCountryOpenStructReturns the open details for the campaign.

method reportGetOpenForCountry

Get the statewise open stats for a campaign in a country

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
stringCountryCode - The country code

Return Value

array of struct ReportCountryOpenStructReturns the open details for the campaign.

method reportGetOpens

Get the Open stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportDataStructureReturns the open details for the campaign.

method reportGetSoftBounces

Get the Soft Bounce stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportBounceStructureReturns the Soft Bounce details for the campaign.

method reportGetSummary

Get the summary for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The email ID for which the summary is required

Return Value

struct ReportSummaryStructureReturns the summary record for the campaign.

method reportGetUnopens

Get the Open stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportDataStructureReturns the open details for the campaign.

method reportGetUnsubscribes

Get the Unsubscribe stats for a campaign

Parameters

stringtoken - Your Benchmark Email Token
stringemailID - The Email ID for which the report is required
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportDataStructureReturns the Unsubscribe details for the campaign.

method segmentCreate

Create a new segment based on the details provided. Return the ID of the newly created segment.

Parameters

stringtoken - Your Benchmark Email Token
struct SegmentStructuresegment - The details for the email

Return Value

stringReturns the ID of the newly created segment.

method segmentCreateCriteria

Create a new criteria for the segment. Return the ID of the newly created criteria segment.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The ID of the segment you want to add the criteria to
struct SegmentCriteriaStructurecriteria - The details for the criteria

Return Value

stringReturns the ID of the newly created criteria

method segmentDelete

Delete a segment.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The id of the segment to delete

Return Value

booleanReturns true on success

method segmentDeleteCriteria

Delete a criteria for the segment. Return true if the criteria is deleted.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The ID of the segment you want to add the criteria to
stringcriteriaID - The ID of the criteria

Return Value

booleanReturns true if the criteria is deleted

method segmentGet

Get the list of segments using the filter and paging limits, order by the name or date of the segments.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the segments
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)

Return Value

array of struct SegmentListStructureReturns the list of segments.

method segmentGetContacts

Get contacts of a segment.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The id of the segment
stringfilter - The filter you want to apply when fetching the contacts
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (email / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ContactStructureReturns contacts of the segment

method segmentGetCount

Get the count of segments.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the segments

Return Value

doubleReturns the number of segments

method segmentGetCriteriaList

Get the list of criteria of a segment.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The id of the segment

Return Value

array of struct SegmentCriteriaStructureReturns criteria of the segment

method segmentGetDetail

Get details for a segment. Returns the segment details.

Parameters

stringtoken - Your Benchmark Email Token
stringsegmentID - The segment ID

Return Value

struct SegmentStructureReturns the segment details.

method signupFormCreate

Create a new signup form based on the details provided. Return the ID of the newly created signup form.

Parameters

stringtoken - Your Benchmark Email Token
struct SignupFormDataStructuresignupForm - The details for the signup form

Return Value

stringReturns the ID of the newly created signup form.

method signupFormDelete

Delete the signup form based on the details provided.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - The signup form ID

Return Value

booleanReturns the Code for the signup form.

method signupFormGet

Get the details for the signup form based on the ID provided.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - The details for the email

Return Value

struct SignupFormDataStructureReturns the structure of the given signup form ID.

method signupFormGetCode

Get the code for the signup form based on the details provided.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - The signup form ID
stringcodeType - Type of Code

Return Value

stringReturns the Code for the signup form.

method signupFormUpdate

Update the new signup form based on the details provided. Return the true if the changes were commited.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - Your Signup Form ID
struct SignupFormDataStructuresignupForm - The details for the email

Return Value

booleanReturns true if the changes were saved to the signup form.

method signupFormUpdateColor

Update the colors in the signup form based on the details provided. Return the true if the changes were commited.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - Your Signup Form ID
struct SignupFormColorStructuresignupForm - The details for the signup form

Return Value

booleanReturns true if the changes were saved to the signup form.

method signupFormUpdateMessage

Update the signup form's from email and welcome message based on the details provided. Return the true if the changes were commited.

Parameters

stringtoken - Your Benchmark Email Token
stringsignupFormID - Your Signup Form ID
struct SignupFormDataStructuresignupForm - The details for the email

Return Value

booleanReturns true if the changes were saved to the signup form.

method socialCampaignCreatetab

Create social campaign tab

Parameters

stringtoken - Your Benchmark Email Token
stringPageID - The page ID
stringPageAccess - The page token
stringPageName - The page Name

Return Value

integerReturns the tab created or not

method socialCampaignDeleteTab

Remove the social campaign tab

Parameters

stringtoken - Your Benchmark Email Token
stringTabID - The Tab ID

Return Value

integerReturns the tab removed or not

method socialCampaignEditPageContent

Edit the social campaign tab Name

Parameters

stringtoken - Your Benchmark Email Token
stringTabID - The Tab ID
stringPageContent - The Page Content

Return Value

integerReturns the tab edited or not

method socialCampaignEditTabName

Edit the social campaign tab Name

Parameters

stringtoken - Your Benchmark Email Token
stringTabName - The Tab name you want to apply to the tab
stringTabID - The Tab ID

Return Value

integerReturns the tab edited or not

method socialCampaignGetPage

Get the social campaign page

Parameters

stringfacebookID - The facebook page ID
stringappID - The app ID
struct FacebookFormSavedata - The User Has clicked on Like

Return Value

stringReturns the code for the page.

method SocialCampaignGetPagesTabs

Returns the Social Pages & Tab

Parameters

stringtoken - Your Benchmark Email Token

Return Value

struct SocialTemplateStructureReturns the Social Pages & Tabs

method socialCampaignGetTabs

Get the social campaign tabs

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the tabs
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order
stringsortOrder - The sort order (asc / desc)

Return Value

stringReturns the Socail tabs list

method socialCampaignGetTemplate

Get the social campaign template with theme

Parameters

stringtoken - Your Benchmark Email Token
stringtemplateid - social template id
stringthemeid - social theme id

Return Value

struct SocialTemplateStructureReturns the Socail tabs list

method socialCampaignGetTheme

Get the social campaign theme

Parameters

stringtoken - Your Benchmark Email Token
stringthemeid - social theme id

Return Value

struct SocialThemeStructureReturns the Socail tabs list

method socialCampaignMoveTabToOtherPage

Edit the social campaign tab Name

Parameters

stringtoken - Your Benchmark Email Token
stringTabID - The Tab ID
stringNewPageID - The New page ID where want to copy the tab
stringNewPageAccessToken - The New page token
stringNewPageName - The New page Name

Return Value

integerReturns the tab edited or not

method socialCampaignReInstallTab

Reinstall the social campaign tab

Parameters

stringtoken - Your Benchmark Email Token
stringTabID - The Tab ID

Return Value

integerReturns the tab install or not

method socialInvitesGet

Get the list of Invites using the filter and paging limits, order by the name or date of the email.

Parameters

stringtoken - Your Benchmark Email Token
stringtabid - Your Tab ID
stringfilter - The filter you want to apply when fetching the emails
stringstatus - The status of the email
stringpagenumber - The page number from which you want the list
stringpagesize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

struct SocialTemplateStructureReturns the list of emails.

method subAccountCreate

Register a new SubAccount

Parameters

stringtoken - Your Benchmark Email Token
struct AccountStructureaccountstruct - The structure containing the client account information

Return Value

integerReturns 1 if the register action was successful and -1 if it was not

method subAccountGetList

Get the list of SubAccounts

Parameters

stringtoken - Your Benchmark Email Token

Return Value

array of struct AccountStructureReturns the list of SubAccounts.

method subAccountUpdate

Update SubAccount details

Parameters

stringtoken - Your Benchmark Email Token
struct AccountStructureaccountstruct - The structure containing the client account information

Return Value

integerReturns 1 if the update SubAccount action was successful and -1 if it was not

method subAccountUpdateStatus

Update SubAccount status

Parameters

stringtoken - Your Benchmark Email Token
stringID - Your SubAccount ID
stringstatus - Status of the Account

Return Value

voidReturn Update Status

method surveyColorUpdate

Update Survey Color based on the details provided. Return the ID of the Survey.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - Survey ID of the survey
struct SurveyColorStructuresurveyColor - The details for the SurveyColor

Return Value

stringReturns the ID of the Survey.

method surveyCopy

Copy an existing survey to new Survey

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - ID of the existing survey
stringNewSurveyName - Name of the new Survey

Return Value

stringReturns the id of newly created Survey.

method surveyCopyTemplate

Copy an existing survey Template to new Survey

Parameters

stringtoken - Your Benchmark Email Token
stringTemplateID - ID of the existing survey
stringNewSurveyName - Name of the new Survey

Return Value

stringReturns the id of newly created Survey.

method surveyCreate

Create a new Survey based on the details provided. Return the ID of the newly created Survey.

Parameters

stringtoken - Your Benchmark Email Token
struct SurveyStructuresurvey - The details for the Survey

Return Value

stringReturns the ID of the newly created Survey.

method surveyDelete

Delete an existing Survey based on the information provided.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - ID of the survey which is to be deleted

Return Value

stringReturns the ID of deleted Survey.

method surveyGetColor

Get the Colors and font styles of the survey

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - The survey id of the survey

Return Value

struct SurveyColorStructureReturns the Colors of the survey

method surveyGetList

Get the list of Surveys using the filter and paging limits, order by the name or date of the surveys.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the survey
stringstatus - The status of the survey
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct SurveyStructureReturns the list of surveys.

method surveyGetQuestionList

Get the list of Survey Questions

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - The survey id of the survey

Return Value

array of struct SurveyQuestionStructureReturns the list of surveys.

method surveyQuestionCreate

Create a new Survey Question based on the details provided. Return the ID of the newly created Survey Question.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - ID of the survey for which you want to create questions
struct SurveyQuestionStructuresurveyquestion - The details for the Survey Question

Return Value

stringReturns the ID of the newly created Survey Question.

method surveyQuestionDelete

Delete an existing Survey Question based on the information provided.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - ID of the survey of which question is to be deleted
stringQuestionID - ID of the survey question which is to be deleted

Return Value

stringReturns the ID of deleted Survey Question.

method surveyQuestionUpdate

Update Survey Question based on the details provided. Return the ID of the updated Survey.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - Your Benchmark Email Token
struct SurveyQuestionStructuresurveyquestion - The details for the Survey

Return Value

stringReturns the ID of the updated Survey Question.

method surveyReportList

Get the report of Survey.

Parameters

stringtoken - Your Benchmark Email Token
stringfilter - The filter you want to apply when fetching the survey Report
stringstatus - The status of the survey
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page
stringorderBy - The field you want to order by (list / date)
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct ReportSurveyStructureReturns the list of surveys.

method surveyResponseReport

Get the list of Survey Questions with answers and there responses

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - The survey id of the survey

Return Value

array of struct SurveyQuestionStructureReturns the list of surveys.

method surveyStatusUpdate

Update Survey Status based on the details provided. Return the ID of the updated Survey.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - The SurveyId of the Survey
stringStatus - Status for the Survey

Return Value

integerReturns 1 if the survey is updated else 0

method surveyTemplateGetList

Get the list of survey templates

Parameters

stringtoken - Your Benchmark Email Token

Return Value

array of struct SurveyTemplateStructureReturns the list of survey templates.

method surveyUpdate

Create a new Survey based on the details provided. Return the ID of the newly created Survey.

Parameters

stringtoken - Your Benchmark Email Token
stringSurveyID - The ID of the survey which you want to Update
struct SurveyStructuresurvey - The details for the Survey

Return Value

stringReturns the ID of the newly created Survey.

method ticketGetByID

Get the event Ticket

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The Event ID
stringticketID - The Ticket ID

Return Value

array of struct EventTicketItemStructureReturns the event ticket

method ticketGetList

Get the event Ticket List for check in

Parameters

stringtoken - Your Benchmark Email Token
stringeventID - The event ID
stringfiltertype - The filter you want to apply when fetching the events
stringdateID - The date ID
stringfilterdetail - The filter detail you want to apply when fetching the events
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringorderBy - The field you want to order
stringsortOrder - The sort order (asc / desc)

Return Value

array of struct EventTicketListStructureReturns the event Ticket List

method tokenAdd

Add a token for the user

Parameters

stringusername - Your Benchmark Email user name
stringpassword - Your Benchmark Email password
stringtoken - The token you want to add

Return Value

booleanReturns true

method tokenDelete

Delete an existing token for the user

Parameters

stringusername - Your Benchmark Email user name
stringpassword - Your Benchmark Email password
stringtoken - The token you want to delete

Return Value

booleanReturns true

method tokenGet

Fetch All tokens for the user

Parameters

stringusername - Your Benchmark Email user name
stringpassword - Your Benchmark Email password

Return Value

array of stringReturns the tokens which are active for the user.

method UpdatePartner

Update Vendor as Partner

Parameters

stringtoken - Your Benchmark Email Token
stringVendorLogin - Login of the Vendor

Return Value

stringreturns Success or Failure

method videoAddYouTube

Add a video to youtube and then to the video gallery for the user

Parameters

stringtoken - Your Benchmark Email Token
stringTitle - Video Title
stringDescription - Video Description
stringCategory - Video Category
stringVideoData - Binary Video Data

Return Value

stringReturns true

method videoCreate

Add the Video

Parameters

stringtoken - Your Benchmark Email Token
struct VideoGalleryStructurevideoStructure - Details for the video

Return Value

booleanReturns true if the video is embeded else false

method videoDelete

Delete an existing Video based on the details provided.

Parameters

stringtoken - Your Benchmark Email Token
stringVideoID - The Video ID for the video

Return Value

stringReturns the ID of the deleted video.

method videoGet

Get details for an video

Parameters

stringtoken - Your Benchmark Email Token
stringvideoID - The video ID

Return Value

struct VideoGalleryStructureReturns video data

method videoGetCount

Get the count of videos in the account

Parameters

stringtoken - Your Benchmark Email Token

Return Value

integerReturns the number of videos in the account

method videoGetList

Get all the videos of the current client list.

Parameters

stringtoken - Your Benchmark Email Token
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct VideoGalleryStructureReturns the Details of all the available videos.

method videoGetSearchResult

Get the list of videos in the client's Image Gallery

Parameters

stringtoken - Your Benchmark Email Token
stringpageNumber - The page number from which you want the list
stringpageSize - The number of results per page
stringfilter - The filter
stringorderBy - The column to order by
stringsortOrder - The sort order

Return Value

array of struct VideoGalleryStructureReturns the list of videos.

method videoUpdateName

Update a Video Name from the client's account

Parameters

stringtoken - Your Benchmark Email Token
stringVideoID - The ID of the Image
stringVideoName - The Name of the Image

Return Value

struct GenericResponseStructureReturns true if video name has been update or else throws an exception

method webhookCreate

Create a new Webhook for the contact list. Return the ID of the newly created Webhook.

Parameters

stringtoken - Your Benchmark Email Token
struct WebhookStructureWebhook - The details for the webhook

Return Value

stringReturn the ID of the newly created Webhook.

method webhookDelete

Delete the Webhook for given ID. Returns true if the webhook was deleted.

Parameters

stringtoken - Your Benchmark Email Token
stringwebhookID - The Email ID you want to delete

Return Value

booleanReturns true.

method webhookGet

Get the list of webhook.

Parameters

stringtoken - Your Benchmark Email Token
stringContactListID - List ID

Return Value

array of struct WebhookStructureReturns the list of webhooks.

method webhookUpdate

Update a existing Webhook for the contact list. Return the status of Webhook Update.

Parameters

stringtoken - Your Benchmark Email Token
struct WebhookStructureWebhook - The details for the webhook

Return Value

stringReturns true.

method whitelabelCheckDomain

Check if the domain name is used for the white label site

Parameters

stringid - The ID of the whitelabel site
stringdomainName - The domain name

Return Value

booleanReturns true if the domain name is not used.

method ytGetProfile

Get User Profile

Parameters

stringtoken - Google Token

Return Value

stringreturns User Profile

method ytGetToken

Get Authorization Token

Parameters

stringemail - Google Email
stringpassword - Google Password

Return Value

stringreturns Authorization Token

method ytGetVideos

Get User Videos

Parameters

stringtoken - Google Token
stringusername - Youtube username
integerpageNumber - The page number from which you want the list
integerpageSize - The number of results per page

Return Value

array of struct YouTubeVideoStructurereturns User Videos

struct EmailStructure

Members

integersequence (optional)
stringid (optional)
stringemailName (optional)
stringsubject (optional)
stringfromName (optional)
stringfromEmail (optional)
stringreplyEmail (optional)
stringlanguage (optional)
booleanisSegment (optional)
integertoListID (optional)
stringtoListName (optional)
stringstatus (optional)
stringtemplateContent (optional)
stringtemplateText (optional)
stringus_address (optional)
stringus_city (optional)
stringus_state (optional)
stringus_zip (optional)
stringpermissionReminderMessage (optional)
stringgoogleAnalyticsCampaign (optional)
booleanwebpageVersion (optional)
stringversion (optional)
stringintl_address (optional)
stringscheduleDate (optional)
stringzone (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringrssurl (optional)
stringrssinterval (optional)
stringrssactive (optional)
stringlistcount (optional)
stringcommunityurl (optional)
stringisfavorite (optional)
stringencToken (optional)
stringtemplateID (optional)
stringshareURL (optional)
stringeventName (optional)
stringisABSplit (optional)
stringisResend (optional)

struct AbTestStructure

Members

integersequence (optional)
stringid (optional)
stringemailName (optional)
stringabtestName (optional)
stringabtestType (optional)
booleanisSegment (optional)
integertoListID (optional)
stringtoListName (optional)
stringstatus (optional)
stringtemplateContent (optional)
stringtemplateText (optional)
stringus_address (optional)
stringus_city (optional)
stringus_state (optional)
stringus_zip (optional)
stringpermissionReminderMessage (optional)
stringgoogleAnalyticsCampaign (optional)
booleanwebpageVersion (optional)
stringversion (optional)
stringintl_address (optional)
stringscheduleDate (optional)
stringzone (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringrssurl (optional)
stringrssinterval (optional)
stringrssactive (optional)
stringlistcount (optional)
stringcommunityurl (optional)
stringisfavorite (optional)
stringencToken (optional)
stringtemplateID (optional)
stringshareURL (optional)
stringstartDate (optional)
stringwinDate (optional)
stringeditUrl (optional)
stringabstatus (optional)

struct AutoResponderDataStructure

Members

stringautoresponderName (optional)
stringcontactListID (optional)
stringfromName (optional)
stringfromEmail (optional)
booleanpermissionReminder (optional)
stringpermissionReminderMessage (optional)
booleanwebpageVersion (optional)
booleanisSegment (optional)

struct AutoResponderDetailDataStructure

Members

stringsubject (optional)
stringtemplateContent (optional)
stringtemplateText (optional)
stringlanguage (optional)
stringus_address (optional)
stringus_city (optional)
stringus_state (optional)
stringus_zip (optional)
stringintl_address (optional)
stringdays (optional)
stringtype (optional)
stringwhentosend (optional)
stringfieldtocompare (optional)

struct AutoResponderDetailedStructure

Members

stringid (optional)
stringautoresponderName (optional)
stringtotalEmails (optional)
stringstatus (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringcontactListID (optional)
stringcontactListName (optional)
stringisSegment (optional)
stringfromName (optional)
stringfromEmail (optional)
stringpermissionReminderMessage (optional)
booleanwebpageVersion (optional)
array of struct AutoResponderEmailsStructureemails (optional)

struct AutoresponderStructure

Members

integersequence (optional)
stringid (optional)
stringautoresponderName (optional)
stringtotalEmails (optional)
stringstatus (optional)
stringmodifiedDate (optional)
stringencToken (optional)
stringLb_Name (optional)

struct ClientSettingsStructure

Members

stringclient_id (optional)
stringcompany (optional)
stringphone (optional)
stringaddress (optional)
stringcity (optional)
stringstate (optional)
stringzip (optional)
stringcountry (optional)
stringemail (optional)
stringfirst_name (optional)
stringlast_name (optional)

struct ClientPlanInfoStructure

Members

stringplan_id (optional)
stringplan_name (optional)
stringplan_email_limit (optional)
stringadditional_amount (optional)
stringaccount_expire (optional)
stringemail_size (optional)
stringemail_usage (optional)
stringimage_size (optional)
stringimage_usage (optional)

struct ClientMasterStructure

Members

stringfirstname (optional)
stringlastname (optional)
stringcompanyname (optional)
stringemail (optional)
stringphone (optional)
stringlogin (optional)
stringpassword (optional)
stringpromocode (optional)
stringtimezone (optional)

struct YouTubeVideoStructure

Members

stringsequence (optional)
stringVideoID (optional)
stringURL (optional)
stringImageURL (optional)
stringTitle (optional)
stringLength (optional)
stringVideoURL (optional)
stringViews (optional)

struct ConfirmEmailStructure

Members

integersequence (optional)
stringid (optional)
stringemail (optional)
stringconfirmed (optional)
stringcreateddate (optional)
stringmodifieddate (optional)

struct EmailContactStructure

Members

integersequence (optional)
stringemailID (optional)
booleanisSegment (optional)
stringtoSegmentID (optional)
stringtoListID (optional)
stringtoListName (optional)

struct EmailTemplateCategoryStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringcount (optional)
stringnewFlag (optional)

struct GenericResponseStructure

Members

integerstatus (optional)
stringmessage (optional)
stringextrainfo (optional)

struct EmailTemplateStructure

Members

integersequence (optional)
stringid (optional)
stringtemplate_name (optional)
stringtemplate_source (optional)
stringpreview_small (optional)
stringbackgroundImage (optional)
stringbackground (optional)
stringheaderImage (optional)
stringfooterImage (optional)
stringcontent (optional)

struct EmailSchemeStructure

Members

integersequence (optional)
stringschemeid (optional)
stringschemename (optional)
stringclr1 (optional)
stringclr2 (optional)
stringclr3 (optional)
stringclr4 (optional)
stringclr5 (optional)

struct EventGetStructure

Members

stringsequence (optional)
stringeventid (optional)
stringeventname (optional)
stringstatus (optional)
stringvenue (optional)
stringlocation (optional)
stringtimezone (optional)
stringrepeat (optional)
stringcontactname (optional)
stringcontactemail (optional)
stringcontactphone (optional)
stringcontactorganization (optional)
stringispublic (optional)
stringeventurl (optional)
stringmaxattendee (optional)
array of struct EventDateStructuredates (optional)
array of struct EventTicketDetailStructuretickets (optional)

struct EventStructure

Members

stringsequence (optional)
stringeventid (optional)
stringeventname (optional)
stringstatus (optional)
stringstartdate (optional)
stringenddate (optional)
stringsold (optional)
stringattendeemax (optional)
stringrepeat (optional)
stringtimezone (optional)

struct EventTicketTypeStructure

Members

integersequence (optional)
stringid (optional)
stringlabel (optional)
stringprice (optional)
stringorder (optional)
stringabsorb (optional)

struct EventTemplateStructure

Members

stringsequence (optional)
stringtemplateid (optional)
stringispopular (optional)
stringisnew (optional)
stringisused (optional)
stringname (optional)
stringimage (optional)
stringcss (optional)
stringcategoryid (optional)

struct FacebookFormStructure

Members

stringclientID (optional)
stringsignupFormID (optional)
stringclientName (optional)
stringtoken (optional)

struct FacebookFormSave

Members

stringfldEmail (optional)
stringfldfirstname (optional)
stringfldlastname (optional)
stringfldmiddlename (optional)
stringfldfield1 (optional)
stringfldfield2 (optional)
stringfldfield3 (optional)
stringfldfield4 (optional)
stringfldfield5 (optional)
stringfldfield6 (optional)
stringfldfield7 (optional)
stringfldfield8 (optional)
stringfldfield9 (optional)
stringfldfield10 (optional)
stringfldfield11 (optional)
stringfldfield12 (optional)
stringfldfield13 (optional)
stringfldfield14 (optional)
stringfldfield15 (optional)
stringfldfield16 (optional)
stringfldfield17 (optional)
stringfldfield18 (optional)
stringfldfield19 (optional)
stringfldfield20 (optional)
stringfldfield21 (optional)
stringfldfield22 (optional)
stringfldfield23 (optional)
stringfldfield24 (optional)
stringfldfield25 (optional)
stringfldfield26 (optional)
stringfldfield27 (optional)
stringtoken (optional)
stringaction (optional)

struct FileData

Members

integersequence (optional)
stringfile_id (optional)
stringfile_name (optional)
stringfile_url (optional)
stringfile_data (optional)
stringfile_size (optional)
stringfile_date (optional)

struct UserManagementHistoryStructure

Members

stringhistory_id (optional)
stringclient_id (optional)
stringplan_email_limit (optional)
stringfree_mail_sent (optional)
stringcampaigns_sent (optional)

struct ImageData

Members

stringimage_id (optional)
stringimage_name (optional)
stringimage_url (optional)
stringimage_data (optional)
stringimage_height (optional)
stringimage_width (optional)
stringimage_size (optional)

struct ImageStructure

Members

integersequence (optional)
stringid (optional)
stringclient_id (optional)
stringimage_path_virtual (optional)
stringimage_size (optional)
stringimage_h (optional)
stringimage_w (optional)
stringimage_name (optional)

struct InboxStructure

Members

integersequence (optional)
stringtestID (optional)
stringencToken (optional)
stringreportURL (optional)
stringemailName (optional)
stringemailID (optional)
stringcreatedDate (optional)
stringstatus (optional)
stringtestCount (optional)

struct ContactStructure

Members

integersequence (optional)
stringid (optional)
stringemail
stringfirstname (optional)
stringlastname (optional)
stringmiddlename (optional)
stringemailtype (optional)

struct ContactListStructure

Members

integersequence (optional)
stringid (optional)
stringlistname (optional)
integercontactcount (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringpermissionPassList (optional)
stringis_importing (optional)
stringlist_audited (optional)
stringlist_description (optional)
stringis_master_unsubscribe (optional)
stringencToken (optional)
stringallow_delete (optional)
stringlist_import_v3 (optional)
stringsegment (optional)

struct SignupFormStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringlistName (optional)
stringtoListName (optional)
stringadded (optional)
stringencToken (optional)
stringencTokenSignup (optional)

struct PlanDetailStructure

Members

integersequence (optional)
stringid (optional)
stringplan_name (optional)
stringplan_detail (optional)
stringplan_price (optional)
stringplan_limit (optional)
stringadditional (optional)

struct PollStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringquestion (optional)
stringanswer1 (optional)
stringanswer2 (optional)
stringanswer3 (optional)
stringanswer4 (optional)
stringanswer5 (optional)
stringanswer1count (optional)
stringanswer2count (optional)
stringanswer3count (optional)
stringanswer4count (optional)
stringanswer5count (optional)
stringresponses (optional)
stringstatus (optional)
stringencToken (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringquestioncolor (optional)
stringquestionfont (optional)
stringanswercolor (optional)
stringanswerfont (optional)
stringbuttontext (optional)
stringborderbg (optional)
stringformbg (optional)
stringlivedate (optional)
stringurl (optional)

struct ReportSummaryStructure

Members

stringmailSent (optional)
stringid (optional)
stringemailName (optional)
stringclicks (optional)
stringopens (optional)
stringbounces (optional)
stringabuseReports (optional)
stringunsubscribes (optional)
integertoListID (optional)
stringtoListName (optional)
stringforwards (optional)
stringscheduleDate (optional)
stringsubject (optional)
stringshareURL (optional)
stringtimezone (optional)
stringencToken (optional)

struct ReportBounceStructure

Members

stringsequence (optional)
stringemail (optional)
stringname (optional)
stringtype (optional)
stringlogdate (optional)
stringencToken (optional)

struct ReportDataStructure

Members

stringsequence (optional)
stringemail (optional)
stringname (optional)
stringlogdate (optional)
stringreason (optional)
stringencToken (optional)
stringcounts (optional)

struct ReportClickStructure

Members

stringsequence (optional)
stringURL (optional)
stringclicks (optional)
stringpercent (optional)

struct ReportEmailGetStructure

Members

stringemail (optional)
stringcampaign_id (optional)
stringlink_name (optional)
stringcampaign_name (optional)

struct EmailLinkStructure

Members

stringsequence (optional)
stringURL (optional)

struct ReportCountryOpenStruct

Members

stringsequence (optional)
stringcountry_name (optional)
stringcountry_region (optional)
stringopenCount (optional)

struct SegmentStructure

Members

integersequence (optional)
stringid (optional)
stringsegmentname (optional)
stringdescription (optional)
stringlistid (optional)
stringlistname (optional)
integercontactcount (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)

struct SegmentCriteriaStructure

Members

integersequence (optional)
stringid (optional)
stringfield (optional)
stringsegmentid (optional)
stringstartDate (optional)
stringendDate (optional)
stringfilterType (optional)
stringfilter (optional)
stringfieldType (optional)

struct SegmentListStructure

Members

integersequence (optional)
stringid (optional)
stringsegmentname (optional)
stringlistid (optional)
stringlistname (optional)
integercontactcount (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)

struct SignupFormDataStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
array of struct ContactListStructurelists (optional)
stringintroduction (optional)
stringtitle (optional)
stringlogo (optional)
stringsave (optional)
stringwelcomeEmailFromName (optional)
stringwelcomeEmailFromEmail (optional)
stringwelcomeEmailSubject (optional)
stringwelcomeEmailMessage (optional)
stringwelcomeEmailConfirmationText (optional)
stringwelcomeEmailSignature (optional)
stringsuccessRedirectURL (optional)
stringoptinRedirectURL (optional)
stringoptinAlertFrequency (optional)
array of struct SignupFormFieldDataStructurefields (optional)

struct SignupFormColorStructure

Members

integersequence (optional)
stringid (optional)
stringborder (optional)
stringheaderBackground (optional)
stringheader (optional)
stringformBackground (optional)
stringform (optional)
stringparaBackground (optional)
stringheaderFont (optional)
stringheaderSize (optional)
stringformFont (optional)
stringformSize (optional)
stringpara (optional)
stringparaFont (optional)
stringparaSize (optional)
stringbutton (optional)
stringlogoAlign (optional)
stringtitleAlign (optional)
stringintroAlign (optional)
stringbuttonAlign (optional)
stringwidth (optional)

struct SocialTemplateStructure

Members

integersequence (optional)
stringtemplateid (optional)
stringthemeid (optional)
stringtemplatehtml (optional)
stringtheme_css (optional)

struct SocialThemeStructure

Members

integersequence (optional)
stringthemeid (optional)
stringtheme_css (optional)

struct AccountStructure

Members

stringclientid (optional)
stringlogin (optional)
stringpassword (optional)
stringfirstname (optional)
stringlastname (optional)
stringemail (optional)
stringphone (optional)
stringfree_mail_sent (optional)
stringactive (optional)
stringplan_email_limit (optional)

struct SurveyColorStructure

Members

stringsurveyid (optional)
stringquestionfg (optional)
stringformbg (optional)
stringformfg (optional)
stringheaderbg (optional)
stringheaderfg (optional)
stringparafg (optional)
stringheaderfont (optional)
stringheadersize (optional)
stringparafont (optional)
stringparasize (optional)
stringquestionfont (optional)
stringquestionsize (optional)
stringanswerfont (optional)
stringanswersize (optional)
stringlogoalign (optional)
stringintroalign (optional)
stringtitlealign (optional)
stringbuttontext (optional)
stringbuttonalign (optional)

struct SurveyStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringtitle (optional)
stringdescription (optional)
stringurl (optional)
stringmessage (optional)
stringintro (optional)
stringlogourl (optional)
stringquestions (optional)
stringresponses (optional)
stringstatus (optional)
stringencToken (optional)
stringlivedate (optional)
stringsuccessurl (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)

struct SurveyQuestionStructure

Members

stringquestionid (optional)
stringsurveyid (optional)
stringquestion (optional)
stringquestiontype (optional)
stringquestionoptions (optional)
stringnotes (optional)
stringrequired (optional)
stringcomment (optional)
stringcommentcount (optional)
stringother (optional)
stringothercount (optional)
stringanswer1 (optional)
stringanswer2 (optional)
stringanswer3 (optional)
stringanswer4 (optional)
stringanswer5 (optional)
stringanswer6 (optional)
stringanswer7 (optional)
stringanswer8 (optional)
stringanswer9 (optional)
stringanswer10 (optional)
stringanswer1count (optional)
stringanswer2count (optional)
stringanswer3count (optional)
stringanswer4count (optional)
stringanswer5count (optional)
stringanswer6count (optional)
stringanswer7count (optional)
stringanswer8count (optional)
stringanswer9count (optional)
stringanswer10count (optional)
stringtextcount (optional)

struct ReportSurveyStructure

Members

stringsurveyid (optional)
stringname (optional)
stringresponse (optional)
stringstatus (optional)
stringintro (optional)
stringactive (optional)
stringquestions (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)
stringencToken (optional)
stringpdfEncToken (optional)

struct SurveyTemplateStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringimage (optional)
stringdescription (optional)
stringquesCount (optional)
stringencToken (optional)

struct EventTicketItemStructure

Members

stringsequence (optional)
stringticketitemID (optional)
stringticketID (optional)
stringeventID (optional)
stringeventfeeID (optional)
stringticketqty (optional)
stringcheckinqty (optional)
stringprice (optional)
stringfeelabel (optional)
stringstatus (optional)
stringdiscountamt (optional)
stringdiscountperc (optional)
stringcharges (optional)
stringfirstname (optional)
stringlastname (optional)
stringemail (optional)

struct EventTicketListStructure

Members

stringsequence (optional)
stringticketID (optional)
stringticketitemID (optional)
stringattendeeID (optional)
stringprice (optional)
stringfeelabel (optional)
stringqty (optional)
stringstatus (optional)
stringcreateddate (optional)
stringupdateddate (optional)
stringcheckinqty (optional)
stringbuyerfirstname (optional)
stringbuyerlastname (optional)
stringbuyeremail (optional)
stringticketcode (optional)
stringdiscountcode (optional)
stringdiscountamount (optional)
stringdiscountpercent (optional)
stringpaystatus (optional)

struct VideoGalleryStructure

Members

integersequence (optional)
stringid (optional)
stringvideo_name (optional)
stringvideo_description (optional)
stringvideo_height (optional)
stringvideo_width (optional)
stringvideo_image (optional)
stringvideo_embed (optional)
stringvideo_src (optional)
stringencToken (optional)
stringcreateddatetime (optional)

struct WebhookStructure

Members

integersequence (optional)
stringid (optional)
stringname (optional)
stringcontact_list_id (optional)
stringsubscribes (optional)
stringunsubscribes (optional)
stringprofile_updates (optional)
stringcleaned_address (optional)
stringemail_changed (optional)
stringurl (optional)
stringcreatedDate (optional)
stringmodifiedDate (optional)

struct AutoResponderEmailsStructure

Members

stringautoresponderDetailID (optional)
stringsubject (optional)
stringdays (optional)
stringtype (optional)
stringwhentosend (optional)
stringfieldtocompare (optional)

struct EventDateStructure

Members

stringsequence (optional)
stringeventdateid (optional)
stringeventid (optional)
stringstartdate (optional)
stringenddate (optional)
stringisprimary (optional)

struct EventTicketDetailStructure

Members

stringsequence (optional)
stringid (optional)
stringeventID (optional)
stringlabel (optional)
stringprice (optional)
stringorder (optional)
stringticketType (optional)
stringdetail (optional)
stringqty (optional)
stringqtyMin (optional)
stringqtyMax (optional)
stringstartType (optional)
stringstartExact (optional)
stringstartRelative (optional)
stringendType (optional)
stringendExact (optional)
stringendRelative (optional)
stringabsorb (optional)
stringshowDetail (optional)
stringsaleStatus (optional)
stringsold (optional)
stringattendeeCount (optional)

struct SignupFormFieldDataStructure

Members

integersequence (optional)
stringfield (optional)
stringlabel (optional)
stringtype (optional)
stringorder (optional)
stringrequired (optional)

 

API 1.0.0   CookComputing.XmlRpcV2 0.0.0   .NET CLR 4.0.30319