XMLAPI
The following methods are supported:
Get the list of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the results |
| integer | pageNumber - The page number from which you want the results |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Attendee Checkin
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | ticketitemID - The TicketItem ID |
Return Value
| boolean | Returns the event ticket |
Get the event Ticket
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | ticketitemID - The TicketItem ID |
Return Value
| boolean | Returns the event ticket |
Create a new Autoresponder based on the details provided. Return the ID of the newly created Autoresponder.
Parameters
Return Value
| string | Returns the ID of the newly created Autoresponder. |
delete the autoresponder whose id has been specified
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Id of the autoresponder |
Return Value
Create Autoresponder Details.
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Your Benchmark Email Token |
| struct AutoResponderDetailDataStructure | AutoresponderDetail - The details for the email |
Return Value
| string | Returns the ID of the newly created Autoresponder Details. |
Create Autoresponder Details.
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Your Benchmark Email Token |
| struct AutoResponderDetailDataStructure | AutoresponderDetail - The details for the email |
| string | emailID - The preview text the email |
Return Value
| string | Returns the ID of the newly created Autoresponder Details. |
Create Autoresponder Details.
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Your Benchmark Email Token |
| struct AutoResponderDetailDataStructure | AutoresponderDetail - The details for the email |
Return Value
| string | Returns the ID of the newly created Autoresponder Details. |
delete the autoresponder email whose id has been specified
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Id of the autoresponder |
| string | autoresponderDetailID - Id of the autoresponder email detail |
Return Value
deletes the eamil address from Autoresponder history whose id has been specified and email address have been specified
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Id of the autoresponder |
| string | autoresponderDetailID - Id of the autoresponder email detail |
| string | email - email address to be deleted |
Return Value
get the details of the autoresponder whose id has been specified
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Id of the autoresponder |
Return Value
Get all the details for given AutoresponderID and AutoresponderdetailID .
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - The ID for your Autoresponder |
| string | autoresponderDetailID - The ID for your Autoresponder Detail |
Return Value
| struct EmailStructure | Returns the structure with the details of the email. |
Get the list of autoresponders using the filter and paging limits.
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | filter - The filter you want to apply when fetching the lists of autoresponders |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of autoresponders using the filter and paging limits.
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | filter - The filter you want to apply when fetching the lists of autoresponders |
| string | sortOrder - The sort order (asc / desc) |
| string | ViewStatus - The autoresponder visible or hide |
Return Value
Update the autoresponder whose id has been specified
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponderID - Id of the autoresponder |
| integer | status - Status of the Autoresponder |
| struct AutoResponderDataStructure | Autoresponder - The details for the email |
Return Value
| boolean | Returns 1 if successful or 0 if unsuccessful. |
Add multiple contacts to an existing contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
Return Value
| string | Returns the Batch ID, which can be used in batchGetStatus to get the status |
Get the status of the batch contact add operation
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| string | batchID - The batch ID |
Return Value
| string | value indicating status (0 = InProgress / 1 = Added / 3 = Pending Review) |
Get the status of the batch contact add operation
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| string | batchID - The batch ID |
Return Value
| struct ListStatus | value indicating status (0 = InProgress / 1 = Added / 3 = Pending Review) |
Send Request for change in Primary Email Address
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get Client Info
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get Plan Info
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get Profile Details
Parameters
| string | token - Your Benchmark Email Token |
Return Value
PREMIUM: Get the list of email footers
Parameters
| string | premiumToken - The Premium Token |
| string | clientID - clientID |
Return Value
| string | Returns the list of email footers. |
Get YouTube Authorization for the account
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get YouTube Videos for the account
Parameters
| string | token - Your Benchmark Email Token |
| string | YTLogin - YouTube Login |
| string | PageNumber - Page Number |
| string | PageSize - Page Size |
Return Value
Get the list of notifications messages
Parameters
| string | token - Your Benchmark Email Token |
| string | status - The filter you want to apply when fetching the notifications |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
Return Value
Set the notification as read
Parameters
| string | token - Your Benchmark Email Token |
| string | MessageID - Message ID |
Return Value
Get Global Client Rating Range
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Set Client Info
Parameters
Return Value
| integer | Sets Client settings |
Set YouTube Authorization for the account
Parameters
| string | token - Your Benchmark Email Token |
| string | Username - Login for the YouTube Account |
| string | Password - Password for the YouTube Account |
Return Value
| boolean | Returns true if the data is saved |
Update Client Extra
Parameters
| string | token - Your Benchmark Email Token |
| string | clientID - The Client ID |
| string | colname - The Column Name |
| string | colval - The Column Value |
Return Value
Add emails for Confirmation
Parameters
| string | token - Your Benchmark Email Token |
| string | targetEmailID - List of emails to be confirmed |
Return Value
| string | returns List of Confirmed Emails |
Get Confirmed Emails
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get the count of unique active contacts.
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| double | Returns the count of unique active contacts. |
PREMIUM: Get the contents
Parameters
| string | premiumToken - The Premium Token |
| string | pageID - The Page ID |
| string | qryString - Querystring |
| string | dataString - Post Data |
Return Value
| string | Returns the structure with the details of the email. |
Set up an account with a certain plan, etc. for a user who signs up as a partner of a specific partner. Note that this API is not open for all.
Parameters
| string | token - Your Benchmark Email Token |
| struct ClientMasterStructure | clientstruct - The structure containing the client information |
Return Value
| string | returns Success or Failure |
Assign contact lists to the email
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The email ID |
| array of struct EmailContactStructure | lists - The contact lists |
Return Value
Update the email badge
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - ID for the email |
| string | badge - The Badge URL |
Return Value
| string | Returns status of the update |
Get the list of email templates Categories
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Check the name of an Email to determine if it is taken. Return 1 if it is unique.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The email ID to check |
| string | emailName - The email name to check |
Return Value
| integer | Returns 1 if the name is unique. |
Duplicate an existing Email and return the ID of the newly created Email.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to copy |
Return Value
| string | Returns the Email ID of the newly created email. |
Duplicate an existing Email and return the ID of the newly created Email.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to copy |
| string | newName - The New Name for the email copy |
Return Value
| string | Returns the Email ID of the newly created email. |
Create a new Email based on the details provided. Return the ID of the newly created Email.
Parameters
| string | token - Your Benchmark Email Token |
| struct EmailStructure | email - The details for the email |
Return Value
| string | Returns the ID of the newly created email. |
Create a new Email based on the details provided. Return the ID of the newly created Email.
Parameters
| string | token - Your Benchmark Email Token |
| struct EmailStructure | email - The details for the email |
Return Value
| string | Returns the ID of the newly created email. |
Delete the Email for given ID. Returns true if the email was deleted.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID you want to delete |
Return Value
Delete the Email for given ID. Returns true if the email was deleted.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailIDList - The Email IDs you want to delete |
Return Value
Get the list of emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the count of email using the filter and status.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
Return Value
| double | Returns number of campaigns. |
Get the list of emails
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The emailID to exclude |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
Return Value
| integer | Returns number of records |
Get all the details for given Email ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for your Email |
Return Value
| struct EmailStructure | Returns the structure with the details of the email. |
Get all the details for given Email ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for your Email |
Return Value
| struct EmailStructure | Returns the structure with the details of the email. |
PREMIUM: Get the detail for the email
Parameters
| string | premiumToken - The Premium Token |
| string | clientID - clientID |
| string | emailID - emailID |
| string | language - language |
Return Value
| string | Returns the detail for the email. |
Get all the details for given Email ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for your Email |
Return Value
| struct EmailStructure | Returns the structure with the details of the email. |
PREMIUM: Get the list of email footers
Parameters
| string | premiumToken - The Premium Token |
| string | language - Language |
Return Value
| string | Returns the list of email footers. |
Get the list of JB emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
PREMIUM: Get the list of email layouts
Parameters
| string | premiumToken - The Premium Token |
| string | clientID - The ClientID |
| string | language - Language |
| string | isRSS - is RSS Email |
Return Value
| string | Returns the list of email layouts. |
Get all the Lists for given Email ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for your Email |
Return Value
Get the list of emails
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The emailID to exclude |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of email templates
Parameters
| string | token - Your Benchmark Email Token |
| string | language - The Langauge |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
PREMIUM: Get the list of email template categories
Parameters
| string | premiumToken - The Premium Token |
| string | clientID - The ClientID |
| string | language - Language |
Return Value
| string | Returns the list of email template categories. |
Get the list of emails
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | filterCat - The category filter |
| string | language - The language for the emails |
Return Value
| integer | Returns number of records |
Get the list of emails
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | filterCat - The category filter |
| string | language - The language for the emails |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get Test Emails.
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| string | Returns the list of email addresses to be used for test. |
Get the preview for an email
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for the preview |
| string | emailAddress - The email address for which to preview. Leave it blank for the first contact in the associated list |
| string | htmlContent - The HTML Content for the preview |
| string | textContent - The Text Content for the preview |
Return Value
Send the test email for a preview
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for the preview |
| string | emailAddresses - The email addresses for which to send test |
| string | htmlContent - The HTML Content for the preview |
| string | textContent - The Text Content for the preview |
| string | personalMessage - Personal Message in the email |
Return Value
| string | Returns true if email is sent |
Resend an Email campaign to a list of email addresses
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID of the campaign |
| string | ListName - Name of the list that will be created |
| array of struct | emails - List of Email addresses to whom the campaign should be sent |
| string | scheduleDate - The Datetime for which the campaign is to be rescheduled |
Return Value
| string | Returns true if email is sent |
Reassign contact lists to the email. Previous selection is removed
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The email ID |
| array of struct EmailContactStructure | lists - The contact lists |
Return Value
Set an email which is resend as draft. This would clear its delivery schedule.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to schedule |
Return Value
| boolean | Returns true if the email was unscheduled. |
Resend an Email campaign so that it goes to contacts that were added since the campaign was first sent
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID of the campaign |
| string | scheduleDate - The Datetime for which the campaign is to be rescheduled |
Return Value
| string | Returns true if email is resent |
Create a new Email based on the details provided. Return the ID of the newly created Email.
Parameters
| string | token - Your Benchmark Email Token |
| struct EmailStructure | email - The details for the email |
Return Value
| string | Returns the ID of the newly created email. |
Get the list of RSS emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get all the details for given Email ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for your Email |
Return Value
| struct EmailStructure | Returns the structure with the details of the email. |
Schedule an email for delivery for the given date time
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to schedule |
| string | scheduleDate - The Datetime for which the rss campaign is to be scheduled |
| string | interval - Interval for rss campaign, can be either 1 , 7 or 30 |
Return Value
| boolean | Returns true if the email was scheduled. |
Update an existing email with the given details.
Parameters
| string | token - Your Benchmark Email Token |
| struct EmailStructure | email - The details for the email |
Return Value
Schedule an email for delivery for the given date time
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to schedule |
| string | scheduleDate - The Datetime for which the campaign is to be scheduled |
Return Value
| boolean | Returns true if the email was scheduled. |
Schedule an email for delivery for the given date time and timezone
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to schedule |
| string | scheduleDate - The Datetime for which the campaign is to be scheduled |
| string | timeZone - 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
| boolean | Returns true if the email was scheduled. |
Delete the email scheme
Parameters
| string | token - Your Benchmark Email Token |
| string | schemeID - ID for the color scheme |
Return Value
| string | Returns status of the delete |
Get the email template by the template ID
Parameters
| string | token - Your Benchmark Email Token |
| string | language - Language |
| string | filterType - Filter Type |
| string | filter - Filter |
| string | pageNumber - The Page Number |
| string | pageSize - The Page Size |
| string | orderBy - The Sort Field |
| string | sortOrder - The Sort Order |
Return Value
Save the email scheme
Parameters
| string | token - Your Benchmark Email Token |
| string | schemeName - Name for the color scheme |
| string | cssCode - The CSS Code |
| string | overwrite - Overwrite old scheme |
| string | language - Language |
Return Value
Schedule an email for immediate delivery
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to send |
Return Value
| boolean | Returns true if the email was sent. |
Send a test email for the given Email ID
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to test |
| string | testEmail - The email address to which the test is to be sent |
Return Value
| boolean | Returns true if the email was sent. |
Get the email template by the template ID
Parameters
| string | token - Your Benchmark Email Token |
| string | templateID - The ID for the template |
Return Value
| string | Returns the HTML for the template. |
Get the count of email templates for iPhone Users
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| integer | Returns the count of templates. |
Get the list of email templates for iPhone user
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
Get the list of email templates for iPhone user
Parameters
| string | token - Your Benchmark Email Token |
| string | language - The Langauge |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
Set an email as draft. This would clear its delivery schedule.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID which you want to schedule |
Return Value
| boolean | Returns true if the email was unscheduled. |
Update an existing email with the given details.
Parameters
| string | token - Your Benchmark Email Token |
| struct EmailStructure | email - The details for the email |
Return Value
Update the version of a new Email based on the details provided. Return true / false.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The ID for the email |
| string | version - The version for the email |
| string | updateDefault - The version for the email |
Return Value
| boolean | Returns true if successful. |
Get the list of email campaigns
Parameters
| string | token - Your Benchmark Email Token |
| string | language - The language for the result |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter for the result |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the count of contacts matching the criteria
Parameters
| string | token - Your Benchmark Email Token |
| string | emailIDList - The email id list to filter the result |
| string | filterType - The filter for the result |
Return Value
Get the count of contacts matching the criteria
Parameters
| string | token - Your Benchmark Email Token |
| string | campaignurllist - The campaign id and URL list to filter the result |
| string | filterType - The filter for the result |
Return Value
Get the count of contacts matching the criteria
Parameters
| string | token - Your Benchmark Email Token |
| string | emailIDList - The email id list to filter the result |
| string | filterType - The filter for the result |
Return Value
Get the count of contacts matching the criteria
Parameters
| string | token - Your Benchmark Email Token |
| string | emailIDList - The email id list to filter the result |
| string | filterType - The filter for the result |
Return Value
Get the list url of email campaigns
Parameters
| string | token - Your Benchmark Email Token |
| string | language - The language for the result |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | emaillistid - The email id list to filter the result |
| string | filter - The filter for the result |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the event attendees code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | reportType - The report type |
| string | filter - The filter you want to apply when fetching the events |
| string | filterDetail - The filter details |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| string | Returns the event list |
Get the event attendee preview code
Parameters
| string | token - Your Benchmark Email Token |
| string | attendeeID - The attendee ID |
Return Value
| string | Returns the event attendee |
Get the list of events in Eventbrite
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Cancel the event on Facebook
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | ProfileID - FB Profile ID |
Return Value
| integer | Returns Cancel Event |
Show/ Hide comment on Facebook
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | PostID - Post ID |
| string | show - Show = 1 / Hide = 0 |
Return Value
| string | Returns posted comment ID |
Copy the event
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | eventName - The event Name |
Return Value
| string | Returns the URL for edit |
Post the event on Facebook
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | PageID - Page ID |
| string | PageName - Page name |
| string | PageToken - Page Access Token |
| string | Eventname - Event Name |
| string | StartTime - Event StartTime |
| string | Location - Event Location |
| string | Description - Event description |
| string | ProfileID - Profile ID |
Return Value
| integer | Returns posted Event ID |
Delete the Discount Code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | discountID - The Discount ID |
Return Value
| integer | Returns the Discount Code deleted ot not |
Get the list of event emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the emails |
| string | status - The status of the email |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the details of an Event
Parameters
| string | token - Your Benchmark Email Token |
| string | eventid - The event id of the event you want to fetch |
Return Value
Get the attendee email preview
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | emailID - The email ID |
Return Value
| string | Returns the attendee email preview |
Get the event charts code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | reportType - The report type |
| string | fromDate - The start date filter you want to apply when fetching the events |
| string | toDate - The end date filter you want to apply when fetching the events |
| string | orderBy - The field you want to order |
| string | sortOrder - The sort order (asc / desc) |
| string | chartType - The Chart type |
| string | emailID - The Email ID |
| string | Type - The Invite stats part to load |
| string | country - The country |
Return Value
| string | Returns the event ticket type and count |
Get the event Encode Parameter
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
Return Value
| string | Returns the event Encode Parameter |
Get the event Excel Url
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | dateID - The Date ID |
| string | ClientID - The Client ID |
| string | orderBy - The field you want to order |
| string | reportType - The Report Type |
| string | filterType - The Filter Type |
| string | filterDetail - The Filter Detail |
Return Value
| string | Returns the event Excel Url |
Get the FB Events
Parameters
| string | token - Your Benchmark Email Token |
| string | TokenSecret - The FB TokenSecret |
| string | SN - The FB ScreenName |
Return Value
| string | Returns the FB EventList |
Get the FB Pages
Parameters
| string | token - Your Benchmark Email Token |
| string | TokenSecret - The FB TokenSecret |
| string | SN - The FB ScreenName |
| string | ProfileID - The FB Profile ID |
Return Value
| string | Returns the FB Pages |
Get the event invite contacts
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | emailID - The Email ID |
| string | reportType - The Type of the Report |
| string | filter - The Filter |
| integer | pageNumber - The page number from which you want the signup forms |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (name / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| string | Returns the event contact list |
Get the list of Events using the filter and paging limits, order by the name of the events.
Parameters
| string | token - Your Benchmark Email Token |
| string | filtertype - The filtertype you want to apply when fetching the events |
| string | filterdetail - The filterdetail you want to apply when fetching the events |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the event PDF Url
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | ClientID - The Client ID |
| string | orderBy - The field you want to order |
| string | pagename - The pdf report name |
| string | barcode - The barcode print or not |
| string | DateID - The Date id |
| string | HTMLData - The HTML Data |
| string | reportType - The Report Type |
| string | ticketType - The Ticket Types |
| string | ticketItems - The Attendees |
| string | mode - The Badge Style |
Return Value
| string | Returns the event PDF Url |
Get the event report code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | dateID - The Date ID |
| string | reportType - The report Type |
| string | filterType - The Filter Type |
| string | filterDetail - The Filter Detail |
| string | pageNumber - The Page Number |
| string | pageSize - The Page Size |
| string | orderBy - The Order |
| string | sort - The Sort |
| string | Language - The Langauge |
Return Value
Get the event Reports code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | reportType - The report type |
| string | filter - The filter you want to apply when fetching the events |
| string | fromDate - The start date filter you want to apply when fetching the events |
| string | toDate - The end date filter you want to apply when fetching the events |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order |
| string | sortOrder - The sort order (asc / desc) |
| string | chartType - The Chart type |
Return Value
| string | Returns the event ticket type and count |
Get the tickets of the event
Parameters
| string | token - Your Benchmark Email Token |
| string | eventid - The event id of the event you want to fetch |
Return Value
Update the invite for the event
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | emailID - The Email ID |
| string | content - Content of the email |
| string | contentRaw - Content Raw of the email |
| string | address - Address |
| string | city - City |
| string | state - State |
| string | zip - Zip |
| string | intlAddress - Intl Address |
| string | isIntl - Is Intl |
| string | textVersion - Text Version |
| string | templateID - Template ID |
| string | senderName - Sender Name |
| string | replyEmail - Reply Email |
| string | subject - Subject |
| string | listIDs - List IDs |
Return Value
| boolean | Returns true if the event invite is saved. |
Get the event order preview code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | orderID - The order ID |
Return Value
| string | Returns the event order |
Post the event comment
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | AccountType - Account Type |
| string | ParentPostID - Parent Post ID |
| string | PostID - Post ID |
| string | Message - Message to post |
| string | ProfileID - Profile ID |
| string | ProfileName - Profile Name |
| string | ProfileImage - Profile Image |
Return Value
| Returns posted comment ID |
Post the Event Going Detail
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | AccountType - Account Type |
| string | ProfileID - Profile ID |
| string | ProfileName - Profile Name |
| string | ProfileImage - Profile Image |
Return Value
| Returns posted comment ID |
Set the event refund
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | orderID - The order ID |
Return Value
| string | Refunds the event order |
Resend event Ticket
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | orderID - The order ID |
Return Value
| string | Resend event Ticket |
Update the given details for the attendee
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The ID of the event |
| string | orderID - The ID of the order |
| string | ticketID - The ID of the ticket |
| struct | attendeeDetail - The details of the attendee |
Return Value
| boolean | Returns the details for the contact |
Set the Event Attendees CheckIn
Parameters
| string | token - Your Benchmark Email Token |
| string | ticketitemid - The Event Ticket Item ID |
| integer | status - The Event Attendees status |
| integer | quantity - The Event Attendees quantity |
| string | filter - The Event Attendees filter |
| string | filterdetail - The Event Attendees filterdetail |
Return Value
| string | Returns the event checkin count |
Set the event data report
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | dateID - The Date ID |
| string | Status - The Data Report Status |
| string | Email - The Email |
Return Value
| integer | Set the event data report |
Set the FB Token
Parameters
| string | token - Your Benchmark Email Token |
| string | TokenSecret - The FB TokenSecret |
| string | SN - The FB ScreenName |
| string | PageID - The FB Page ID |
| string | AppMasterID - The App Master ID |
| string | EventID - The Event ID |
| string | ProfileID - The FB Profile ID |
Return Value
Set the event feedback
Parameters
| string | eventID - The event ID |
| string | ClientID - The client ID |
| string | name - The senders name |
| string | email - The senders email |
| string | message - The senders message |
Return Value
Set the event Share
Parameters
| string | eventID - The event ID |
| string | ClientID - The client ID |
| string | name - The senders name |
| string | email - The senders email |
| string | message - The senders message |
| string | subject - The senders subject |
| string | toemail - The receivers email |
Return Value
Get the list of event template category
Parameters
| string | token - Your Benchmark Email Token |
| string | lang - Language |
Return Value
| string | Returns the event template category. |
Get the list of event email templates
Parameters
| string | token - Your Benchmark Email Token |
| string | categoryID - The Category ID |
| string | filter - Filter for event templates |
Return Value
Get the list of event templates
Parameters
| string | token - Your Benchmark Email Token |
| string | categoryID - The Category ID |
| string | filter - Filter for event templates |
| string | lang - Language for event templates |
Return Value
Set the event Ticket Item refund
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | ticketitemID - The Ticket Item ID |
Return Value
| string | Refunds the event Ticket Item |
Get the event order preview code
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | orderID - The order ID |
| string | ticketID - The ticket ID |
Return Value
| string | Returns the event ticket |
Update the Google Merchant
Parameters
| string | token - Your Benchmark Email Token |
| string | GoogleMID - The Google Merchant ID |
| string | GoogleMKEY - The Google Merchant KEY |
| string | OldGoogleMID - The Google Old Merchant ID |
| string | OldGoogleMKEY - The Google Old Merchant KEY |
Return Value
| integer | Returns the Google Merchant updated or not |
Post the event on Facebook
Parameters
| string | token - token |
| string | EventID - Event ID |
| string | StartTime - Event StartTime |
| string | Location - Event Location |
| string | Description - Event description |
| string | ProfileID - FB Profile ID |
Return Value
| integer | Returns posted Event ID |
Update the page for the event
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | templateID - The Template ID |
| string | content - Content of the page |
| string | css - CSS If Custom |
| string | csscode - CSS Json If Custom |
Return Value
| boolean | Returns true if the event page is saved. |
Update the Paypal Email
Parameters
| string | token - Your Benchmark Email Token |
| string | EmailID - The Email ID |
| string | OldEmailID - The Old Email ID |
Return Value
| integer | Returns the Paypal Email updated or not |
Set the Event Order Pay Status
Parameters
| string | token - Your Benchmark Email Token |
| string | EventID - The Event ID |
| string | orderid - The Event Order ID |
| integer | status - The Event Order Pay status |
Return Value
| string | Returns the Pay status updated or not |
Set the event share category
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | bmeCategoryID - The BME Directory Category ID |
| string | americaCategoryID - The America Directory Category ID |
| string | americaSubcategoryID - The America Directory Subcategory ID |
Return Value
| string | Event category updated |
Set the Event Ticket Item Pay Status
Parameters
| string | token - Your Benchmark Email Token |
| string | EventID - The Event ID |
| string | TicketItemID - The Event Ticket Item ID |
| integer | status - The Event Order Pay status |
Return Value
| string | Returns the Pay status updated or not |
Update the event Url
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | EventURL - The Event URL |
Return Value
| boolean | Returns the event Url |
Validate the PayPal Email
Parameters
| string | token - token |
| string | Email - Email |
Return Value
| string | Returns Email valid or not |
Get the list of survey's in Survey Monkey
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get the signup form for the Facebook user's ID.
Parameters
| string | facebookID - The facebook page ID |
Return Value
| string | Returns the code for the signup form. |
Get the configuration for the facebook form.
Parameters
| string | facebookID - The facebook page ID |
Return Value
Save the signup form for the Facebook user's ID.
Parameters
| string | facebookID - The facebook page ID |
| struct FacebookFormSave | fields - The facebook page ID |
Return Value
| string | Returns the code for the signup form. |
Update the user for the facebook form.
Parameters
| string | token - Your Benchmark Email Token |
| string | facebookID - The facebook page ID |
Return Value
| boolean | Returns true if the assignment is successful. |
Remove the user for the facebook form.
Parameters
| string | facebookID - The facebook page ID |
Return Value
| boolean | Returns true if the disassociation is successful. |
Get the list of links in a survey for Survey Monkey
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - Survey ID |
Return Value
Update the signup form for the facebook page.
Parameters
| string | token - Your Benchmark Email Token |
| string | facebookID - The facebook page ID |
| string | signupFormID - The signup Form ID |
Return Value
| boolean | Returns true if the assignment is successful. |
Add a file for the user
Parameters
| string | token - The token you want to add |
| struct FileData | fileData - Binary File Data |
Return Value
Get details for a file
Parameters
| string | token - The token you want to add |
| string | fileID - The file ID |
Return Value
Get the list of Files in the client's Document Library
Parameters
| string | token - Your Benchmark Email Token |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter |
| string | orderBy - The column to order by |
| string | sortOrder - The sort order |
Return Value
| array of struct FileData | Returns the list of files. |
GetAutoresponder History
Parameters
| string | token - Your Benchmark Email Token |
| string | autoresponder_id - Autorespnder ID |
| string | ar_detail_id - Autoresponder EMail ID |
| string | start_date - Retreive emails who received the autoresponder on or after this time |
| string | end_date - Retreive emails who received the autoresponder on or before this time |
| string | pagenumber - Page Number |
| string | pagesize - Page Size |
| string | sort_by - Column to sort by |
| string | sort_order - Sort type; acending or descending |
| string | filter - Filter for search |
Return Value
Get the listing of specified seller
Parameters
| string | SellerID - ID of the seller |
| string | SiteID - ID of the site |
Return Value
Get whether the specified seller exists or not
Parameters
| string | SellerID - ID of the seller |
Return Value
| string | Returns whether the specified seller exists or not |
Get the the list of the sections of the shop
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| string | Returns the details of the shop. |
Get the details of the shop
Parameters
| string | ShopName - Name of the shop |
Return Value
Get the the list of the sections of the shop
Parameters
| string | ShopName - Name of the shop |
Return Value
Get the the list of the sections of the shop
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| string | Returns the details of the shop. |
Get the list of boards of the authenticated user
Parameters
| string | Filter - Filter |
| string | PageNumber - Page Number |
| string | PageSize - Number of records per page |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of boards of the authenticated user
Parameters
| string | IDs - Comma Separated list of IDs |
| string | PageNumber - Page Number |
| string | PageSize - Number of records per page |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of boards of the authenticated user
Parameters
| string | Filter - Filter |
| string | PageNumber - Page Number |
| string | PageSize - Number of records per page |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of company pages to which the authenticated user has administrative access
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| array of struct ImageStructure | Returns the list of company pages to which the authenticated user has administrative access. |
Get Login Of the token.
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| string | Returns the Login of the token. |
Get the list of boards of the authenticated user
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of boards of the authenticated user
Parameters
Return Value
| struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of boards of the authenticated user
Parameters
Return Value
| struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the contact fields from the contact list for the given email address.
Parameters
| string | token - Your Benchmark Email Token |
| string | updateddate - Date after which contacts whose rating has been changed |
| string | uptoupdateddate - Date upto which contacts whose rating has been changed |
| string | pagenumber - Page Number |
| string | pagesize - Page Size |
Return Value
Get the list of boards of the authenticated user
Parameters
| string | PageNumber - Page Number |
| string | PageSize - Number of records per page |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of boards of the authenticated user
Parameters
| string | PageNumber - Page Number |
| string | PageSize - Number of records per page |
Return Value
| array of struct ImageStructure | Returns the list of boards of the authenticated user. |
Get the list of emails using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | history_id - The filter you want to apply when fetching the emails |
| string | start_date - The filter you want to apply when fetching the emails |
| string | end_date - The filter you want to apply when fetching the emails |
Return Value
Add a image for the user
Parameters
| string | token - The token you want to add |
| struct ImageData | imgdata - Binary Image Data |
Return Value
Add an Image from URL to the client's account
Parameters
| string | token - Your Benchmark Email Token |
| string | ImageName - The Name of the Image |
| string | ImageURL - The URL of the Image |
Return Value
| boolean | Returns true if image has been added or else throws an exception |
Delete an Image from the client's account
Parameters
| string | token - Your Benchmark Email Token |
| string | ImageID - The ID of the Image |
Return Value
| boolean | Returns true if image has been deleted or else throws an exception |
Get details for an image
Parameters
| string | token - The token you want to add |
| string | imageID - The image ID |
Return Value
Get the count of images in the client's Image Gallery
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| integer | Returns the count of Images. |
Get the list of Images in the client's Flickr Image Gallery
Parameters
| string | token - Your Benchmark Email Token |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter |
| string | orderBy - The column to order by |
| string | sortOrder - The sort order |
Return Value
Get the list of Images in the client's Image Gallery
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
Get the list of Images in the client's Image Gallery
Parameters
| string | token - Your Benchmark Email Token |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter |
| string | orderBy - The column to order by |
| string | sortOrder - The sort order |
Return Value
Update an Image from the client's account
Parameters
| string | token - Your Benchmark Email Token |
| string | ImageID - The ID of the Image |
| string | ImageURL - The URL of the Image |
Return Value
| boolean | Returns true if image has been update or else throws an exception |
Update an Image Name from the client's account
Parameters
| string | token - Your Benchmark Email Token |
| string | ImageID - The ID of the Image |
| string | ImageName - The Name of the Image |
Return Value
Get the list of test using the filter and paging limits, order by the name or date of the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the test |
| string | filterType - The filter type you want to apply when fetching the tests |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the recent five posts from instagram
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| array of struct ImageStructure | Returns the recent five posts from instagram. |
Get the logged in user details from instagram
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| array of struct ImageStructure | Returns the logged in user details from instagram. |
Delete a linked account
Parameters
| string | token - Your Benchmark Email Token |
| string | id - The id for the linked account |
Return Value
| integer | Returns the detail |
Get the list of linked accounts
Parameters
| string | token - Your Benchmark Email Token |
| string | filterType - The filter type you want to apply when fetching the list |
| string | filterDetail - The filter detail for the list |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
Return Value
| integer | Returns the number of successfully added contacts. |
Add the contact details to the given contact list using an existing signup form.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - The ID of the signup form you want to use |
| struct | contactDetails - The array containing the contact information |
Return Value
| integer | Returns the number of successfully added contacts. |
Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
| string | useDoubleOptin - Use Double Optin |
Return Value
| integer | Returns the number of successfully added contacts. |
Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
| string | useDoubleOptin - Use Double Optin |
Return Value
| array of struct ContactStructure | Returns the number of successfully added contacts. |
Add the contact details to the given contact list. Multiple contacts would be added if the details has more than one items.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
Return Value
Add the contact details to the given contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of struct | contactDetails - The array containing the contact information |
| string | useDoubleOptin - Use Double Optin |
Return Value
| string | Returns the number of successfully added contacts. |
Create a new contact list with the given name. Returns the ID of the newly created list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listname - The name of the new contact list |
Return Value
| string | Returns the ID of the newly created contact list. |
Create a new contact list with the given name. Returns the ID of the newly created list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listname - The name of the new contact list |
| integer | hide - Should it be a hidden list |
Return Value
| string | Returns the ID of the newly created contact list. |
Create a new contact list with the given name. Returns the ID of the newly created list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listname - The name of the new contact list |
| string | language - The language for the list |
Return Value
| string | Returns the ID of the newly created contact list. |
Create a new contact list with the given name. Returns the ID of the newly created list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listname - The name of the new contact list |
| array of string | fields - The array containing the field information |
Return Value
| string | Returns the ID of the newly created contact list. |
Delete an exising contact list with the given ID.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the contact list |
Return Value
| boolean | Returns true on success. |
Delete contacts from the given contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| string | contacts - The contact ids (comma seperated) to delete |
Return Value
| boolean | Returns true in case contacts were deleted. |
Delete a contact which matches the email from the given contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| string | email - The email to delete |
Return Value
| boolean | Returns true in case contact were deleted. |
Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the contact lists |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the contact lists |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get Profile Details
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - ID of the list |
| string | batchID - ID of the batch |
| string | groupID - ID of the group |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (campaign name / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of contact lists using the filter and paging limits, order by the name or date of the contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the contact lists |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
| string | status - The status |
Return Value
Get the contact details from the contact list for the given email address.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | email - The email of the contact for whom you want the details |
Return Value
| struct | Returns the details for the contact |
Get the contact fields from the contact list for the given email address.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
Return Value
| struct | Returns the details for the contact |
Get the contact fields from the contact list for the given listID and field type.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contact fields from |
| string | type - The type (1 text / 2 numeric / 3 bool / 4 date) |
Return Value
| struct ArrayList | Returns the details for the contact |
Get the contact fields from the contact list for the given email address.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
Return Value
| struct | Returns the details for the contact |
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | filter - The filter you want to apply when fetching the contacts |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| array of struct ContactStructure | Returns the number of successfully added contacts. |
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | filter - The filter you want to apply when fetching the contacts |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| array of struct | Returns the number of successfully added contacts. |
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | StartDate - Start date for date filter |
| string | EndDate - End date for date filter |
| string | GUID - GUID for pagination |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | StartDate - Start date for date filter |
| string | EndDate - End date for date filter |
| string | GUID - GUID for pagination |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| struct ContactDataSet | Returns the number of successfully added contacts. |
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | filter - The filter you want to apply when fetching the contacts |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
| string | Type - The Type of the Contacts required ie Optin,NotOptedIn,ConfirmedBounces,Active,Unsubscribe |
Return Value
| array of struct ContactStructure | Returns the number of successfully added contacts. |
Get the count of the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | filter - The filter you want to apply when fetching the contacts |
Return Value
| double | Returns the number of contacts. |
Get the count of contact lists using the filter and paging limits, order by the name or date of the contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the contact lists |
Return Value
| double | Returns the number of contact lists. |
Get the contacts from the contact list
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | language - language |
| string | searchFilter - The search filter you want to apply when fetching the contacts |
| string | searchType - The search filter type you want to apply |
| string | searchField - The field on which the search should apply |
| string | filter - The type of contacts you want to fetch |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
| array of struct ContactStructure | Returns the number of successfully added contacts. |
Get the existing signup forms
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the signup forms |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (name / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Search contacts
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - email ID which you want to search |
Return Value
| array of struct ContactListStructure | Returns ContactList details for this emailID if it is present in any contactList else return message. |
Unsubscribe the contacts from the given contact list.
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to add to |
| array of string | contacts - The array containing the contact information |
Return Value
| integer | Returns the number of contacts left in the list. |
Update the contact list with the given name & description
Parameters
| string | token - Your Benchmark Email Token |
| string | listid - The ID for the contact list |
| string | listname - The name for the contact list |
| string | listdescription - The description for the contact list |
Return Value
| boolean | Returns true if the update is done. |
Update the given contact in the list based on the details provided
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| string | contactID - The ID of the contact which you want to edit |
| struct | contactDetail - The details of the contact |
Return Value
| struct | Returns the details for the contact |
Update the given contact in the list based on the details provided
Parameters
| string | token - Your Benchmark Email Token |
| string | listID - The ID of the list you want to fetch the contacts from |
| struct | contactDetail - The details of the contact |
Return Value
| struct | Returns the details for the contact |
Log App
Parameters
| string | token - Your Benchmark Email Token |
| string | filterType - App type |
Return Value
Authenticate the user and returns a token.
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
Return Value
| string | Returns the token to be used in subsequent API calls. |
Authenticate the user and returns a token.
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
| string | devicename - Device used for accessing api |
Return Value
| string | Returns the token to be used in subsequent API calls. |
Authenticate the user and returns a permanent token.
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
Return Value
Get Plans
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Upgrade to IPhone Premium Plan
Parameters
| string | token - Your Benchmark Email Token |
| string | planToken - Plan Token |
Return Value
Copy an existing Poll to new Poll
Parameters
| string | token - Your Benchmark Email Token |
| string | PollID - ID of the existing poll |
| string | NewPollName - Name of the new Poll |
Return Value
| string | Returns the id of newly created Poll. |
Create a new Poll based on the details provided. Return the ID of the newly created Poll.
Parameters
| string | token - Your Benchmark Email Token |
| struct PollStructure | poll - The details for the poll |
Return Value
| string | Returns the ID of the newly created poll. |
Delete an existing Poll based on the details provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | PollID - The pollid for the poll |
Return Value
| string | Returns the ID of the deleted poll. |
Get the poll details.
Parameters
| string | token - Your Benchmark Email Token |
| string | pollID - poll id |
| string | language - language |
Return Value
| Returns the poll details. |
Get the list of Polls using the filter and paging limits, order by the name or date of the polls.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the polls |
| string | status - The status of the poll |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the poll details.
Parameters
| string | token - Your Benchmark Email Token |
| string | pollID - poll id |
Return Value
| string | Returns the poll details. |
Get the report of Poll.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the Poll Report |
| string | status - The status of the poll |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of Poll Options with their responses
Parameters
| string | token - Your Benchmark Email Token |
| string | PollID - The poll id of the poll |
Return Value
Update Poll Status based on the details provided. Return 1 if the poll is updated else 0.
Parameters
| string | token - Your Benchmark Email Token |
| string | PollID - The PollId of the Survey |
| string | Status - Status for the Poll |
Return Value
| integer | Returns 1 if the poll is updated else 0 |
Update an existing Poll based on the details provided. Return the ID of the updated Poll.
Parameters
| string | token - Your Benchmark Email Token |
| string | PollID - The ID for the poll to update |
| struct PollStructure | poll - The details for the poll |
Return Value
| string | Returns the ID of the updated poll. |
Get the poll details.
Parameters
| string | token - Your Benchmark Email Token |
| string | data - poll data |
Return Value
| Returns the poll details. |
Register a new client
Parameters
Return Value
| integer | Returns 1 if the register action was successful and -1 if it was not |
Get the summary for multiple campaigns
Parameters
| string | token - Your Benchmark Email Token |
| string | emailIDs - The email IDs for which the comparison is required |
Return Value
Get the list of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the results |
| integer | pageNumber - The page number from which you want the results |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Abuses stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
Return Value
Get the Abuses stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the email headers for bounces in a given campaign,using the paging limits, ordered by the email or date of the bounced record.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | Filter - Either requires Hard or soft Bounce |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the emails which bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | Filter - Either requires Hard or soft Bounce |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Emails of the receipients clicking on URLs for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| string | ClickURL - The ClickeUrl for the email |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the click URL stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
Return Value
Get the click list which email clicks,using the paging limits, ordered by the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | emailid - The Email ID for which the report is required |
| string | email - The Email address for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | Filter - The filter you want to apply when fetching the results |
| string | orderBy - The field you want to order by (campaign name / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the campaign list in which given email sent,using the paging limits, ordered by the email.
Parameters
| string | token - Your Benchmark Email Token |
| string | email - The Email address for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | Filter - The filter you want to apply when fetching the results |
| string | orderBy - The field you want to order by (campaign name / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the count of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the results |
Return Value
| double | Returns number of campaigns. |
Return Emails
Parameters
| string | token - Your Benchmark Email Token |
| string | type - Opens | Clicks | Bounces |
| string | filterdate - The date filter |
| string | subaccountlogin - Login of sub account |
| string | PageNumber - The page number from which you want the list |
| string | PageSize - The number of results per page |
Return Value
Get the count of sent campaign using the filter and paging limits, ordered by the name or date of the campaign.
Parameters
| string | token - Your Benchmark Email Token |
| string | type - Opens | Clicks | Bounces |
| string | filterdate - The date filter |
| string | subaccountlogin - Login of sub account |
Return Value
| double | Returns number of campaigns. |
Get the link URL for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
Return Value
Get the Forward stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Hard Bounce stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Emails of the receipients clicking on URLs for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| string | ClickURL - The ClickeUrl for the email |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
| string | SEQ - The SEQ |
Return Value
Get the Countrywise open stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
Return Value
Get the statewise open stats for a campaign in a country
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| string | CountryCode - The country code |
Return Value
Get the Open stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Soft Bounce stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the summary for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The email ID for which the summary is required |
Return Value
Get the Open stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the Unsubscribe stats for a campaign
Parameters
| string | token - Your Benchmark Email Token |
| string | emailID - The Email ID for which the report is required |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Create a new segment based on the details provided. Return the ID of the newly created segment.
Parameters
| string | token - Your Benchmark Email Token |
| struct SegmentStructure | segment - The details for the email |
Return Value
| string | Returns the ID of the newly created segment. |
Create a new criteria for the segment. Return the ID of the newly created criteria segment.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The ID of the segment you want to add the criteria to |
| struct SegmentCriteriaStructure | criteria - The details for the criteria |
Return Value
| string | Returns the ID of the newly created criteria |
Delete a segment.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The id of the segment to delete |
Return Value
| boolean | Returns true on success |
Delete a criteria for the segment. Return true if the criteria is deleted.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The ID of the segment you want to add the criteria to |
| string | criteriaID - The ID of the criteria |
Return Value
| boolean | Returns true if the criteria is deleted |
Get the list of segments using the filter and paging limits, order by the name or date of the segments.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the segments |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
Return Value
Get contacts of a segment.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The id of the segment |
| string | filter - The filter you want to apply when fetching the contacts |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (email / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the count of segments.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the segments |
Return Value
| double | Returns the number of segments |
Get the list of criteria of a segment.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The id of the segment |
Return Value
Get details for a segment. Returns the segment details.
Parameters
| string | token - Your Benchmark Email Token |
| string | segmentID - The segment ID |
Return Value
Send PIN
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Get the the list of the sections of the shop
Parameters
| string | token - Your Benchmark Email Token |
| string | SellerID - ID of the seller |
Return Value
| string | Returns the details of the shop. |
Get the the list of the sections of the shop
Parameters
| string | token - Your Benchmark Email Token |
| string | ShopName - Name of the shop |
| string | ShopID - ID of the shop |
Return Value
| string | Returns the details of the shop. |
Get the list of usable fields for the signup form based on the details provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - The signup form ID |
Return Value
Create a new signup form based on the details provided. Return the ID of the newly created signup form.
Parameters
Return Value
| string | Returns the ID of the newly created signup form. |
Delete the signup form based on the details provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - The signup form ID |
Return Value
| boolean | Returns the Code for the signup form. |
Get the details for the signup form based on the ID provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - The details for the email |
Return Value
Get the code for the signup form based on the details provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - The signup form ID |
| string | codeType - Type of Code |
Return Value
| string | Returns the Code for the signup form. |
Update the new signup form based on the details provided. Return the true if the changes were commited.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - Your Signup Form ID |
| struct SignupFormDataStructure | signupForm - The details for the email |
Return Value
| boolean | Returns true if the changes were saved to the signup form. |
Update the colors in the signup form based on the details provided. Return the true if the changes were commited.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - Your Signup Form ID |
| struct SignupFormColorStructure | signupForm - The details for the signup form |
Return Value
| boolean | Returns true if the changes were saved to the signup form. |
Update the signup form's from email and welcome message based on the details provided. Return the true if the changes were commited.
Parameters
| string | token - Your Benchmark Email Token |
| string | signupFormID - Your Signup Form ID |
| struct SignupFormDataStructure | signupForm - The details for the email |
Return Value
| boolean | Returns true if the changes were saved to the signup form. |
Register a new SubAccount
Parameters
| string | token - Your Benchmark Email Token |
| struct AccountStructure | accountstruct - The structure containing the client account information |
Return Value
| integer | Returns 1 if the register action was successful and -1 if it was not |
Get the details of SubAccount
Parameters
| string | token - Your Benchmark Email Token |
| string | data - details to search for |
Return Value
| Returns the details of SubAccount. |
Update SubAccount details
Parameters
| string | token - Your Benchmark Email Token |
| string | childClientID - The structure containing the client account information |
Return Value
| Returns errorlist if the update SubAccount action was successful and -1 if it was not |
Get the list of SubAccounts
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Authenticate the user and returns a token for sub account.
Parameters
| string | token - Your Benchmark Email user name |
| string | subAccountID - Your Benchmark Email password |
Return Value
| string | Returns the token to be used in subsequent API calls. |
Get SubAccounts
Parameters
| string | token - Your Benchmark Email Token |
| string | data - details to search for |
Return Value
| Returns list of subaccounts |
Update SubAccount details
Parameters
| string | token - Your Benchmark Email Token |
| struct AccountStructure | accountstruct - The structure containing the client account information |
Return Value
| integer | Returns 1 if the update SubAccount action was successful and -1 if it was not |
Update SubAccount details
Parameters
| string | token - Your Benchmark Email Token |
| string | data - The structure containing the client account information |
Return Value
| Returns errorlist if the update SubAccount action was successful and -1 if it was not |
Update SubAccount status
Parameters
| string | token - Your Benchmark Email Token |
| string | ID - Your SubAccount ID |
| string | status - Status of the Account |
Return Value
| integer | Return Update Status |
Update Survey Color based on the details provided. Return the ID of the Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - Survey ID of the survey |
| struct SurveyColorStructure | surveyColor - The details for the SurveyColor |
Return Value
| string | Returns the ID of the Survey. |
Update Survey Color based on the details provided. Return the ID of the Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | data - The details for the SurveyColor |
Return Value
| string | Returns the ID of the Survey. |
Copy an existing survey to new Survey
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - ID of the existing survey |
| string | NewSurveyName - Name of the new Survey |
Return Value
| string | Returns the id of newly created Survey. |
Copy an existing survey Template to new Survey
Parameters
| string | token - Your Benchmark Email Token |
| string | TemplateID - ID of the existing survey |
| string | NewSurveyName - Name of the new Survey |
Return Value
| string | Returns the id of newly created Survey. |
Create a new Survey based on the details provided. Return the ID of the newly created Survey.
Parameters
| string | token - Your Benchmark Email Token |
| struct SurveyStructure | survey - The details for the Survey |
Return Value
| string | Returns the ID of the newly created Survey. |
Delete an existing Survey based on the information provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - ID of the survey which is to be deleted |
Return Value
| string | Returns the ID of deleted Survey. |
Get the Colors and font styles of the survey
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - The survey id of the survey |
Return Value
Get the survey details.
Parameters
| string | token - Your Benchmark Email Token |
| string | surveyID - survey id |
| string | language - language |
Return Value
| Returns the survey details. |
Get the list of Surveys using the filter and paging limits, order by the name or date of the surveys.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the survey |
| string | status - The status of the survey |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of Survey Questions
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - The survey id of the survey |
Return Value
Get the list of links in a survey for Survey Monkey
Parameters
| string | token - Your Benchmark Email Token |
| string | surveyID - Survey ID |
Return Value
Get the list of survey's in Survey Monkey
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Create a new Survey Question based on the details provided. Return the ID of the newly created Survey Question.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - ID of the survey for which you want to create questions |
| struct SurveyQuestionStructure | surveyquestion - The details for the Survey Question |
Return Value
| string | Returns the ID of the newly created Survey Question. |
Delete an existing Survey Question based on the information provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - ID of the survey of which question is to be deleted |
| string | QuestionID - ID of the survey question which is to be deleted |
Return Value
| string | Returns the ID of deleted Survey Question. |
Update Survey Question based on the details provided. Return the ID of the updated Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - Your Benchmark Email Token |
| struct SurveyQuestionStructure | surveyquestion - The details for the Survey |
Return Value
| string | Returns the ID of the updated Survey Question. |
Update Survey Question Order based on the details provided. Return the ID of the updated Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - Your Benchmark Survey ID |
| string | QuestionID - Your Benchmark Question ID |
| string | Direction - The details for the Question Direction |
| string | SortOrder - The details for the Question Order |
Return Value
| string | Returns the ID of the updated Survey Question. |
Get the report of Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | filter - The filter you want to apply when fetching the survey Report |
| string | status - The status of the survey |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
| string | orderBy - The field you want to order by (list / date) |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Get the list of Survey Questions with answers and there responses
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - The survey id of the survey |
Return Value
Update Survey Status based on the details provided. Return the ID of the updated Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - The SurveyId of the Survey |
| string | Status - Status for the Survey |
Return Value
| integer | Returns 1 if the survey is updated else 0 |
Get the list of survey templates
Parameters
| string | token - Your Benchmark Email Token |
Return Value
Create a new Survey based on the details provided. Return the ID of the newly created Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | SurveyID - The ID of the survey which you want to Update |
| struct SurveyStructure | survey - The details for the Survey |
Return Value
| string | Returns the ID of the newly created Survey. |
Create a new Survey based on the details provided. Return the ID of the newly created Survey.
Parameters
| string | token - Your Benchmark Email Token |
| string | data - The details for the Survey |
Return Value
| string | Returns the ID of the newly created Survey. |
Get the event Ticket
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The Event ID |
| string | ticketID - The Ticket ID |
Return Value
Get the event Ticket List for check in
Parameters
| string | token - Your Benchmark Email Token |
| string | eventID - The event ID |
| string | filtertype - The filter you want to apply when fetching the events |
| string | dateID - The date ID |
| string | filterdetail - The filter detail you want to apply when fetching the events |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | orderBy - The field you want to order |
| string | sortOrder - The sort order (asc / desc) |
Return Value
Add a token for the user
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
| string | token - The token you want to add |
Return Value
Delete an existing token for the user
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
| string | token - The token you want to delete |
Return Value
Fetch All tokens for the user
Parameters
| string | username - Your Benchmark Email user name |
| string | password - Your Benchmark Email password |
Return Value
| array of string | Returns the tokens which are active for the user. |
Update Vendor as Partner
Parameters
| string | token - Your Benchmark Email Token |
| string | VendorLogin - Login of the Vendor |
Return Value
| string | returns Success or Failure |
Add a video to youtube and then to the video gallery for the user
Parameters
| string | token - Your Benchmark Email Token |
| string | Title - Video Title |
| string | Description - Video Description |
| string | Category - Video Category |
| string | VideoData - Binary Video Data |
Return Value
Add the Video
Parameters
| string | token - Your Benchmark Email Token |
| struct VideoGalleryStructure | videoStructure - Details for the video |
Return Value
| boolean | Returns true if the video is embeded else false |
Delete an existing Video based on the details provided.
Parameters
| string | token - Your Benchmark Email Token |
| string | VideoID - The Video ID for the video |
Return Value
| string | Returns the ID of the deleted video. |
Get details for an video
Parameters
| string | token - Your Benchmark Email Token |
| string | videoID - The video ID |
Return Value
Get the count of videos in the account
Parameters
| string | token - Your Benchmark Email Token |
Return Value
| integer | Returns the number of videos in the account |
Get all the videos of the current client list.
Parameters
| string | token - Your Benchmark Email Token |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
Get the list of videos in the client's Image Gallery
Parameters
| string | token - Your Benchmark Email Token |
| string | pageNumber - The page number from which you want the list |
| string | pageSize - The number of results per page |
| string | filter - The filter |
| string | orderBy - The column to order by |
| string | sortOrder - The sort order |
Return Value
Update a Video Name from the client's account
Parameters
| string | token - Your Benchmark Email Token |
| string | VideoID - The ID of the Image |
| string | VideoName - The Name of the Image |
Return Value
Create a new Webhook for the contact list. Return the ID of the newly created Webhook.
Parameters
| string | token - Your Benchmark Email Token |
| struct WebhookStructure | Webhook - The details for the webhook |
Return Value
| string | Return the ID of the newly created Webhook. |
Delete the Webhook for given ID. Returns true if the webhook was deleted.
Parameters
| string | token - Your Benchmark Email Token |
| string | webhookID - The Email ID you want to delete |
Return Value
Get the list of webhook.
Parameters
| string | token - Your Benchmark Email Token |
| string | ContactListID - List ID |
Return Value
Update a existing Webhook for the contact list. Return the status of Webhook Update.
Parameters
| string | token - Your Benchmark Email Token |
| struct WebhookStructure | Webhook - The details for the webhook |
Return Value
Get User Profile
Parameters
| string | token - Google Token |
Return Value
| string | returns User Profile |
Get Authorization Token
Parameters
| string | email - Google Email |
| string | password - Google Password |
Return Value
| string | returns Authorization Token |
Get User Videos
Parameters
| string | token - Google Token |
| string | username - Youtube username |
| integer | pageNumber - The page number from which you want the list |
| integer | pageSize - The number of results per page |
Return Value
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | emailName (optional) |
| string | subject (optional) |
| string | fromName (optional) |
| string | fromEmail (optional) |
| string | replyEmail (optional) |
| string | language (optional) |
| boolean | isSegment (optional) |
| integer | toListID (optional) |
| string | toListName (optional) |
| string | status (optional) |
| string | templateContent (optional) |
| string | templateText (optional) |
| string | us_address (optional) |
| string | us_city (optional) |
| string | us_state (optional) |
| string | us_zip (optional) |
| string | permissionReminderMessage (optional) |
| string | googleAnalyticsCampaign (optional) |
| boolean | webpageVersion (optional) |
| string | version (optional) |
| string | intl_address (optional) |
| string | scheduleDate (optional) |
| string | inboxPreviewText (optional) |
| string | zone (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | rssurl (optional) |
| string | rssinterval (optional) |
| string | rssactive (optional) |
| string | listcount (optional) |
| string | communityurl (optional) |
| string | isfavorite (optional) |
| string | encToken (optional) |
| string | templateID (optional) |
| string | shareURL (optional) |
| string | manualText (optional) |
| string | templateCode (optional) |
| string | layoutID (optional) |
| string | schemeID (optional) |
| string | badge (optional) |
| string | cssCode (optional) |
| string | footer (optional) |
| string | eventName (optional) |
| string | isABSplit (optional) |
| string | isResend (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | emailName (optional) |
| string | abtestName (optional) |
| string | abtestType (optional) |
| boolean | isSegment (optional) |
| integer | toListID (optional) |
| string | toListName (optional) |
| string | status (optional) |
| string | templateContent (optional) |
| string | templateText (optional) |
| string | us_address (optional) |
| string | us_city (optional) |
| string | us_state (optional) |
| string | us_zip (optional) |
| string | permissionReminderMessage (optional) |
| string | googleAnalyticsCampaign (optional) |
| boolean | webpageVersion (optional) |
| string | version (optional) |
| string | intl_address (optional) |
| string | scheduleDate (optional) |
| string | zone (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | rssurl (optional) |
| string | rssinterval (optional) |
| string | rssactive (optional) |
| string | listcount (optional) |
| string | communityurl (optional) |
| string | isfavorite (optional) |
| string | encToken (optional) |
| string | templateID (optional) |
| string | manualText (optional) |
| string | shareURL (optional) |
| string | startDate (optional) |
| string | winDate (optional) |
| string | editUrl (optional) |
| string | abstatus (optional) |
Members
| string | autoresponderName (optional) |
| string | contactListID (optional) |
| string | fromName (optional) |
| string | fromEmail (optional) |
| boolean | permissionReminder (optional) |
| string | permissionReminderMessage (optional) |
| boolean | webpageVersion (optional) |
| boolean | isSegment (optional) |
| boolean | Hide (optional) |
Members
| string | subject (optional) |
| string | templateContent (optional) |
| string | templateText (optional) |
| string | language (optional) |
| string | us_address (optional) |
| string | us_city (optional) |
| string | us_state (optional) |
| string | us_zip (optional) |
| string | intl_address (optional) |
| string | days (optional) |
| string | type (optional) |
| string | whentosend (optional) |
| string | fieldtocompare (optional) |
| string | sendDays (optional) |
| string | sendTimeHrs (optional) |
| string | sendTimeMin (optional) |
| string | Timezone (optional) |
Members
| string | id (optional) |
| string | autoresponderName (optional) |
| string | totalEmails (optional) |
| string | status (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | contactListID (optional) |
| string | contactListName (optional) |
| string | isSegment (optional) |
| string | fromName (optional) |
| string | fromEmail (optional) |
| string | permissionReminderMessage (optional) |
| boolean | webpageVersion (optional) |
| boolean | Hide (optional) |
| array of struct AutoResponderEmailsStructure | emails (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | autoresponderName (optional) |
| string | totalEmails (optional) |
| string | status (optional) |
| string | modifiedDate (optional) |
| string | encToken (optional) |
| string | Lb_Name (optional) |
| string | hide (optional) |
Members
| string | Status (optional) |
| string | ListAuditStatus (optional) |
Members
| string | client_id (optional) |
| string | company (optional) |
| string | phone (optional) |
| string | address (optional) |
| string | city (optional) |
| string | state (optional) |
| string | zip (optional) |
| string | country (optional) |
| string | email (optional) |
| string | first_name (optional) |
| string | last_name (optional) |
| string | payment_mode (optional) |
| string | has_dedicated_ip (optional) |
| string | cc_expire_date (optional) |
| string | allow_sub_accounts (optional) |
| string | region_code (optional) |
| string | region_name (optional) |
| string | contact_count (optional) |
| string | list_size (optional) |
Members
| string | plan_id (optional) |
| string | plan_name (optional) |
| string | plan_email_limit (optional) |
| string | additional_amount (optional) |
| string | account_expire (optional) |
| string | email_size (optional) |
| string | email_usage (optional) |
| string | image_size (optional) |
| string | image_usage (optional) |
Members
| string | client_id (optional) |
| string | email (optional) |
| string | first_name (optional) |
| string | emails_sent (optional) |
| string | bounces (optional) |
| string | opens (optional) |
| string | client_rating (optional) |
| string | address (optional) |
| string | zip (optional) |
| string | created_date (optional) |
| string | login (optional) |
| string | plan_id (optional) |
| string | plan_name (optional) |
| string | Country_code (optional) |
| string | last_name (optional) |
| string | client_status (optional) |
| string | Business_phone (optional) |
| string | Business_city (optional) |
| string | Business_country (optional) |
| string | Modified_date (optional) |
| string | category (optional) |
| string | origin_url (optional) |
| string | Phone (optional) |
| string | Company (optional) |
| string | Client_Products (optional) |
| string | Business_state (optional) |
| string | Language (optional) |
| string | ELanguage (optional) |
| string | paid_or_free (optional) |
| string | confirmed (optional) |
| string | payment_mode (optional) |
| string | has_dedicated_ip (optional) |
| string | cc_expire_date (optional) |
| string | allow_sub_accounts (optional) |
| string | region_code (optional) |
| string | region_name (optional) |
| string | contact_count (optional) |
| string | list_size (optional) |
| string | state (optional) |
| string | experience (optional) |
| string | total_emails_sent (optional) |
| string | opens_perc (optional) |
| string | bounces_perc (optional) |
| string | client_discount (optional) |
| string | renewal_date (optional) |
| string | manual_payment (optional) |
| string | total_active_subaccounts (optional) |
| string | master_account (optional) |
Members
| string | firstname (optional) |
| string | lastname (optional) |
| string | companyname (optional) |
| string | email (optional) |
| string | phone (optional) |
| string | login (optional) |
| string | password (optional) |
| string | promocode (optional) |
| string | timezone (optional) |
Members
| string | sequence (optional) |
| string | VideoID (optional) |
| string | URL (optional) |
| string | ImageURL (optional) |
| string | Title (optional) |
| string | Length (optional) |
| string | VideoURL (optional) |
| string | Views (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | body (optional) |
| string | title (optional) |
| string | icon (optional) |
| string | createdDate (optional) |
Members
| string | rating_min (optional) |
| string | rating_max (optional) |
| string | rating (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | email (optional) |
| string | confirmed (optional) |
| string | createddate (optional) |
| string | modifieddate (optional) |
Members
| integer | sequence (optional) |
| string | emailID (optional) |
| boolean | isSegment (optional) |
| string | toSegmentID (optional) |
| string | toListID (optional) |
| string | toListName (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | count (optional) |
| string | newFlag (optional) |
Members
| integer | status (optional) |
| string | message (optional) |
| string | extrainfo (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | template_name (optional) |
| string | template_source (optional) |
| string | preview_small (optional) |
| string | backgroundImage (optional) |
| string | background (optional) |
| string | headerImage (optional) |
| string | footerImage (optional) |
| string | thirdParty (optional) |
| string | content (optional) |
Members
| integer | sequence (optional) |
| string | schemeid (optional) |
| string | schemename (optional) |
| string | clr1 (optional) |
| string | clr2 (optional) |
| string | clr3 (optional) |
| string | clr4 (optional) |
| string | clr5 (optional) |
Members
| string | id (optional) |
| string | mailSent (optional) |
| string | emailName (optional) |
| string | clicks (optional) |
| string | opens (optional) |
| string | bounces (optional) |
| string | abuseReports (optional) |
| string | unsubscribes (optional) |
| integer | toListID (optional) |
| string | toListName (optional) |
| string | forwards (optional) |
| string | scheduleDate (optional) |
| string | subject (optional) |
| string | shareURL (optional) |
| string | timezone (optional) |
| string | encToken (optional) |
| string | startDate (optional) |
| string | endDate (optional) |
Members
| integer | sequence (optional) |
| string | campaign_id (optional) |
| string | campaign_name (optional) |
| string | link_name (optional) |
| string | click_thru (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | client_id (optional) |
| string | image_path_virtual (optional) |
| string | image_size (optional) |
| string | image_h (optional) |
| string | image_w (optional) |
| string | image_name (optional) |
Members
| string | sequence (optional) |
| string | eventid (optional) |
| string | eventname (optional) |
| string | status (optional) |
| string | venue (optional) |
| string | location (optional) |
| string | timezone (optional) |
| string | repeat (optional) |
| string | contactname (optional) |
| string | contactemail (optional) |
| string | contactphone (optional) |
| string | contactorganization (optional) |
| string | ispublic (optional) |
| string | eventurl (optional) |
| string | maxattendee (optional) |
| array of struct EventDateStructure | dates (optional) |
| array of struct EventTicketDetailStructure | tickets (optional) |
Members
| string | sequence (optional) |
| string | eventid (optional) |
| string | eventname (optional) |
| string | status (optional) |
| string | startdate (optional) |
| string | enddate (optional) |
| string | sold (optional) |
| string | attendeemax (optional) |
| string | repeat (optional) |
| string | timezone (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | label (optional) |
| string | price (optional) |
| string | order (optional) |
| string | absorb (optional) |
Members
| string | sequence (optional) |
| string | templateid (optional) |
| string | ispopular (optional) |
| string | isnew (optional) |
| string | isused (optional) |
| string | name (optional) |
| string | image (optional) |
| string | css (optional) |
| string | categoryid (optional) |
Members
| string | clientID (optional) |
| string | signupFormID (optional) |
| string | clientName (optional) |
| string | token (optional) |
Members
| string | fldEmail (optional) |
| string | fldfirstname (optional) |
| string | fldlastname (optional) |
| string | fldmiddlename (optional) |
| string | fldfield1 (optional) |
| string | fldfield2 (optional) |
| string | fldfield3 (optional) |
| string | fldfield4 (optional) |
| string | fldfield5 (optional) |
| string | fldfield6 (optional) |
| string | fldfield7 (optional) |
| string | fldfield8 (optional) |
| string | fldfield9 (optional) |
| string | fldfield10 (optional) |
| string | fldfield11 (optional) |
| string | fldfield12 (optional) |
| string | fldfield13 (optional) |
| string | fldfield14 (optional) |
| string | fldfield15 (optional) |
| string | fldfield16 (optional) |
| string | fldfield17 (optional) |
| string | fldfield18 (optional) |
| string | fldfield19 (optional) |
| string | fldfield20 (optional) |
| string | fldfield21 (optional) |
| string | fldfield22 (optional) |
| string | fldfield23 (optional) |
| string | fldfield24 (optional) |
| string | fldfield25 (optional) |
| string | fldfield26 (optional) |
| string | fldfield27 (optional) |
| string | token (optional) |
| string | action (optional) |
Members
| integer | sequence (optional) |
| string | file_id (optional) |
| string | file_name (optional) |
| string | file_url (optional) |
| string | file_data (optional) |
| string | file_size (optional) |
| string | file_date (optional) |
Members
| string | autoresponder_id |
| string | ar_detail_id |
| string | email |
| string | date |
Members
| string | email |
| string | rating |
| string | firstname |
| string | lastname |
| string | middlename |
| string | ratingmodifiedtime |
| string | contactmodifiedtime |
| string | contactid |
| string | contactmasterid |
Members
| string | history_id (optional) |
| string | client_id (optional) |
| string | plan_email_limit (optional) |
| string | free_mail_sent (optional) |
| string | campaigns_sent (optional) |
Members
| string | image_id (optional) |
| string | image_name (optional) |
| string | image_url (optional) |
| string | image_data (optional) |
| string | image_height (optional) |
| string | image_width (optional) |
| string | image_size (optional) |
Members
| integer | sequence (optional) |
| string | testID (optional) |
| string | encToken (optional) |
| string | reportURL (optional) |
| string | emailName (optional) |
| string | emailID (optional) |
| string | createdDate (optional) |
| string | status (optional) |
| string | testCount (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | clientid (optional) |
| string | login (optional) |
| string | alias (optional) |
| string | planname (optional) |
| string | mailsent (optional) |
| string | firstname (optional) |
| string | lastname (optional) |
| string | accountexpire (optional) |
| string | status (optional) |
| string | token (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | email |
| string | firstname (optional) |
| string | lastname (optional) |
| string | middlename (optional) |
| string | emailtype (optional) |
| string | resend (optional) |
| string | enctoken (optional) |
| string | createddate (optional) |
| string | updateddate (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | listname (optional) |
| integer | contactcount (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | permissionPassList (optional) |
| string | is_importing (optional) |
| string | list_audited (optional) |
| string | list_description (optional) |
| string | is_master_unsubscribe (optional) |
| string | encToken (optional) |
| string | allow_delete (optional) |
| string | list_import_v3 (optional) |
| string | segment (optional) |
Members
| string | id (optional) |
| string | email (optional) |
| string | date (optional) |
Members
Members
| integer | pages (optional) |
| integer | totalrows (optional) |
| integer | currentrows (optional) |
| string | guid (optional) |
| array of struct | contacts (optional) |
| struct | contactsmapping (optional) |
Members
| integer | pages (optional) |
| integer | totalrows (optional) |
| integer | currentrows (optional) |
| string | guid (optional) |
| array of struct | contacts (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | listName (optional) |
| string | toListName (optional) |
| string | added (optional) |
| string | version (optional) |
| string | encToken (optional) |
| string | encTokenSignup (optional) |
Members
| string | clientID (optional) |
| string | email (optional) |
| string | clientName (optional) |
| string | token (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | plan_name (optional) |
| string | plan_detail (optional) |
| string | plan_price (optional) |
| string | plan_limit (optional) |
| string | additional (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | question (optional) |
| string | answer1 (optional) |
| string | answer2 (optional) |
| string | answer3 (optional) |
| string | answer4 (optional) |
| string | answer5 (optional) |
| string | answer1count (optional) |
| string | answer2count (optional) |
| string | answer3count (optional) |
| string | answer4count (optional) |
| string | answer5count (optional) |
| string | responses (optional) |
| string | status (optional) |
| string | encToken (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | questioncolor (optional) |
| string | questionfont (optional) |
| string | answercolor (optional) |
| string | answerfont (optional) |
| string | buttontext (optional) |
| string | borderbg (optional) |
| string | formbg (optional) |
| string | livedate (optional) |
| string | url (optional) |
Members
Members
| string | email (optional) |
| string | email_id (optional) |
| string | email_name (optional) |
| string | log_date (optional) |
Members
| string | sequence (optional) |
| string | email (optional) |
| string | received (optional) |
| string | fromaddress (optional) |
| string | subject (optional) |
| string | header (optional) |
| string | email_id (optional) |
| string | attachment (optional) |
| string | logdate (optional) |
| string | mailsource (optional) |
Members
| string | sequence (optional) |
| string | email (optional) |
| string | name (optional) |
| string | type (optional) |
| string | logdate (optional) |
| string | encToken (optional) |
Members
| string | sequence (optional) |
| string | email (optional) |
| string | name (optional) |
| string | logdate (optional) |
| string | reason (optional) |
| string | encToken (optional) |
| string | counts (optional) |
| string | device (optional) |
| string | linkname (optional) |
| string | totalRecord (optional) |
Members
| string | sequence (optional) |
| string | URL (optional) |
| string | clicks (optional) |
| string | percent (optional) |
Members
| string | sequence (optional) |
| string | id (optional) |
| string | emailName (optional) |
| string | subject (optional) |
| string | scheduledate (optional) |
| string | status (optional) |
| string | clicks (optional) |
| string | previewLink (optional) |
| string | totalRecord (optional) |
Members
| string | email (optional) |
| string | campaign_id (optional) |
| string | link_name (optional) |
| string | campaign_name (optional) |
Members
| string | sequence (optional) |
| string | URL (optional) |
Members
| string | sequence (optional) |
| string | country_name (optional) |
| string | country_region (optional) |
| string | openCount (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | segmentname (optional) |
| string | description (optional) |
| string | listid (optional) |
| string | listname (optional) |
| integer | contactcount (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | field (optional) |
| string | segmentid (optional) |
| string | startDate (optional) |
| string | endDate (optional) |
| string | filterType (optional) |
| string | filter (optional) |
| string | fieldType (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | segmentname (optional) |
| string | listid (optional) |
| string | listname (optional) |
| integer | contactcount (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
Members
| integer | sequence (optional) |
| string | field (optional) |
| string | label (optional) |
| string | type (optional) |
| string | order (optional) |
| string | required (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| array of struct ContactListStructure | lists (optional) |
| string | introduction (optional) |
| string | title (optional) |
| string | logo (optional) |
| string | save (optional) |
| string | welcomeEmailFromName (optional) |
| string | welcomeEmailFromEmail (optional) |
| string | welcomeEmailSubject (optional) |
| string | welcomeEmailMessage (optional) |
| string | welcomeEmailConfirmationText (optional) |
| string | welcomeEmailSignature (optional) |
| string | successRedirectURL (optional) |
| string | optinRedirectURL (optional) |
| string | optinAlertFrequency (optional) |
| array of struct SignupFormFieldDataStructure | fields (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | border (optional) |
| string | headerBackground (optional) |
| string | header (optional) |
| string | formBackground (optional) |
| string | form (optional) |
| string | paraBackground (optional) |
| string | headerFont (optional) |
| string | headerSize (optional) |
| string | formFont (optional) |
| string | formSize (optional) |
| string | para (optional) |
| string | paraFont (optional) |
| string | paraSize (optional) |
| string | button (optional) |
| string | logoAlign (optional) |
| string | titleAlign (optional) |
| string | introAlign (optional) |
| string | buttonAlign (optional) |
| string | width (optional) |
Members
| string | clientid (optional) |
| string | login (optional) |
| string | password (optional) |
| string | firstname (optional) |
| string | lastname (optional) |
| string | email (optional) |
| string | phone (optional) |
| string | free_mail_sent (optional) |
| string | active (optional) |
| string | plan_email_limit (optional) |
| string | planid (optional) |
Members
| string | surveyid (optional) |
| string | questionfg (optional) |
| string | formbg (optional) |
| string | formfg (optional) |
| string | headerbg (optional) |
| string | headerfg (optional) |
| string | parafg (optional) |
| string | headerfont (optional) |
| string | headersize (optional) |
| string | parafont (optional) |
| string | parasize (optional) |
| string | questionfont (optional) |
| string | questionsize (optional) |
| string | answerfont (optional) |
| string | answersize (optional) |
| string | logoalign (optional) |
| string | introalign (optional) |
| string | titlealign (optional) |
| string | buttontext (optional) |
| string | buttonalign (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | title (optional) |
| string | description (optional) |
| string | url (optional) |
| string | message (optional) |
| string | intro (optional) |
| string | logourl (optional) |
| string | questions (optional) |
| string | responses (optional) |
| string | status (optional) |
| string | encToken (optional) |
| string | livedate (optional) |
| string | successurl (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
Members
| string | questionid (optional) |
| string | surveyid (optional) |
| string | question (optional) |
| string | questiontype (optional) |
| string | questionoptions (optional) |
| string | notes (optional) |
| string | required (optional) |
| string | comment (optional) |
| string | commentcount (optional) |
| string | other (optional) |
| string | othercount (optional) |
| string | answer1 (optional) |
| string | answer2 (optional) |
| string | answer3 (optional) |
| string | answer4 (optional) |
| string | answer5 (optional) |
| string | answer6 (optional) |
| string | answer7 (optional) |
| string | answer8 (optional) |
| string | answer9 (optional) |
| string | answer10 (optional) |
| string | answer1count (optional) |
| string | answer2count (optional) |
| string | answer3count (optional) |
| string | answer4count (optional) |
| string | answer5count (optional) |
| string | answer6count (optional) |
| string | answer7count (optional) |
| string | answer8count (optional) |
| string | answer9count (optional) |
| string | answer10count (optional) |
| string | textcount (optional) |
| string | questiontypetext (optional) |
| string | answers (optional) |
Members
| string | surveyid (optional) |
| string | name (optional) |
| string | response (optional) |
| string | status (optional) |
| string | intro (optional) |
| string | active (optional) |
| string | questions (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
| string | encToken (optional) |
| string | pdfEncToken (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | image (optional) |
| string | description (optional) |
| string | quesCount (optional) |
| string | encToken (optional) |
Members
| string | sequence (optional) |
| string | ticketitemID (optional) |
| string | ticketID (optional) |
| string | eventID (optional) |
| string | eventfeeID (optional) |
| string | ticketqty (optional) |
| string | checkinqty (optional) |
| string | price (optional) |
| string | feelabel (optional) |
| string | status (optional) |
| string | discountamt (optional) |
| string | discountperc (optional) |
| string | charges (optional) |
| string | firstname (optional) |
| string | lastname (optional) |
| string | email (optional) |
Members
| string | sequence (optional) |
| string | ticketID (optional) |
| string | ticketitemID (optional) |
| string | attendeeID (optional) |
| string | price (optional) |
| string | feelabel (optional) |
| string | qty (optional) |
| string | status (optional) |
| string | createddate (optional) |
| string | updateddate (optional) |
| string | checkinqty (optional) |
| string | buyerfirstname (optional) |
| string | buyerlastname (optional) |
| string | buyeremail (optional) |
| string | ticketcode (optional) |
| string | discountcode (optional) |
| string | discountamount (optional) |
| string | discountpercent (optional) |
| string | paystatus (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | video_name (optional) |
| string | video_description (optional) |
| string | video_height (optional) |
| string | video_width (optional) |
| string | video_image (optional) |
| string | video_embed (optional) |
| string | video_src (optional) |
| string | encToken (optional) |
| string | createddatetime (optional) |
Members
| integer | sequence (optional) |
| string | id (optional) |
| string | name (optional) |
| string | contact_list_id (optional) |
| string | subscribes (optional) |
| string | unsubscribes (optional) |
| string | profile_updates (optional) |
| string | cleaned_address (optional) |
| string | email_changed (optional) |
| string | url (optional) |
| string | createdDate (optional) |
| string | modifiedDate (optional) |
Members
| string | autoresponderDetailID (optional) |
| string | subject (optional) |
| string | days (optional) |
| string | type (optional) |
| string | whentosend (optional) |
| string | fieldtocompare (optional) |
Members
| string | sequence (optional) |
| string | eventdateid (optional) |
| string | eventid (optional) |
| string | startdate (optional) |
| string | enddate (optional) |
| string | isprimary (optional) |
Members
| string | sequence (optional) |
| string | id (optional) |
| string | eventID (optional) |
| string | label (optional) |
| string | price (optional) |
| string | order (optional) |
| string | ticketType (optional) |
| string | detail (optional) |
| string | qty (optional) |
| string | qtyMin (optional) |
| string | qtyMax (optional) |
| string | startType (optional) |
| string | startExact (optional) |
| string | startRelative (optional) |
| string | endType (optional) |
| string | endExact (optional) |
| string | endRelative (optional) |
| string | absorb (optional) |
| string | showDetail (optional) |
| string | saleStatus (optional) |
| string | sold (optional) |
| string | attendeeCount (optional) |