Parameter | Type | Description |
---|---|---|
Field | string | Field of inbox |
Code | string | Error Code |
Message | string | Error Code Message |
Parameter | Type | Description |
---|---|---|
ID | string | ID of Inbox |
TestID | string | ID of Test inbox |
TemplateName | string | Template name of Inbox Checker |
Status | string | Status of Inbox checker |
TestCount | int | Count of test inbox |
CreatedDate | string | Created date of Inbox |
Parameter | Type | Description |
---|---|---|
EmailID | string | EmailID |
hasEMail | bool | 1=Email,0=Not email |
hasSpam | bool | 1=Spam,0=Not Spam |
TemplateName | string | Template Name |
FilterCount | string | Filter Count |
Parameter | Type | Description |
---|---|---|
ResultType | string | Result Type |
Platform | string | Platform |
IsPass | bool | 1=Pass,0=Not Pass |
Status | string | 1=success,0=failed |
SpamScore | string | Spam Score |
ApplicationName | string | Application Name |
Parameter | Type | Description |
---|---|---|
Data | InboxSummaryData | Find more detail in InboxSummaryData |
Parameter | Type | Description |
---|---|---|
FullpageImageThumb | string | Fullpage Image Thumb |
FullpageImage | string | Fullpage Image |
ApplicationName | string | Application Name |
Platform | string | Platform |
Type | string | Type |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
ApplicationName | string | Application Name |
Platform | string | Platform |
Type | string | Type |
Parameter | Type | Description |
---|---|---|
Field | string | Field of Engagement |
Code | string | Error Code |
Message | string | Error message |
Parameter | Type | Description |
---|---|---|
ID | string | Campaign ID |
EmailName | string | Campaign Name |
MailSent | int | Numbers of mail sent |
Opens | int | Numbers of mail opens |
Clicks | int | Number of click links |
ScheduleDate | string | Campaign schedule date |
TimeZone | string | Time zone of client |
Parameter | Type | Description |
---|---|---|
CampaignID | string | Campaign Id |
LinkName | string | name of the Campaign Link |
CampaignName | string | Campaign Name |
ClickThrough | int |
Parameter | Type | Description |
---|---|---|
ID | string | Signup Form ID |
Name | string | Signup Form Name |
Status | string | |
Lists | ListData | Array of ListData |
Version | string | Version |
CreatedDate | string | Created Date |
Parameter | Type | Description |
---|---|---|
ID | string | List ID |
Name | string | List Name |
Parameter | Type | Description |
---|---|---|
ID | string | Signup Form ID |
Name | string | Signup Form Name |
Status | string | |
Lists | ListData | Array of Lists |
Fields | FieldData | Array of Fields |
Version | String | Version |
CreatedDate | string | Created Date |
Title | string | Signup Form Title |
Introduction | string | Introduction |
Button | string | Button |
LogoURL | string | Logo URL |
JSCode | string | JS Code |
HTMLCode | string | HTML Code |
HasMarketing | string | HasMarketing |
TemplateID | string | Template ID |
MenuSortOrder | string | Menu Sort Order |
ThemeID | string | Theme ID |
Style | string | Style |
DesignCode | string | Design Code |
IsCustomSuccessURL | string | IsCustomSuccessURL |
SuccessURL | string | Success URL |
StandardSuccessURL | string | Standard Success URL |
IsCustomConfirmationURL | string | IsCustomConfirmationURL |
ConfirmationURL | string | Confirmation URL |
StandardConfirmationURL | string | Standard Confirmation URL |
WelcomeMessage | WelcomeMessageData | WelcomeMessage |
Parameter | Type | Description |
---|---|---|
Content | string | Content |
Subject | string | Subject |
ClosingSignature | string | Closing Signature |
ConfirmationLink | string | Confirmation Link |
FromName | string | From Name |
FromEmail | string | From Email Address |
Parameter | Type | Description |
---|---|---|
Field | string | Error Field |
Code | string | Error Code |
Message | string | Error Message |
Extra | string | Extra |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
ImageSrc | string | Image Source |
ImageBar | string | Color Bar Image |
Style | string | Style |
ImagePreview | string | Preview Image |
Parameter | Type | Description |
---|---|---|
Name | string | Field Name |
Label | string | Field Label |
Column | string | Field Column |
Extra | List<string> | Extra |
IsRequired | string | 1 if required else 0 |
IsEmail | string | 1 if email else 0 |
IsIncluded | string | IsIncluded |
Order | int | Field Order |
Parameter | Type | Description |
---|---|---|
Name | string | Field Name |
Label | string | Field Label |
Column | string | Field Column |
Extra | List<string> | Extra |
IsEmail | string | 1 if email else 0 |
IsRequired | string | 1 if required else 0 |
Type | string | Field Type |
Order | int | Field Order |
Parameter | Type | Description |
---|---|---|
Data | string | Data |
Parameter | Type | Description |
---|---|---|
ColumnName | string | Column Name |
Parameter | Type | Description |
---|---|---|
QuestionID | string | Question ID |
Question | string | Question |
Name | string | Name |
Sequence | int | Sequence |
Responses | int | Responses |
Answers | SurveyIndividualAnswers | Answers |
Parameter | Type | Description |
---|---|---|
Answer | string | Answer |
hasOther | string | 1 Yes,0 No |
string | ||
Comment | string | Comment |
Responses | int | Responses |
ResponseDate | string | Response Date |
Parameter | Type | Description |
---|---|---|
Answer | string | Answer |
string |
Parameter | Type | Description |
---|---|---|
Answer | string | Answer |
string |
Parameter | Type | Description |
---|---|---|
string | ||
Comment | string | Comment |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Status | string | Status |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
URL | string | URL |
QuestionCount | int | Question Count |
Intro | string | Intro |
Logourl | string | Logo URL |
LiveDate | string | Live Date |
Title | string | Title |
Description | string | Description |
Successurl | string | Success URL |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
Name | string | Name |
URL | string | URL |
Intro | string | Intro |
Logourl | string | Logo URL |
Title | string | Title |
Message | string | Message |
ID | string | ID |
Status | string | Status |
QuestionCount | int | Question Count |
Responses | int | Responses |
ButtonText | string | Button Text |
LiveDate | string | Live Date |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
Image | string | Image |
Description | string | Description |
Successurl | string | Success URL |
PollModel.CSSdata | CSS | |
ShareLink | string | Share Link |
Button | string | Button |
Form | string | Form |
Parameter | Type | Description |
---|---|---|
QuestionID | string | Question ID |
Question | string | Question |
QuestionOptions | string | Question Options |
QuestionType | string | Question Type |
Answer1 | string | Answer1 |
Answer2 | string | Answer2 |
Answer3 | string | Answer3 |
Answer4 | string | Answer4 |
Answer5 | string | Answer5 |
Answer6 | string | Answer6 |
Answer7 | string | Answer7 |
Answer8 | string | Answer8 |
Answer9 | string | Answer9 |
Answer10 | string | Answer10 |
Notes | string | Notes |
Required | string | 1 =Yes,0= No |
Other | string | Other |
Comment | String | Comment |
QuestionTypeText | string | Question Type Text |
ResponseRatio | string | Response Ratio |
Responses | int | Responses |
CommentCount | int | Comment Count |
Total | int | Total |
Sequence | int | Sequence |
Parameter | Type | Description |
---|---|---|
Field | string | Field |
Code | string | Code |
Message | string | Message |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
Question | string | Question |
QuestionID | string | Question ID |
QuestionType | string | Question Type |
CommentCount | string | Comment Count |
ResponseRatio | string | Response Ratio |
Total | int | Total |
Answers | SurveyAnswers | Answers |
Parameter | Type | Description |
---|---|---|
Answer | string | Answer |
Comment | string | Comment |
ResponseRatio | string | Response Ratio |
Responses | int | Responses |
Imgwidth | int | Img width |
Parameter | Type | Description |
---|---|---|
Count | Int | Count of results |
Status | String | 1 for Success / -1 for Error |
Data | List<AutomationData> | List of AutomationData |
Parameter | Type | Description |
---|---|---|
ID | String | ID for the Automation |
Name | String | Name of the Automation |
ListName | String | Name of the Contact List associated with the Automation |
ListID | String | ID of the Contact List associated with the Automation |
IsSegment | String | 1 if a segment is associated with the Automation.0 if it is a list |
SegmentID | String | ID of the Segment associated with the Automation (if it is a segment) |
ContactCount | Int | Number of Contacts associated |
FromName | String | “From” Name used in the emails in the Automation |
FromEmail | String | “From” email used in the emails in the automation |
AutomationType | String | 1 = Contact Based2 = Engagement Based |
Automations | Int | Number of automation emails created in this Automation |
Status | String | 0 Not Active1 Active-1 Stopped (Not Active) |
ModifiedDate | String | Last modified Date |
Parameter | Type | Description |
---|---|---|
Status | String | 1 Success-1 Failure |
Data | AutomationDetailData | See below for AutomatonDetailData |
Errors | List<ErrorData> | List of Errors if Any |
Parameter | Type | Description |
---|---|---|
ID | String | ID for the Detail |
Name | String | Name for the Detail |
Description | String | Description |
AutomationType | String | 1 = Contact Based2 = Engagement Based |
ListName | String | Name of the Contact List associated with the Automation |
ListID | String | ID of the Contact List associated with the Automation |
IsSegment | String | 1 if a segment is associated with the Automation.0 if it is a list |
SegmentID | String | ID of the Segment associated with the Automation (if it is a segment) |
FromName | String | “From” Name used in the emails in the Automation |
FromEmail | String | “From” email used in the emails in the automation |
ContactCount | Int | Number of Contacts associated |
TriggerType | String | Related to Engagement baseda) specificlink (click on a specific link in campaign)b) anylinks (click on any link in campaign)c) open (opened a campaign)Related to Contact baseda) signup (on signup to the list)b) anniversary (when the date and month matches a field in the contact list)c) exact (when the date matches a field in the contact list) |
TriggerLink | String | In case of TriggerType = specificlink, then it is the link used in the campaign |
TriggerField | String | In case of Contact Based and TriggerType is Anniversary or Exact. This refers to the field in the contact list |
TriggerEmailID | String | In case TriggerType = 2, then this refers to the ID of the Email Campaign for the check |
HasCustomHeader | String | 1 If Yes0 If NoThis refers to the Permission Reminder message |
CustomHeader | String | Permission Reminder Message |
HasWebVersion | String | 1 If Yes0 If NoThis refers to the Web version message in the email |
WebVersion | String | The web version message in the email |
Status | String | 0 = Not Started1 = Started-1 = Stopped / Not Started |
ModifiedDate | String | Modified Date |
Emails | List<AutomationEmailData> | List of Emails in the Automation |
Parameter | Type | Description |
---|---|---|
Status | String | 1 Success-1 Error |
Errors | List<ErrorData> | List of Errors |
AutomationEmailData | See below for AutomationEmailData |
Parameter | Type | Description |
---|---|---|
ID | String | ID of the Detail |
EmailID | String | Email ID used in the Detail |
Subject | String | Subject line for the email |
Days | String | Number of days for the trigger |
IsBefore | String | 1 If the email is to be sent before 'x' Days0 if the email is to be sent after 'x' Days |
ListID | String | ID of the Contact List associated with the Automation |
IsSegment | String | 1 if a segment is associated with the Automation.0 if it is a list |
SegmentID | String | ID of the Segment associated with the Automation (if it is a segment) |
FromName | String | “From” Name used in the emails in the Automation |
FromEmail | String | “From” email used in the emails in the automation |
ContactCount | Int | Number of Contacts associated |
TriggerType | String | Related to Engagement baseda) specificlink (click on a specific link in campaign)b) anylinks (click on any link in campaign)c) open (opened a campaign)Related to Contact baseda) signup (on signup to the list)b) anniversary (when the date and month matches a field in the contact list)c) exact (when the date matches a field in the contact list) |
TriggerLink | String | In case of TriggerType = specificlink, then it is the link used in the campaign |
TriggerField | String | In case of Contact Based and TriggerType is Anniversary or Exact. This refers to the field in the contact list |
TriggerEmailID | String | In case TriggerType = 2, then this refers to the ID of the Email Campaign for the check |
HasGoogleCampaign | String | 1 If Yes0 If NoThis refers to the Google Campaign |
GoogleCampaignName | String | Google Campaign Name |
HasPreviewText | String | 1 If Yes0 If NoThis refers to the Inbox Preview message in the email |
PreviewText | String | The Inbox Preview message in the email |
ScheduleDays | String | 12345671 = Sun, 2 = Mon, .. 7 =SatDays when the email can be triggered |
TimeZone | String | Timezone used in the schedule |
Offset | String | Offset of the Timezone from UTC |
TimeStamp | String | Timestamp of the current time |
ScheduleTime | String | Schedule time for the email |
Content | EmailData | Content of the email. See below for Emaildata |
Parameter | Type | Description |
---|---|---|
Status | String | 1 Success-1 Error |
Count | int | Count of records |
Name | String | Name of the Automation |
Data | AutomationSummaryData | See below for AutomationSummaryData |
Parameter | Type | Description |
---|---|---|
ID | String | ID of the Automation |
Sends | String | Number of emails sent |
Opens | String | Number of emails opened |
Clicks | String | Number of clicks in the campaign |
Unsubscribes | String | Number of unsubscribes in the campaign |
Bounces | String | Number of bounces in the campaign |
Complaints | String | Number of abuse complaints recevied in the campaign |
Subject | String | Subject of the email campaign |
Days | String | Days for the trigger |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the email |
Name | string | Name of the email |
Subject | string | Subject |
FromName | String | From Name |
FromEmail | String | From Email |
ReplyEmail | String | Reply Email |
HasPermissionReminderMessage | String | 1 Yes,0 No |
PermissionReminderMessage | String | Permission Reminder Message |
PermissionPosition | String | 0 Top,1 Bottom |
HeaderMessage | String | Header Message |
Zone | String | Time Zone |
CreatedDate | String | Created Date |
ModifiedDate | String | Modified Date |
ScheduleDate | String | Schedule Date |
Status | String | Status |
StatusText | String | Status Text |
InternationalAddress | String | International Address |
IsInternationalAddress | String | 1 yes,0 no |
TemplateContent | String | Template Content |
TemplateText | String | Template Text |
IsManualText | String | 1 yes,0 no |
TemplateCode | String | Template Code |
IsRSS | String | 1 yes,0 no |
RSSURL | String | RSS URL |
RSSSchedule | String | RSS Schedule |
AddressLine | String | Address Line |
AddressCity | String | Address City |
AddressState | String | Address State |
AddressZip | String | Address Zip |
Language | String | Language |
GoogleAnalyticsCampaign | String | Google Analytics Campaign |
HasWebpageVersion | String | 1 yes,0 no |
Version | String | Version |
OriginalVersion | String | Original Version |
TemplateID | String | Template ID |
TemplateUsedName | String | Template Used Name |
ShareURL | String | Share URL |
InboxPreviewText | String | Inbox Preview Text |
SchemeID | String | Scheme ID |
LayoutID | String | Layout ID |
Badge | String | Badge |
CSSCode | String | CSS Code |
FooterFlags | String | Footer Flags |
FooterSent | String | Footer Sent |
FooterLink | String | Footer Link |
ToEmail | String | To Email |
IsResend | String | 1=yes,0 no |
CanResend | String | 1=yes,0 no |
ReSendType | String | ReSend Type |
RescheduleListID | String | Reschedule List ID |
RescheduleDate | String | Reschedule Date |
CampaignID | String | Campaign ID |
WebpageVersion | String | Webpage Version |
SocialTweet | String | Social Tweet |
SocialFacebookID | String | Social Facebook ID |
PreDMARCFromEmail | String | Pre DMARC From Email |
TimeZone | String | Time Zone |
TimeStamp | String | Time Stamp |
Offset | String | Offset |
HasCommunity | String | 1=yes,0 no |
CommunityCategoryID | String | Community Category ID |
CommunityTags | String | Community Tags |
HasArchive | String | 1=yes,0 no |
HasShareURL | String | 1=yes,0 no |
IsHVSClient | String | 1=yes,0 no |
TargetCount | String | Target Count |
ContactLists | List<ContactListData> | Contact Lists |
ExcludeContactLists | List<ContactListData> | Exclude ContactLists |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
IsSegment | string | 1=yes,0 no |
SegmentID | String | Segment ID |
Parameter | Type | Description |
---|---|---|
Field | string | Field |
Code | string | Code |
Message | string | Message |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the list |
Name | string | Name of the list |
NameShort | string | If the list name exceeds 50 characters, then first 50 characters otherwise the entire list name. |
Status | string | Status of the list approval. |
ContactCount | double | Number of active contacts in the list. |
CreatedDate | string | Created date of the list |
ModifiedDate | string | Modified date of the list |
PermissionPassList | string | Permission Pass List |
ListAudited | string | Whether the list is audited or not. |
ListDescription | string | Description of the list |
IsImporting | string | Is Importing |
IsMasterUnsubscribe | string | Whether the list is master unsubscribe or not |
AllowDelete | string | Whether the list can be deleted or not. |
ListImportV3 | string | Number of times the list has been audited |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the contact list |
Name | string | Name of the contact list |
Description | string | Description of the contact list |
FirstnameLabel | string | Text for the 'First Name' Field |
MiddlenameLabel | string | Text for the 'Middle Name' Field |
LastnameLabel | string | Text for the 'Last Name' Field |
Field1Name | string | Text for Field 1 |
Field1Type | string | Field type for Field 1 |
Field2Name | string | Text for Field 2 |
Field2Type | string | Field type for Field 2 |
Field3Name | string | Text for Field 3 |
Field3Type | string | Field type for Field 3 |
Field4Name | string | Text for Field 4 |
Field4Type | string | Field type for Field 4 |
Field5Name | string | Text for Field 5 |
Field5Type | string | Field type for Field 5 |
Field6Name | string | Text for Field 6 |
Field6Type | string | Field type for Field 6 |
Field7Name | string | Text for Field 7 |
Field7Type | string | Field type for Field 7 |
Field8Name | string | Text for Field 8 |
Field8Type | string | Field type for Field 8 |
Field9Name | string | Text for Field 9 |
Field9Type | string | Field type for Field 9 |
Field10Name | string | Text for Field 10 |
Field10Type | string | Field type for Field 10 |
Field11Name | string | Text for Field 11 |
Field11Type | string | Field type for Field 11 |
Field12Name | string | Text for Field 12 |
Field12Type | string | Field type for Field 12 |
Field13Name | string | Text for Field 13 |
Field13Type | string | Field type for Field 13 |
Field14Name | string | Text for Field 14 |
Field14Type | string | Field type for Field 14 |
Field15Name | string | Text for Field 15 |
Field15Type | string | Field type for Field 15 |
Field16Name | string | Text for Field 16 |
Field16Type | string | Field type for Field 16 |
Field17Name | string | Text for Field 17 |
Field17Type | string | Field type for Field 17 |
Field18Name | string | Text for Field 18 |
Field18Type | string | Field type for Field 18 |
Field19Name | string | Text for Field 19 |
Field19Type | string | Field type for Field 19 |
Field20Name | string | Text for Field 20 |
Field20Type | string | Field type for Field 20 |
Field21Name | string | Text for Field 21 |
Field21Type | string | Field type for Field 21 |
Field22Name | string | Text for Field 22 |
Field22Type | string | Field type for Field 22 |
Field23Name | string | Text for Field 23 |
Field23Type | string | Field type for Field 23 |
Field24Name | string | Text for Field 24 |
Field24Type | string | Field type for Field 24 |
IsMasterUnsubscribe | string | Whether the list is a Master Unsubscribe list or not |
ActiveContactCount | string | Total number of active contacts |
CreatedDateTime | string | Created date time |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Count | int | Number of contact lists found |
Data | Array | Array of contact data list returned. |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Message | int | Message regarding list cleaning |
Errors | Array | Array of errors if any |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Message | int | Saving email address |
Errors | Array | Array of errors if any |
Count | string | Number of uploaded email addresses. |
TotalAdded | string | Total number of contacts |
Parameter | Type | Description |
---|---|---|
HardBounces | string | Should hard bounce contacts be cleaned |
SoftBounces | string | Should soft bounce contacts be cleaned |
ConfirmedBounces | string | Should confirm bounce contacts be cleaned |
Unsubscribes | string | Should unsubscribing contacts be cleaned |
FilterDomain | string | Should contacts belonging to a particular domain be cleaned |
NotOpenedCampaigns | string | Should contacts not opening email be cleaned |
Remove | string | If 1, then contacts should be deleted from existing list, otherwise copied to a new list. |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Count | int | Number of signup forms |
Data | Array | Array of signup form data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | string | ID of the newly created segment |
Parameter | Type | Description |
---|---|---|
Status | string | Sequance |
ListName | string | ListName |
ListDescription | string | List Description |
ContactMasterID | string | Contact Master ID |
Error | Array of ErrorData | Array of ErrorData |
Data | Array of SegmentDownloadData | Array of SegmentDownloadData |
Count | int | Data Count |
HasPin | int | int 1 if Has pin, 0 if not |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | Array of ErrorData | Array of ErrorData |
Content | string | Content |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the signup form |
Name | string | Name of the signup form |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Object | Webhook related data |
Errors | Array | Array of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Array | List of webhooks |
Count | int | Number of webhooks |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Array | List of emails |
Count | int | Number of emails |
Parameter | Type | Description |
---|---|---|
ID | string | |
TemplateName | string | Email name |
Schedule | string | Schedule date |
Opens | string | Number of opens |
Clicks | string | Number of clicks |
Forwards | string | Number of forwards |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if records successfully found, -1 otherwise |
Data | Array | Array of contact lists |
Count | int | Number of contact lists |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if lists are similar and no errors occur, -1 otherwise |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Array | List of contact details |
Errors | Array | Array of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if contacts found successfully, -1 otherwise |
Data | Array | List of contact details |
Count | int | Array of errors |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the contact |
ContactMasterID | string | ID of the list which contains the contact |
string | Email Address of the contact | |
EmailType | string | Email Type of the contact |
CreatedDate | string | Created date of the contact |
UpdatedDate | string | Updated date of the contact |
ReSend | string | Resend |
FirstName | string | First Name of the contact |
LastName | string | Last Name of the contact |
MiddleName | string | Middle Name of the contact |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if contacts found successfully, -1 otherwise |
Data | Array | List of contact details |
Count | int | Array of errors |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the contact |
ContactMasterID | string | ID of the list containing the contact |
string | Email address of the contact | |
FirstName | string | First Name of the contact |
LastName | string | Last Name of the contact |
ListName | string | Name of the list containing the contact |
IsMasterUnsubScribe | string | 1 if the list containing the contact is a Master Unsubscribe list, 0 otherwise |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if contacts found successfully, -1 otherwise |
Data | Object | Details of the contact |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the contact |
ContactMasterID | string | ID of the list containing the contact |
string | Email address of the contact | |
FirstName | string | First Name of the contact |
MiddleName | string | Middle Name of the contact |
LastName | string | Last Name of the contact |
EmailType | string | Email Type of the contact |
Field1 | string | Value stored in Field 1 of the contact |
Field2 | string | Value stored in Field 2 of the contact |
Field3 | string | Value stored in Field 3 of the contact |
Field4 | string | Value stored in Field 4 of the contact |
Field5 | string | Value stored in Field 5 of the contact |
Field6 | string | Value stored in Field 6 of the contact |
Field7 | string | Value stored in Field 7 of the contact |
Field8 | string | Value stored in Field 8 of the contact |
Field9 | string | Value stored in Field 9 of the contact |
Field10 | string | Value stored in Field 10 of the contact |
Field11 | string | Value stored in Field 11 of the contact |
Field12 | string | Value stored in Field 12 of the contact |
Field13 | string | Value stored in Field 13 of the contact |
Field14 | string | Value stored in Field 14 of the contact |
Field15 | string | Value stored in Field 15 of the contact |
Field16 | string | Value stored in Field 16 of the contact |
Field17 | string | Value stored in Field 17 of the contact |
Field18 | string | Value stored in Field 18 of the contact |
Field19 | string | Value stored in Field 19 of the contact |
Field20 | string | Value stored in Field 20 of the contact |
Field21 | string | Value stored in Field 21 of the contact |
Field22 | string | Value stored in Field 22 of the contact |
Field23 | string | Value stored in Field 23 of the contact |
Field24 | string | Value stored in Field 24 of the contact |
IPAddress | string | IP address of the contact |
Optin | string | Whether the contact is optin or not |
OptinIP | string | IP address of the contact for opting |
OptinDate | string | Date of the contact for opting in |
Flag | string | Type of contact, active, unsubscribe, etc. |
Status | string | Status of the contact |
EmailPerm | string | Whether the contact has optin permission or not |
Parameter | Type | Description |
---|---|---|
Status | string | Returns 1 if list is found successfully or no list ID is specified, -1 otherwise |
Data | Object | Details of the list |
Parameter | Type | Description |
---|---|---|
Status | string | Returns 1 if list is found successfully or no list ID is specified, -1 otherwise |
Data | Array | Array of Merge lists |
Count | int | Number of lists found |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the criteria |
FieldText | string | Text associated with the field |
FieldType | string | Type of the field |
ConditionText | string | Text specified for matching the criteria |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the criteria |
Description | string |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 otherwise |
Data | Object | Details of the segment |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if the segments are found successfully, -1 otherwise |
Count | int | Number of contacts found |
Data | Array | Details of contacts |
Parameter | Type | Description |
---|---|---|
ID | string | Contact ID |
string | Email address of the contact | |
ContactMasterID | string | ID of the list containing the contact |
ModifiedDate | string | Modified date of the contact |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Object | Details of the segment |
Errors | Array | Array of errors |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the segment |
Name | string | Name of the segment |
Description | string | Description of the segment |
ContactMasterID | string | ID of the list to which the segment belongs |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the segment |
Name | string | Name of the segment |
Description | string | Description of the segment |
ListName | string | Name of the list associated with the segment |
ClientID | string | ID of the client to whom the segment belongs |
ContactCount | double | Number of contacts |
ContactMasterID | string | ID of the list associated with the segment |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified date |
Criteria | Array | List of criterias |
Parameter | Type | Description |
---|---|---|
ID | string | ID of the contact list |
Name | string | Name of the contact list |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Data | Object | Data of the list |
Errors | Array | Array of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Count | int | Number of contact list attributes |
Data | Array | Contact list attributes |
Errors | Array |
Parameter | Type | Description |
---|---|---|
Field | Array | Array of fields |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Errors | Array | List of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Errors | Array | List of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if success, -1 if failure |
Count | int | Number of rows in the file (excluding one) |
ColumnCount | int | Number of columns in the file |
EmailFieldCol | int | EmailFieldCol |
IsvalidFile | bool | True if valid file, False if not a valid file. |
Header | ContactMasterFileUploadSingleRow | ContactMasterFileUploadSingleRow |
Data | Array of ContactMasterFileUploadSingleRow | |
Mapping | ContactMasterFileUploadSingleRow | ContactMasterFileUploadSingleRow |
Errors | Array of ErrorData | Array of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
ImportType | string | ImportType |
ContactFound | string | ContactFound |
ContactIncrease | string | ContactIncrease |
Count | int | Count |
ListIDs | string | List ID |
Data | Array of ContactImportStatusRecord | Array of ContactImportStatusRecord |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Extra | string | New List ID |
Error | Array of ErrorData | Array of ErrorData |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | Array of ErrorData | Array of ErrorData |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | Array of ErrorData | Array of ErrorData |
Parameter | Type | Description |
---|---|---|
ID | string | List ID |
Name | string | List Name |
ShortName | string | List Short Name |
Added | string | Added or Not |
Unsubscribe | string | Unsubscribe Or Not |
MasterUnsubscribe | string | Master Unsubscribe Or Not |
Spam | string | Spam or Not |
Existing | string | Existing or Not |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | Array of AuditHistoryDetailsRecord | Array of AuditHistoryDetailsRecord |
Errors | Array of ErrorData | Array of ErrorData |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | Array of AuditHistoryDetailsRecord | Array of AuditHistoryDetailsRecord |
Errors | Array of ErrorData | Array of ErrorData |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
string | ||
Date | string | Date |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
FileName | string | File Name |
BatchSize | string | Batch Size |
ApprovedBatchSize | string | Approved Batch Size |
TotalBatchSize | string | Total Batch Size |
CreatedDate | string | Created Date |
ListAudited | string | List Audited |
BatchID | string | Batch ID |
SyntaxError | string | Syntax Error |
RoleBased | string | Role Based |
FilteredKeyword | string | Filtered Keyword |
FilteredOther | string | Filtered Other |
Unsubscribes | string | Unsubscribes |
Duplicates | string | Duplicates |
BadEmails | string | Bad Emails |
JsonData | string | Json Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | ContactSummaryRecord | ContactSummaryRecord |
Errors | Array of ErrorData | Array of ErrorData |
Parameter | Type | Description |
---|---|---|
ActiveContactCount | string | Active Contact Count |
BounceContactCount | string | Bounce Contact Count |
UnsubscribeContactCount | string | Unsubscribe Contact Count |
SoftContactCount | string | Soft Contact Count |
HardContactCount | string | Hard Contact Count |
OptinContactCount | string | Optin Contact Count |
NotOptinContactCount | string | Not Optin Contact Count |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Count | string | Count |
Data | Array of ContactRecord | Array of ContactRecord |
Parameter | Type | Description |
---|---|---|
ID | string | Contact ID |
Name | string | Contact Name |
Status | string | Status |
ContactCount | double | Contact Count |
CreatedDate | string | CreatedDate |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Count | int | Count |
Data | Array of SegmentsRecord | Array of SegmentsRecord |
Parameter | Type | Description |
---|---|---|
ID | string | Contact ID |
Name | string | Name |
Description | string | Description |
ContactCount | double | Contact Count |
ListName | string | List Name |
Parameter | Type | Description |
---|---|---|
Status | string | Sequance |
SegmentName | string | Segment Name |
SegmentDescription | string | Segment Description |
ContactMasterID | string | Contact Master ID |
Error | Array of ErrorData | Array of ErrorData |
Data | Array of SegmentDownloadData | Array of SegmentDownloadData |
Count | int | Data Count |
HasPin | int | 1 if Has pin, 0 if not |
Parameter | Type | Description |
---|---|---|
Sequance | int | Sequence |
FieldName | string | Field Name |
FieldLabel | string | Field Label |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
ContactMasterID | string | ID of the list |
CleanedAddress | string | Cleaned Address |
EmailChanged | string | Email Changed |
ProfileUpdates | string | Profile Updates |
Subscribes | string | Subscribes |
Unsubscribes | string | Unsubscribes |
ClientUrl | string | Client URL |
Parameter | Type | Description |
---|---|---|
Status | int | 1 if successful, -1 if error |
ReportTypeText | string | Report Type Text |
ListName | string | List Name |
Parameter | Type | Description |
---|---|---|
Sequance | int | Sequence |
FieldName | string | Field Name |
FieldLabel | string | Field Label |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
ImageURL | string | Image URL |
Label | string | Label |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Error | Array of ErrorData | Array of errors |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Error | Array of ErrorData | Array of errors |
Data | EmailData | Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Count | int | Count |
Data | EmailListData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Subject | string | Subject |
FromName | string | From Name |
FromEmail | string | From Email |
ReplyEmail | string | Reply Email |
Zone | string | Zone |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
ScheduleDate | string | Schedule Date |
IsRSS | string | Is RSS |
RSSURL | string | RSS Feed URL |
RSSSchedule | string | RSS Schedule |
IsRSSActive | string | Is RSS Active |
Status | string | 1 if successful, -1 if error |
StatusText | string | Status Text |
ReviewReason | string | Review Reason |
Version | string | Version |
EmailType | string | Email Type |
ContactLists | ContactListData | Contact Lists |
ExcludeContactLists | ContactListData | Contact Lists with contacts to be excluded |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Subject | string | Subject |
FromName | string | From Name |
FromEmail | string | From Email |
ReplyEmail | string | Reply Email |
PermissionReminderMessage | string | Permission Reminder Message |
HasPermissionReminderMessage | string | Has Permission Reminder Message |
PermissionPosition | string | Permission Position |
HeaderMessage | string | Header Message |
Zone | string | Zone |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
ScheduleDate | string | Schedule Date |
Status | string | 1 if successful, -1 if error |
StatusText | string | Status Text |
internationalAddress | string | International Address |
IsinternationalAddress | string | Is International Address |
TemplateContent | string | Template Content |
TemplateText | string | Template Text |
IsManualText | string | Is Manual Text |
TemplateCode | string | Template Code |
RSSURL | string | RSS Feed URL |
RSSSchedule | string | RSS Schedule |
RSSinterval | string | RSS interval |
IsRSSActive | string | Is RSS Active |
AddressLine | string | Address Line |
AddressCity | string | Address City |
AddressState | string | Address State |
AddressZip | string | Address Zip |
Language | string | Language |
GoogleAnalyticsCampaign | string | Google Analytics Campaign |
HasWebpageVersion | string | Has Webpage Version |
Version | string | Version |
OriginalVersion | string | Original Version |
TemplateID | string | Template ID |
TemplateUsedName | string | Template Used Name |
ShareURL | string | Share URL |
InboxPreviewText | string | Inbox Preview Text |
SchemeID | string | Scheme ID |
LayoutID | string | Layout ID |
Badge | string | Badge |
CSSCode | string | CSS Code |
FooterFlags | string | Footer Flags |
FooterSent | string | Footer Sent |
FooterLink | string | Footer Link |
ToEmail | string | To Email |
IsResend | string | Is Resend |
CanResend | string | Can Resend |
ReSendType | string | Re Send Type |
RescheduleListID | string | Reschedule List ID |
RescheduleDate | string | Reschedule Date |
CampaignID | string | Campaign ID |
WebpageVersion | string | Webpage Version |
SocialTweet | string | Social Tweet |
SocialFacebookID | string | Social Facebook ID |
SocialFacebook | string | Social Facebook |
PreDMARCFromEmail | string | Pre DMARC From Email |
TimeZone | string | Time Zone |
TimeStamp | string | Time Stamp |
Offset | string | Offset |
HasCommunity | string | Has Community |
CommunityCategoryID | string | Community Category ID |
CommunityTags | string | Community Tags |
HasArchive | string | Has Archive |
HasShareURL | string | Has Share URL |
IsHVSClient | string | Is HVS Client |
TemplateSaved | string | Template Saved |
TargetCount | string | Target Count |
IsABSplit | string | Is ABSplit |
IsRSS | string | Is RSS |
IsAutoresponder | string | Is Autoresponder |
EmailType | string | Email Type |
ContactLists | ContactListData | Contact Lists |
ExcludeContactLists | ContactListData | Exclude Contact Lists |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
IsSegment | string | IsSegment |
SegmentID | string | Segment ID/td> |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Data | SchemeListData | Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Error | Array of ErrorData | Array of errors |
Data | SchemeListData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Colors | Array of string | Colors |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Data | LayoutListData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Image | string | Image |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Data | TemplateCategoryData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Count | int | Count |
IsNew | int | Is New |
Category | TemplateCategoryData | Category |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Data | TemplateData | Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | TemplateSingleData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
CategoryID | string | Category ID |
CategoryName | string | Category Name |
PreviewImage | string | Preview Image |
PreviewLargeImage | string | Preview Large Image |
Type | string | Type |
CreatedBy | string | Created By |
Content | string | Content |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
CommunityName | string | Community Name |
IsCommunity | string | Is Community |
TagName | string | Tag Name |
CategoryName | string | Category Name |
CategoryID | string | Category ID |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Status | string | 1 if successful, -1 if error |
Lists | ListData | Array of ListData |
Version | string | Version |
CreatedDate | string | Created Date |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Status | string | 1 if successful, -1 if error |
Lists | ListData | Array of Lists |
Fields | FieldData | Array of Fields |
Version | string | Version |
CreatedDate | string | Created Date |
Title | string | Title |
introduction | string | Introduction |
Button | string | Button |
LogoURL | string | Logo URL |
JSCode | string | JS Code |
HTMLCode | string | HTML Code |
HasMarketing | string | Has Marketing |
TemplateID | string | Template ID |
MenuSortOrder | string | Menu Sort Order |
ThemeID | string | Theme ID |
Style | string | Style |
DesignCode | string | Design Code |
IsCustomSuccessURL | string | Is Custom Success URL |
SuccessURL | string | Success URL |
StandardSuccessURL | string | Standard Success URL |
IsCustomConfirmationURL | string | Is Custom Confirmation URL |
ConfirmationURL | string | Confirmation URL |
StandardConfirmationURL | string | Standard Confirmation URL |
WelcomeMessage | WelcomeMessageData | Welcome Message |
Parameter | Type | Description |
---|---|---|
Content | string | Content |
Subject | string | Subject |
ClosingSignature | string | Closing Signature |
ConfirmationLink | string | Confirmation Link |
FromName | string | From Name |
FromEmail | string | From Email |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailOpenData | Data |
Count | int | Count |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
string | ||
Name | string | Name |
Device | string | Device |
Date | string | Date |
Parameter | Type | Description |
---|---|---|
string | ||
Name | string | Name |
Date | string | Date |
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
Parameter | Type | Description |
---|---|---|
string | ||
Name | string | Name |
Date | string | Date |
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailUnsubscribeData | Data |
Summary | UnsubscribeReasonCountData | Summary |
Parameter | Type | Description |
---|---|---|
string | ||
Name | string | Name |
Date | string | Date |
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
Reason | string | Reason |
Parameter | Type | Description |
---|---|---|
CountReason1 | string | Count Reason 1 |
CountReason2 | string | Count Reason 2 |
CountReason3 | string | Count Reason 3 |
CountReason4 | string | Count Reason 4 |
CountReason5 | string | Count Reason 5 |
CountReasonUnspecified | string | Count Reason Unspecified |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | ReportDataGeneric | Data |
Count | int | Count |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
string | ||
Date | string | Date |
Name | string | Name |
ContactID | string | ContactID |
ContactMasterID | string | Contact Master ID |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
ListName | string | List Name |
ListDescription | string | List Description |
ReportTypeText | string | Report Type Text |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | string | Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailUnopenedData | Data |
Count | int | Count |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponders |
Parameter | Type | Description |
---|---|---|
ContactID | string | Contact ID |
ContactMasterID | Array of ErrorData | Contact Master ID |
string | ||
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | ReportDataGeneric | Data |
Count | int | Count |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailClickMapData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
string | ||
Name | string | Name |
Count | string | Count |
Date | string | Date |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailBounceData | Data |
Count | int | Count |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
ContactID | string | Contact ID |
ContactMasterID | string | Contact Master ID |
string | ||
Name | string | Name |
ReportType | string | Report Type |
Date | string | Date |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Emails | EmailAbuseCampaignData | Emails |
Count | int | Count |
HotmailISP | string | Hotmail ISP |
AOLISP | string | AOL ISP |
YahooISP | string | Yahoo ISP |
OthersISP | string | Others ISP |
AbuseLinkISP | string | Abuse Link ISP |
Total | string | Total |
YourComplaintRate | string | Your Complaint Rate |
TotalSent | string | Total Sent |
Subject | string | Subject |
Name | string | Name |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
string |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailAbuseData | Data |
Count | int | Count |
TotalCount | string | Total Count |
Total | string | Total |
YourComplaintRate | string | Your Complaint Rate |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
string | ||
ShortEmail | string | Short Email |
Date | string | Date |
Recepient | string | Recepient |
Abuse | string | Abuse |
AbusePercent | string | Abuse Percent |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Data | ReportSummaryData | Data |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | ReportSummaryData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
string | ||
Subject | string | Subject |
Zone | string | Zone |
Sent | Double | Sent |
Opens | Double | Opens |
Bounces | Double | Bounces |
Clicks | Double | Clicks |
Unsubscribes | Double | Unsubscribes |
Complaints | Double | Complaints |
Forwards | Double | Forwards |
UnOpens | Double | UnOpens |
SentDate | string | Sent Date |
Recepients | string | Recepients |
CommunityURL | string | Community URL |
InCommunity | int | In Community |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
ScheduleDate | string | Schedule Date |
FromName | string | From Name |
FromEmail | string | From Email |
CanReUse | string | Can Reuse |
ReplyEmail | string | Reply Email |
Version | string | Version |
IsRSS | string | Is RSS |
RSSURL | string | RSS URL |
RSSSchedule | string | RSS Schedule |
IsRSSActive | string | Is RSS Active |
IsAutoresponder | string | Is Autoresponder |
IsABSplit | string | Is ABSplit |
ShareURL | string | Share URL |
Status | string | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | string | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailCompareData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Sequence | string | Sequence |
EmailName | string | Email Name |
ShortEmailName | string | Short Email Name |
Subject | string | Subject |
Schedule | string | Schedule |
Sent | string | Sent |
Opens | string | Opens |
PercOpens | string | Opens Percentage |
Clicks | string | Clicks |
PercClicks | string | Clicks Percentage |
Unsubscribes | string | Unsubscribes |
PercUnsubscribes | string | Unsubscribes Percentage |
Bounces | string | Bounces |
PercBounces | string | Bounces Percentage |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailCompareGraphData | Data |
Count | int | Count |
GraphHeight | string | Graph Height |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Sequence | string | Sequence |
EmailName | string | Email Name |
ScheduleDate | string | Schedule Date |
EmailSubject | string | Email Subject |
TotalSent | string | Total Sent |
TotalOpens | string | Total Opens |
TotalOpenPer | string | Total Opens Percentage |
TotalUnsubscribe | string | Total Unsubscribes |
TotalUnsubscribePer | string | Total Unsubscribes Percentage |
TotalClick | string | Total Clicks |
TotalClickPer | string | Total Clicks Percentage |
TotalBounce | string | Total Bounces |
TotalBouncePer | string | Total Bounces |
TotalAbuse | string | Total Abuses |
TotalAbusePer | string | Total Abuse Percentage |
TotalUnopen | string | Total Unopens |
TotalUnopenPer | string | Total Unopens Percentage |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
EmailName | string | Email Name |
Subject | string | Subject |
AutoresponderName | string | Autoresponder Name |
Completed | Double | Completed; |
MailSent | string | Mail Sent |
Opens | string | Opens |
OpenPer | string | Opens Percentage |
Clicks | string | Clicks |
ClickPer | string | Clicks Percentage |
Unsubscribes | string | Unsubscribes |
UnsubscribePer | string | Unsubscribes Percentage |
Bounces | string | Bounces |
BouncePer | string | Bounces Percentage |
Abuse | string | Abuse |
AbusePer | string | Abuse Percentage |
Unopened | string | Unopened |
UnopenedPer | string | Unopens Percentage |
Share | string | Share |
Error | ErrorData | List of errors |
Data | EmailSummaryData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Sequence | string | Sequence |
EmailName | string | Email Name |
ScheduleDate | string | Schedule Date |
EmailSubject | string | Email Subject |
ShortNameUnsafe | string | Short Name Unsafe |
ShortName | string | Short Name |
TotalSent | string | Total Sent |
TotalOpen | string | Total Opens |
TotalOpenPer | string | Total Opens Percentage |
TotalUnsubscribe | string | Total Unsubscribes |
TotalUnsubscribePer | string | Total Unsubscribes Percentage |
TotalClick | string | Total Clicks |
TotalClickPer | string | Total Clicks Percentage |
TotalBounce | string | Total Bounces |
TotalBouncePer | string | Total Bounces Percentage |
TotalAbuse | string | Total Abuses |
TotalAbusePer | string | Total Abuses Percentage |
TotalUnopen | string | Total Unopens |
TotalUnopenPer | string | Total Unopens Percentage |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailClickPerformanceData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
URL | string | URL |
Clicks | string | Clicks |
TotalClicks | string | Total Clicks |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailOpensLocationData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailOpensLocationData | Data |
Map | string | Map |
Name | string | Name |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
Code | string | Code |
Name | string | Name |
Opens | string | Opens |
HasDrillDown | string | Has Drill Down |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailOpensLocationData | Data |
Map | string | Map |
Name | string | Name |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
Date | string | Date |
Opens | string | Opens |
Clicks | string | Clicks |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | ReportHeatMapData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
Sequence | string | Sequence |
ID | string | ID |
Percent | string | Percent |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | CampaignHistoryData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
SentType | int | Sent Type |
SentDate | string | Sent Date |
EmailCount | string | Email Count |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | LinkDetailData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
EmailName | string | Email Name |
Subject | string | Subject |
URL | string | URL |
IsAutoresponder | string | Is Autoresponder |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
EmailName | string | Email Name |
Data | RSSHistoryData | Data |
Count | int | Count |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
MailSent | string | MailSent |
Open | string | Open |
Click | string | Click |
Bounce | string | Bounce |
Complaint | string | Complaint |
Unsubscribe | string | Unsubscribe |
Date | string | Date |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Field | string | Field |
Code | string | Code |
Message | string | Message |
Extra | string | Extra |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
ImageSrc | string | Image Source |
ImageBar | string | Image Bar |
Style | string | Style |
ImagePreview | string | Image Preview |
Parameter | Type | Description |
---|---|---|
Name | string | Name |
Label | string | Label |
Column | string | Column |
Extra | List | Extra |
IsRequired | string | IsR equired |
IsEmail | string | Is Email |
IsIncluded | string | Is Included |
Order | int | Order |
Parameter | Type | Description |
---|---|---|
Name | string | Name |
Label | string | Label |
Column | string | Column |
Extra | List | Extra |
IsEmail | string | Is Email |
IsRequired | string | Is Required |
Type | string | Type |
Order | int | Order |
Parameter | Type | Description |
---|---|---|
Badge | Badge | Badge |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Data | EmailExtraData | Data |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
TargetCount | string | Target Count |
IsHVSClient | string | Is HVS Client |
ListLimit | string | List Limit |
Parameter | Type | Description |
---|---|---|
Name | string | Name |
CSSCode | string | CSS Code |
Parameter | Type | Description |
---|---|---|
FacebookShareCount | string | Facebook Share Count |
FacebookLikeCount | string | Facebook Like Count |
TwitterCount | string | Twitter Count |
LinkedInCount | string | LinkedIn Count |
Status | string | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
ListDescription | string | List Description |
ContactMasterID | string | ID of the list |
Error | ErrorData | List of errors |
Data | ReportDownloadData | Data |
ListName | string | List Name |
EmailName | string | Email Name |
EmailSentName | string | Email Sent Name |
EmailSubject | string | Email Subject |
MailType | string | Mail Type |
ReportType | string | Report Type |
Count | int | Count |
HasPin | int | Has Pin |
Parameter | Type | Description |
---|---|---|
Sequance | string | Sequence |
FieldName | string | Field Name |
FieldLabel | string | Field Label |
Parameter | Type | Description |
---|---|---|
Status | string | Sequence |
Error | ErrorData | List of errors |
Content | string | Content |
Parameter | Type | Description |
---|---|---|
ScheduledDate | string | Scheduled Date |
ScheduledTime | string | Scheduled Time |
WinnerType | string | Winner Type like 1.Subject / From ,2.Camp. Vs. Camp ,3.Multiple Variables |
OpenScore | string | Open Score |
ClickScore | string | Click Score |
WinnerDate | string | Winner Date |
WinnerRelativeDuration | string | Winner Relative Duration |
TimeZone | string | TimeZone |
IsHVS | string | 1=Yes,0=No |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Results | Array of ABResult | Array of ABResult |
FinalResult | ABResultFinal | Final Result |
Parameter | Type | Description |
---|---|---|
ID | string | AB ID |
Date | string | Shcedule Date |
DateLong | string | Shcedule Date Long |
Duration | string | Duration |
TimeElapsed | string | Time Elapsed |
Sent | int | Mail Sent |
SentCurrent | int | Sent Current |
Open | int | Total Opens |
OpenCurrent | int | Open Current |
Click | int | Total Clicks |
ClickCurrent | int | Click Current |
Unsubscribe | int | Total Unsubscribes |
UnsubscribeCurrent | int | Unsubscribe Current |
Bounce | int | Total Bounces |
BounceCurrent | int | Bounce Current |
OpenScore | float | Open Score |
OpenScoreCurrent | float | OpenScore Current |
ClickScore | float | Click Score |
Total | float | Total Click Score and Open Score |
ClickScoreCurrent | float | ClickScore Current |
TotalCurrent | float | Total Current |
Status | string | 1=success,-1 =fail |
Parameter | Type | Description |
---|---|---|
ID | string | Final unique ID |
Date | string | Schedule Date |
DateLong | string | Schedule Date Long |
Duration | string | Duration |
Sent | int | Total Sents |
Open | int | Total Opens |
Click | int | Total Clicks |
Unsubscribe | int | Total Unsubscribes |
Bounce | int | Total Bounce |
OpenScore | float | Open Score |
ClickScore | float | Click Score |
Total | float | Total of Open Score and Click Score |
Parameter | Type | Description |
---|---|---|
ListID | string | List ID |
IsSegment | string | 1=Yes,0=NO |
SegmentID | string | Segment ID |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Count | int | Count |
Data | ABSplitData |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Error | Array of ErrorData | Array of errors |
Data | SchemeListData |
Parameter | Type | Description |
---|---|---|
Variables | Array of ABSplitVariableData | Array of ABSplitVariableData |
Parameter | Type | Description |
---|---|---|
ID | string | AB ID |
Name | string | AB Name |
Type | string | AB Type like 1.Subject / From, 2.Camp. Vs. Camp., 3.Multiple Variables, 4.Delivery |
Count | string | AB Group Size |
Percent | string | AB Percent |
Sent | string | Sent |
Status | string | Status |
ScheduledDate | string | Scheduled Date |
ScheduledTime | string | Scheduled Time |
ScheduleDateLong | string | Schedule Date Long |
WinnerType | string | Winner Type |
OpenScore | string | Open Score |
ClickScore | string | Click Score |
WinnerDate | string | Winner Date |
WinnerDateLong | string | Winner Date Long |
WinnerRelativeDuration | string | Winner Relative Duration |
TimeZone | string | Time Zone |
WinnerID | string | Winner ID |
Winner | string | Winner |
WinnerSelectionDate | string | Winner Selection Date |
WinnerSelectionDateLong | string | Winner Selection Date Long |
WinnerEmailID | string | Winner Email ID |
Variables | Array of ABSplitVariableData | Array of ABSplitVariableData |
IncludeList | Array of ABSplitListData | Array of ABSplitListData |
ExcludeList | Array of ABSplitListData | Array of ABSplitListData |
Parameter | Type | Description |
---|---|---|
Name | string | Name |
FromName | string | From Name |
Subject | string | Subject |
EmailID | string | Email ID |
FromEmail | string | From Email |
ReplyEmail | string | Reply Email |
HasPermissionReminder | string | 1=Yes,0=No |
PermissionReminderMessage | string | Permission Reminder Message |
Date | string | Date |
Time | string | Time |
TimeZone | string | Time Zone |
IsWinner | string | 1=Yes,0=No |
DateLong | string | Date Long |
Parameter | Type | Description |
---|---|---|
ID | string | ID |
Name | string | Name |
Type | string | AB Type |
Count | string | Count |
Percent | string | Percent |
Parameter | Type | Description |
---|---|---|
ID | string | AB ID |
Name | string | AB Name |
Type | string | AB Type |
Status | string | AB Status Draft = 0, Scheduled = 1, Sending = 2, Complete = 3, DetermingWinner = 301, WinnerScheduled = 302, Suspended = 4, SendingWinner = 5, Finished = 6 , Review = -2 |
ModifiedDate | string | Modified Date |
StartDate | string | Start Date |
EndDate | string | End Date |
Count | string | AB Group Size |
Lists | string | Contact Lists Name |
Emails | string | Tempale Name |
Parameter | Type | Description |
---|---|---|
ListName | string | List Name |
Parameter | Type | Description |
---|---|---|
EmailID | string | Unique ID |
Name | string | Template Name |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Data | ReportData | Array contain report data |
Count | int | Total Records |
Parameter | Type | Description |
---|---|---|
ID | string | Unique ID |
AbID | string | Ab ID |
EmailName | string | Tempale Name |
Status | string | Status like sent |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
ScheduleDate | string | Schedule Date |
RssURL | string | RSS Feed |
CommunityURL | string | Community URL |
IsFavorite | string | 1=Yes,0=No |
isSegment | int | 1=Yes,0=No |
ListName | string | List Name |
ListID | int | List ID |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 error |
Data | ReportSummaryData | Array of summary data |
Parameter | Type | Description |
---|---|---|
ID | string | Unique ID |
Name | string | Email Name |
ABEmailID | string | New Email ID |
Subject | string | Tempate Subject |
Zone | string | Zone |
Sent | double | Mail Sent |
Opens | double | Total Opens |
Bounces | double | Total Bounces |
Clicks | double | Total Clicks |
Unsubscribes | double | Total Unsubscribes |
Complaints | double | Totalo Complaints |
Forwards | double | Total Forwards |
UnOpens | double | Total UnOpens |
SentDate | string | Sent Date |
Recepients | string | Recepients |
CommunityURL | string | CommunityURL |
InCommunity | int | 1=Yes,0=No |
CreatedDate | string | Created Date |
ModifiedDate | string | Modified Date |
ScheduleDate | string | Schedule Date |
FromName | string | From Name |
FromEmail | string | From Email |
CanReUse | string | 1=Yes,0=No |
ReplyEmail | string | Reply Email |
Version | string | Version |
IsRSS | string | 1=Yes,0=No |
RSSSchedule | string | RSS Schedule |
IsRSSActive | string | 1=Yes,0=No |
IsAutoresponder | string | 1=Yes,0=No |
ShareURL | string | Share URL |
Status | string | 1=Success,0=Fail |
GroupA | string | Unique ID 1 |
GroupB | string | Unique ID 2 |
GroupC | string | Unique ID 3 |
Remainder | string | Final Unique ID |
GroupAType | string | Group Type like WINNER,LOSER |
GroupBType | string | Group Type like WINNER,LOSER |
GroupCType | string | Group Type like WINNER,LOSER |
ContactLists | Array Of ContactListData |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 error |
Data | Array of ReportCompareData |
Parameter | Type | Description |
---|---|---|
EmailID | string | Final ID |
ABID | string | AB ID |
EmailType | string | like GROUP_A,GROUP_C,GROUP_B |
isWinner | int | 1=Yes,0=No |
SentOn | string | Sent On |
Sent | string | mai Sent |
Opens | string | Total Opens |
Clicks | string | Total Clicks |
UnSubscribes | string | Total UnSubscribes |
Bounces | string | Total Bounces |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Title | string | Title |
Detail | string | Detail |
ErrorCode | string | Error Code |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Data | string | Data |
ErrorCode | string | Error Code |
Parameter | Type | Description |
---|---|---|
MinRating | string | Minimum Rating |
MaxRating | string | Maximum Rating |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Count | string | Count |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Errors | ErrorData | List of errors |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Error | ErrorData | Error |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Errors | ErrorData | List of Errors |
ID | string | ID |
Detail | string | Detail |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Errors | ErrorData | List of Errors |
Data | NotificationData | List of notifications |
Parameter | Type | Description |
---|---|---|
Icon | string | Icon |
Title | string | Title |
Body | string | Body |
CreatedDateMDY | string | Created date in MDY format |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of Errors |
PlanID | string | ID of the plan |
IsFreePlan | string | Whether the client is on a free plan or not |
Duration | string | Duration |
DiscountName | string | Discount Name |
DiscountPercent | string | Discount Percent |
ProductLabel | string | Product Label |
ProductPrice | string | Product Price |
CurrencyPrefix | string | Currency Prefix |
OtherProductPrice | string | Other Product Price |
RenewalDate | string | Renewal Date |
StartDate | string | Start Date |
PlanCycle | string | Plan Cycle |
DayDifference | string | Day Difference |
Parameter | Type | Description |
---|---|---|
Status | string | 1 if successful, -1 if error |
Error | ErrorData | List of Errors |
PlanID | string | ID of the plan |
Duration | string | Duration |
IsFuture | string | Is Future |
Parameter | Type | Description |
---|---|---|
entry | EstimateEntry | entry |
IsProRated | String | Is Pro Rated |
IsFuture | String | Is Future |
IsSame | String | Is Same |
Status | String | Status |
PlanID | String | Plan ID |
Duration | String | Duration |
CurrencyPrefix | String | Currency Prefix |
Parameter | Type | Description |
---|---|---|
Language | String | Language |
PermissionPositionHeader | String | Permission Position Header |
TimeZone | String | Time Zone |
FooterID | String | Footer ID |
SenderID | String | Sender ID |
FromName | String | From Name |
FromEmail | String | From Email |
SignatureEmail | String | Signature Email |
SignatureName | String | Signature Name |
SignatureURL | String | Signature URL |
Token | String | Token |
SiteLanguage | String | Site Language |
Company | SettingCompanyData | Company |
Parameter | Type | Description |
---|---|---|
Website | String | Website |
LogoURL | String | Logo URL |
Name | String | Name |
Phone | String | Phone |
Address | String | Address |
City | String | City |
State | String | State |
Zip | String | Zip |
Country | String | Country |
CategoryID | String | Category ID |
Parameter | Type | Description |
---|---|---|
Description | String | Description |
Amount | String | Amount |
ExtraInfo | String | Extra Information |
Code | String | Code |
Parameter | Type | Description |
---|---|---|
plans | PlanInfo | List of plans |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
Name | String | Name |
Price | String | Price |
ListLimit | String | List Limit |
EmailLimit | String | Email Limit |
Overage | String | Overage |
Parameter | Type | Description |
---|---|---|
Addon | AddonResult | Add on |
EmailPlan | EmailPlanResult | Email Plan |
EventPlan | EventPlanResult | Event Plan |
ActiveContacts | String | Active Contacts |
AccountContacts | String | Account Contacts |
TotalContacts | String | Total Contacts |
ContactsPercent | String | Contacts Percent |
IsDedicated | String | Is Dedicated |
IsManual | String | Is Manual |
CreditAmount | String | Credit Amount |
CanUpgrade | String | Can Upgrade |
CurrencyCode | String | Currency Code |
CurrencyPrefix | String | Currency Prefix |
ClientCountry | String | Client Country |
HasCard | String | Has Card |
Parameter | Type | Description |
---|---|---|
IsFreePlan | String | Is Free Plan |
IsUnLimited | String | Is UnLimited |
ExpireDate | String | Expire Date |
ExpireDateMDY | String | Expire Date in MDY format |
IsExpired | String | Is Expired |
HasCancelled | String | Has Cancelled |
CancellationDate | String | Cancellation Date |
CancellationDateMDY | String | Cancellation Date in MDY Format |
PlanPrice | String | Plan Price |
PlanName | String | Plan Name |
PlanID | String | Plan ID |
TotalEvent | String | Total Event |
CurrentEvent | String | Current Event |
EventPercent | String | Event Percent |
FuturePlanID | String | Future Plan ID |
FutureIsAnnualPlan | String | Future Is Annual Plan |
FutureDate | String | Future Date |
FuturePlanName | String | Future Plan Name |
HasFuture | String | Has Future |
Parameter | Type | Description |
---|---|---|
IsFreePlan | String | Is Free Plan |
IsListBased | String | Is List Based |
IsUnLimited | String | Is Unlimited |
StartDate | String | Start Date |
StartDateMDY | String | Start Date in MDY format |
ExpireDate | String | Expire Date |
ExpireDateMDY | String | Expire Date in MDY format |
IsExpired | String | Is Expired |
Annual | String | Annual |
HasCancelled | String | Has Cancelled |
CancellationDate | String | Cancellation Date |
CancellationDateMDY | String | Cancellation Date in MDY format |
EmailLimit | String | Email Limit |
PlanPrice | String | Plan Price |
OverageAmount | String | Overage Amount |
CurrentLimit | String | Current Limit |
PlanName | String | Plan Name |
PlanID | String | Plan ID |
TotalEmail | String | Total Email |
CurrentEmail | String | Current Email |
EmailPercent | String | Email Percent |
FuturePlanID | String | Future Plan ID |
FutureIsAnnualPlan | String | Future Is Annual Plan |
FutureAddOn | String | Future Add On |
FutureDate | String | Future Date |
FuturePlanName | String | Future Plan Name |
HasFuture | String | Has Future |
EmailDiscountName | String | Email Discount Name |
EmailDiscountPercent | String | Email Discount Percent |
EmailDiscountAmount | String | Email Discount Amount |
Parameter | Type | Description |
---|---|---|
AdditionalIPCount | String | Additional IP Count |
HasAdditionalIP | String | Has Additional IP |
IPPrice | String | IP Price |
IPExpireDate | String | IP Expire Date |
IPExpireDateMDY | String | IP ExpireDate in MDY format |
IPExpired | String | IP Expired |
IPCancellationDate | String | IP Cancellation Date |
IPCancellationDateMDY | String | IP Cancellation Date in MDY format |
ImageHostingPrice | String | Image Hosting Price |
HasImageHosting | String | Has Image Hosting |
ImageExpired | String | Image Expired |
TotalImage | String | Total Image |
CurrentImage | String | Current Image |
ImagePercent | String | Image Percent |
ImageExpireDate | String | Image Expire Date |
ImageExpireDateMDY | String | Image Expire Date in MDY format |
ImageCancellationDate | String | Image Cancellation Date |
ImageCancellationDateMDY | String | Image Cancellation Date in MDY format |
InboxPrice | String | Inbox Price |
InboxBalance | String | Inbox Balance |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
Name | String | Name |
EmailLimit | String | Email Limit |
ListLimit | String | List Limit |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Data | SubAccountPlan | Data |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Errors | ErrorData | Errors |
Data | SubAccountDetail | Data |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
HasAllowCC | String | Has Allow CC |
AllowCC | String | Allow CC |
ID | String | ID |
FirstName | String | First Name |
LastName | String | Last Name |
Phone | String | Phone |
EmailAddress | String | Email Address |
Login | String | Login |
PlanID | String | Plan ID |
Password | String | Password |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Data | LinkAccountDetail | Data |
Errors | ErrorData | Errors |
Count | String | Count |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Data | LinkAccountDetail | Data |
Errors | ErrorData | Errors |
Count | String | Count |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
ClientID | String | Client ID |
FirstName | String | First Name |
LastName | String | Last Name |
Alias | String | Alias |
AccountExpire | String | Account Expire |
Status | String | 1 if successful, -1 if error |
Login | String | Login |
PlanName | String | Plan Name |
MailSent | String | Mail Sent |
Parameter | Type | Description |
---|---|---|
Errors | ErrorData | Errors |
Status | String | 1 if successful, -1 if error |
SubAccountBuy | String | Sub Account Buy |
SubAccountUsed | String | Sub Account Used |
SubAccountID | String | Sub Account ID |
Buy | String | Buy |
Used | String | Used |
Parameter | Type | Description |
---|---|---|
Data | SubAccountCampaign | Data |
Status | String | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
CampaignSent | String | Campaign Sent |
Parameter | Type | Description |
---|---|---|
Name | String | Name |
Token | String | Token |
Secret | String | Secret |
AuthURL | String | Authentication URL |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Errors | ErrorData | Errors |
Parameter | Type | Description |
---|---|---|
Data | GenericList | Data |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
Value | String | Value |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Error | ErrorData | List of errors |
Emails | string | List of Emails |
Parameter | Type | Description |
---|---|---|
Count | Int32 | Count |
Status | String | 1 if successful, -1 if error |
Data | ClientDetail | Data |
HasInbox | String | Has Inbox |
HasClientAccounts | String | Has Client Accounts |
HasDates | String | Has Dates |
UniqueCount | String | Unique Count |
Parameter | Type | Description |
---|---|---|
Data | ClientDate | Data |
Status | String | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
StartDate | String | Start Date |
EndDate | String | End Date |
Parameter | Type | Description |
---|---|---|
PlanID | String | Plan ID |
PlanName | String | Plan Name |
ID | String | ID |
Name | String | Name |
FirstName | String | First Name |
LastName | String | Last Name |
Login | String | Login |
ActiveContacts | String | Active Contacts |
CampaignsSent | String | Campaigns Sent |
Active | String | Active |
InboxAlloted | String | Inbox Alloted |
InboxUsed | String | Inbox Used |
Parameter | Type | Description |
---|---|---|
Count | Int32 | Count |
Status | String | 1 if successful, -1 if error |
Data | ClientFilterDomain | Data |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Error | ErrorData | Error |
Data | ClientListUploadTerms | Data |
Parameter | Type | Description |
---|---|---|
AgreeDate | String | Agree Date |
Agree | String | Agree |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
AbuseDomain | String | Abuse Domain |
CreatedDate | String | Created Date |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
Name | String | Name |
Errors | ErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Count | Int32 | Count |
Status | String | 1 if successful, -1 if error |
Data | InvoiceListData | Data |
Parameter | Type | Description |
---|---|---|
Sequence | Int32 | Sequence |
ID | String | ID |
PdDateValue | String | Pd Date Value |
PdDetailValue | String | Pd Detail Value |
AmountValue | String | Amount Value |
IsPaid | String | Is Paid |
Parameter | Type | Description |
---|---|---|
Sequence | Int32 | Sequence |
ID | String | ID |
CompanyName | String | Company Name |
Address | String | Address |
City | String | City |
State | String | State |
Zip | String | Zip |
Country | String | Country |
Client | String | Client |
BillingID | String | Billing ID |
PayDate | String | Pay Date |
PayMethod | String | Pay Method |
TotalAmount | String | Total Amount |
DefaultHeight | String | Default Height |
InvoicePayableLists | List`1 | Invoice Payable Lists |
Parameter | Type | Description |
---|---|---|
Description | String | Description |
PayDate | String | Pay Date |
Amount | String | Amount |
Parameter | Type | Description |
---|---|---|
Count | Int32 | Count |
Status | String | Status |
Data | List`1 | Data |
Parameter | Type | Description |
---|---|---|
Sequence | Int32 | Sequence |
ID | String | ID |
String | ||
IsConfirmed | String | 1=Yes,0=No |
DateValue | String | Date Value |
ReSend | String | ReSend |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
Status | String | Status |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Message | String | Message |
Success | String | Success |
FinalString | String | Final String |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
FirstName | String | First Name |
LastName | String | Last Name |
PhoneNo | String | Phone No |
String | ||
Login | String | Login |
isFree | String | 1=Yes,0=No |
isAllowed | String | 1=Yes,0=No |
isPin | String | 1=Yes,0=No |
ListBased | String | List Based |
Contacts | String | Contacts |
ContactLimit | String | Contact Limit |
ImageUsed | String | Image Used |
ImageLimit | String | Image Limit |
EmailUsed | String | Email Used |
EmailLimit | String | Email Limit |
PlanCycle | String | Plan Cycle |
Country | String | Country |
PaymentMode | String | Payment Mode |
HasDedicatedIP | String | 1=Yes,0=No |
CCExpireDate | String | CC Expire Date |
AllowSubAccounts | String | 1=Yes,0=No |
RegionCode | String | Region Code |
RegionName | String | Region Name |
ContactCount | String | Contact Count |
ListSize | String | List Size |
ClientStatus | String | Client Status |
ExpireDate | String | Expire Date |
ExpireDateMDY | String | Expire Date MDY |
SuspendDate | String | Suspend Date |
SuspendDateMDY | String | Suspend Date MDY |
CancelDate | String | Cancel Date |
CancelDateMDY | String | Cancel Date MDY |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
retVal | String | retVal |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
String | ||
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Address | String | Address |
City | String | City |
State | String | State |
Zip | String | Zip |
Country | String | Country |
Status | String | Status |
CardData | List`1 | CardData |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Sequence | Int32 | Sequence |
ID | String | ID |
Preferred | String | Preferred |
CardType | String | Card Type |
CardNumber | String | Card Number |
CardName | String | Card Name |
CardExpiry | String | Card Expiry |
CardAddress | String | Card Address |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
CardType | String | Card Type |
CardNumber | String | Card Number |
CardName | String | Card Name |
CardExpiry | String | Card Expiry |
CardCSV | String | Card CSV |
Address | String | Address |
Zip | String | Zip |
Country | String | Country |
Status | String | Status |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
IsResponsive | String | 1=Yes,0=No |
Status | String | Status |
Errors | List`1 | Errors |
Parameter | Type | Description |
---|---|---|
Client ID | String | Client ID |
String | ||
First Name | String | First Name |
Emails Sent | String | Emails Sent |
Bounces | String | Bounces |
Opens | String | Opens |
Client Rating | String | Client Rating |
Address | String | Address |
Zip | String | Zip |
Created Date | String | Created Date |
Login | String | Login |
Plan ID | String | Plan ID |
Plan Name | String | Plan Name |
Country Code | String | Country Code |
Last Name | String | Last Name |
Client Status | String | Client Status |
Business Phone | String | Business Phone |
Business City | String | Business City |
Business Country | String | Business Country |
Modified Date | String | Modified Date |
category | String | category |
Origin Url | String | Origin Url |
Phone | String | Phone |
Company | String | Company |
Client Products | String | Client Products |
Business State | String | Business State |
Language | String | Language |
ELanguage | String | ELanguage |
Paid_Or_Free | String | Paid_Or_Free |
Confirmed | String | Confirmed |
Payment Mode | String | Payment Mode |
Has Dedicated IP | String | Has Dedicated IP |
CC Expire Date | String | CC Expire Date |
Allow Sub Accounts | String | Allow Sub Accounts |
Region Code | String | Region Code |
Region Name | String | Region Name |
Contact Count | String | Contact Count |
List Size | String | List Size |
State | String | State |
Experience | String | Experience |
Renewal Date | String | Renewal Date |
Parameter | Type | Description |
---|---|---|
Count | int | Number of Videos |
Status | String | Status |
Data | VideoData | List of Videos |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Data | VideoData | Details of a Video |
Parameter | Type | Description |
---|---|---|
ID | String | Video ID |
Name | String | Video Name |
Description | String | Description |
Embed | String | Embed |
Height | String | Height |
Width | String | Width |
Image | String | Image |
Createddatetime | String | Created Date |
Src | String | Source Url |
Errors | ErrorData |
Parameter | Type | Description |
---|---|---|
PremiumClient | Int | Premium Client |
FreePlan | Int | Free Plan |
Limit | Int | Limit |
Used | Int | Used |
Count | Int | Count |
Status | String | Status |
Data | ArchiveData | Array of Archive Data |
Parameter | Type | Description |
---|---|---|
Sequence | Int | Sequence |
ID | String | Archive ID |
Name | String | Email Name |
Status | String | 1 = status, -1 = error |
EmailID | String | Email Address |
SentDate | String | Sent Date |
isArchived | Boolean | isArchived |
ImageTitle | String | Image Title |
URL | String | URL |
Summary | String | Summary |
ArchiveRootURL | String | Archive Root URL |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
ArchiveURL | String | Archive URL |
Share | String | Share |
SharePanel | String | Share Panel |
Domain | String | Domain |
ArchiveRootURL | String | Archive Root URL |
Image | String | Image |
Status | String | Status |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Code | String | Code |
ArchiveURL | String | Archive URL |
Status | String | Status |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Image | String | Image |
Status | String | Status |
Parameter | Type | Description |
---|---|---|
ID | String | Archive ID |
Name | String | Archive Name |
Order | String | Order |
ImageURL | String | Image URL |
Date | String | Sent Date |
Summary | String | Summary |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Count | Int | Count |
Status | String | Status |
HideThumbnail | String | Hide Thumbnail |
ArchiveIDs | String | Archive IDs |
Data | ArchivePageData | Array of Data |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Data | ArchiveHomePageData | Data |
Parameter | Type | Description |
---|---|---|
Header | String | Header Text |
PageTitle | String | Title of a Page |
Intro | String | Introduction Text |
Footer | String | Footer Text |
ImageLogo | String | Image Logo URL |
ListBuilderID | String | ListBuilder ID |
Form | String | Form |
CSS | ArchiveHomeCSSData | CSS |
Errors | ArchiveErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Content | String | Content |
CompanyName | String | Company Name |
ShowBody | Boolean | Show Body |
Status | String | Status |
Parameter | Type | Description |
---|---|---|
Header | Properties | Header |
Intro | Properties | Intro |
Footer | Properties | Footer |
Logo | Properties | Logo |
Archive | Properties | Archive |
Body | Properties | Body |
Parameter | Type | Description |
---|---|---|
PremiumClient | String | 1 if premium client, else 0 |
FreePlan | String | Free/Paid plan |
Limit | String | Max disk space |
Used | String | Utilised disk space |
Parameter | Type | Description |
---|---|---|
Count | String | Number of Images |
Status | String | 1 = successful, -1 = error |
Data | ImageData | Data |
Parameter | Type | Description |
---|---|---|
ID | String | Image ID |
URL | String | Image URL |
Name | String | Image Name |
Type | String | Image Type |
Width | String | Image Width |
ID | String | Image ID |
Height | String | Image Height |
Size | String | Image Size |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Data | GiphyImageData | Giphy Image Data |
Parameter | Type | Description |
---|---|---|
ID | String | Giphy Image ID |
OriginalURL | String | Image URL |
Width | String | Image Width |
Height | String | Image Height |
Parameter | Type | Description |
---|---|---|
Count | String | Number of help topics. |
Status | String | Status |
Data | HelpListData | List of help data |
Parameter | Type | Description |
---|---|---|
Sequence | String | Sequence |
ID | String | Help ID |
URL | String | Help FAQ URL |
Topic | String | Help Topic |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
Errors | HelpErrorData | Help Error Data |
Parameter | Type | Description |
---|---|---|
Status | String | Status |
ID | string | Ticket ID |
Errors | HelpErrorData | Help Error Data |
Parameter | Type | Description |
---|---|---|
Field | String | Error Field |
Code | String | Error Code |
Message | String | Error Message |
Parameter | Type | Description |
---|---|---|
Count | int | Number of Commission List |
Status | String | 1 = Successful, -1 Error |
Data | List PartnerCommissionsListData | List of Partner Commissions Data |
Parameter | Type | Description |
---|---|---|
Count | int | Number of Commission List |
Status | String | 1 = Successful, -1 Error |
Data | List PartnerCommissionsLevel1ListData | Partner Commission Level 1 Data |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | String | 1 = Successful, -1 Error |
ClientName | String | Name of Client |
Data | List PartnerCommissionsLevel2ListData | Partner Commission Level 2 Data |
Parameter | Type | Description |
---|---|---|
Count | int | Number of Commission List |
Status | String | 1 = Successful, -1 Error |
Data | List PartnerReferralsListData | List of Partner PartnerReferrals Data |
Parameter | Type | Description |
---|---|---|
Count | int | Count |
Status | String | 1 = Successful, -1 Error |
Data | List PartnerReferralsLevel1ListData | Partner Referrals Level 1 Data |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
ID | String | ID |
Current | String | Current |
New | String | New |
BilledAccounts | String | Billed Accounts |
Amount | String | Amount |
CommissionAmount | String | Commission Amount |
CommissionPercent | String | Commission Percent |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
ClientName | String | Client Name |
Amount | String | Amount |
CommissionAmount | String | Commission Amount |
CommissionPercent | String | Commission Percent |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
PayDate | String | Pay Date |
Amount | String | Amount |
CommissionAmount | String | Commission Amount |
CommissionPercent | String | Commission Percent |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
Level1 | String | |
lblPaid | String | Number of paid clients |
lblFree | String | Number of free clients |
lblTotal | String | Total Clients |
Parameter | Type | Description |
---|---|---|
Sequence | int | Sequence |
ClientName | String | Client Name |
PlanName | String | Plan Name |
SignupDate | String | Signup Date |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
ClientID | String | Client ID |
PartnerSignup | String | Partner Signup |
Prefix | String | Prefix |
Parameter | Type | Description |
---|---|---|
ID | String | ID |
ClientID | String | Client ID |
HtmlResponse | String | Html Response |
Parameter | Type | Description |
---|---|---|
FirstName | String | First Name |
LastName | String | Last Name |
CompanyName | String | Company Name |
CompanyPhone | String | Company Phone Number |
CompanyAddress | String | Company Address |
CompanyCity | String | Company City |
CompanyZip | String | Company Zip |
CompanyState | String | Company State |
CompanyCountry | String | Company Country |
MinimumUS | String | |
MinimumNonUS | String | |
isUSResidents | Int | 1 = yes, 0 = No |
TaxID | String | Tax ID |
isACHPayable | Int | 1 = yes, 0 = No |
ACHPayable | String | Partner ACH Payable |
BankRoutingNumber | String | Partner Bank Routing Number |
BankAccountNumber | String | Partner Bank Account Number |
CheckPayable | String | Payable Check |
PayPalName | String | Partner PayPal Name |
PayPalEmail | String | Partner Pay Pal Email |
PartnerAddress | String | Partner Address |
PartnerCity | String | Partner City |
PartnerState | String | Partner State |
PartnerZip | String | Zip Code; |
Parameter | Type | Description |
---|---|---|
FirstName | String | First Name |
LastName | String | Last Name |
CompanyName | String | Company Name |
CompanyPhone | String | Company Phone Number |
CompanyAddress | String | Company Address |
CompanyCity | String | Company City |
CompanyZip | String | Company Zip |
CompanyState | String | Company State |
CompanyCountry | String | Company Country |
MinimumUS | String | |
MinimumNonUS | String | |
isUSResidents | Int | 1 = Yes, 0 = No |
TaxID | String | Tax ID |
isACHPayable | Int | 1 = yes, 0 = No |
ACHPayable | String | Partner ACH Payable |
BankRoutingNumber | String | Partner Bank Routing Number |
BankAccountNumber | String | Partner Bank Account Number |
CheckPayable | String | Payable Check |
PayPalName | String | Partner PayPal Name |
PayPalEmail | String | Partner PayPal Email |
PartnerAddress | String | Partner Address |
PartnerCity | String | Partner City |
PartnerState | String | Partner State |
PartnerZip | String | Partner Zip Code |
Password | String | Password |
NewPassword | String | New Password |
ConfirmPassword | String | Password |
Parameter | Type | Description |
---|---|---|
Status | String | 1 = successful, -1 = error |
Errors | ErrorData | List of Errors |
Parameter | Type | Description |
---|---|---|
Count | String | Number of Polls |
Status | String | 1 = successful, -1 = error |
Data | PollData | Array of Poll Data |
Parameter | Type | Description |
---|---|---|
Status | String | 1 = successful, -1 = error |
Data | PollData | Array of Poll Data |
Errors | PollErrorData | Data |
Parameter | Type | Description |
---|---|---|
Sequence | String | Sequence |
ID | String | Poll ID |
Name | String | Poll Name |
Status | String | Status |
Question | String | Question |
Responses | Integer | Number of responses |
Options | ArrayList | List of Options |
CSS | CSSData | CSS Data |
Button | String | Button |
URL | String | Poll URL |
Code | String | Code |
ShareLink | String | ShareLink |
LiveDate | String | pOLL Live Date |
CreatedDate | Integer | Poll Created Date |
Options | ArrayList | Poll Modified Date |
Answers | AnswerData | Answers |
Parameter | Type | Description |
---|---|---|
Answer | Properties | Answer |
Header | Properties | Header |
Intro | Properties | Intro |
Logo | Properties | Logo |
Button | Properties | Button |
Title | Properties | Title |
Question | Properties | Question |
Form | FormProperties | Form Properties |
Parameter | Type | Description |
---|---|---|
Width | String | Width |
Ratio1 | String | Ratio1 |
Ratio2 | String | Ratio2 |
Option | String | Option |
Count | String | Count |
Parameter | Type | Description |
---|---|---|
Align | String | Alignment |
Bgcolor | String | Background color |
Color | String | Color |
Font | String | Font |
Size | String | Size |
Parameter | Type | Description |
---|---|---|
BackgroundColor | String | Background color |
BorderColor | String | Border Color |
Color | String | Color |
Parameter | Type | Description |
---|---|---|
Name | String | Name |
Status | String | 1 if successful, -1 if error |
ErrorStatus | String | Error Status |
Parameter | Type | Description |
---|---|---|
Name | String | Name |
Status | String | 1 if successful, -1 if error |
ErrorStatus | String | Error Status |
ContactList | String | Contact List |
ShopifyContact | String | Shopify Contact |
ShopifyProduct | String | Shopify Product |
FlagShopifyPurchaseProduct | String | Flag Shopify Purchase Product |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Url | String | Authentication URL |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Message | String | Message |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Parameter | Type | Description |
---|---|---|
Status | String | 1 if successful, -1 if error |
Data | String | Data |
ErrorStatus | String | Error Status |
MappedListFlag | Boolean | Mapped List Flag |