API Documentation


Hey Folks!!, Welcome to Plumb5 API Central

Plumb5 allows developers to connect and interact with data stored on Plumb5. Plumb5 allows the developer to access marketing data stored in Plumb5 and plug it to any custom app or third party apps. Plumb5 also allows applications to post back data to Plumb5 and tag back data to unified records.
This allows the developer to enable solutions to marketers to capture new data by maintaining unification and reduces marketing investments for years to come.

Account

GetAccounts

Methods for Getting Account List.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.

Example

http://api.plumb5.com/Account/GetAccounts

Analytics

GetVisits

Get visit report(session, unique/new visit, page view) by each day

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetVisits

GetCountry

Get Country report by session, page view ,unique/new/repeat visit

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetCountry

GetReturn

New vs. Repeat visitor report(session, unique/new/repeat visit, avg time) by each day

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetReturn

GetTimeonSite

Time on Site report by day, avg time, session, unique visit, page view

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetTimeonSite

GetVisitors

Get Audience by IpAddress, emailed, recency, city, score

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index
Key string Search Category
SearchText String Search text

Example

http://api.plumb5.com/Analytics/GetVisitors

GetCities

Get City report by session, page view ,unique/new/repeat visit

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetCities

GetFrequency

Get Frequency report by Unique Visitors,Page Views

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetFrequency

GetRecency

Get Recency report by Unique Visitors,Session,Page Views

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetRecency

GetTimeSpend

Get TimeSpend report by Session,Unique Visitors,Page Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetTimeSpend

GetPageDepth

Get Page Depth report by Session,Unique Visitors,Page Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetPageDepth

GetBrowsers

Get Browsers report by Page Views

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetBrowsers

GetDevices

Get Devices report by Page Views,Sessions,Unique Visits,New Visits,Return Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetDevices

GetNetworks

Get Networks report by Total Visits,Unique Visits,Sessions

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetNetworks

GetSources

Get Sources report by Direct Traffic,Search Traffic,Refer Traffic,Social Traffic

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetSources

GetReferrals

Get Refferals report by Source,Unique Visits,Page Depth,Page Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetReferrals

GetSearchTraffics

Get SearchTraffics report by Source,Unique Visits,Page Depth,Page Visits,Key

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetSearchTraffics

GetPaidCampaigns

Get PaidCampaigns report by PageViews,Session,Unique Visits,UTM Source

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index
Action string AdWords Action

Example

http://api.plumb5.com/Analytics/GetPaidCampaigns

GetSocialTraffics

Get SocialTraffics report by Unique Visits,Page Depth,Page Visit

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetSocialTraffics

GetPopularPages

Get PopularPages report by Page Views,Unique Visits,Maximum Visited City

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetPopularPages

GetEntryPages

Get EntryPages report by Page Title,Page Views,Unique Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetEntryPages

GetExitPages

Get ExitPages report by Page Title,Page Views,Unique Visits,Bounce Rate

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetExitPages

GetEventTracking

Get EventTracking report by Total Clicks,Page Name,Unique Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetEventTracking

GetProductDetails

Get ProductDetails report by Product Views,Unique Views,Total Cart,Unique Cart,Total Complete,Unique Complete,Success Quantity

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetProductDetails

GetProductPerformances

Get ProductPerformances report by Product Views,Unique Views,Total Cart,Unique Cart,Drop Out,Order Complete,Unique Complete,Success Quantity

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index
ProductId int ProductId

Example

http://api.plumb5.com/Analytics/GetProductPerformances

GetSalePerformances

Get SalePerformances report by Product Views,Shopping Cart Sold,Unique Cart,Net Sold,Drop Out,Unique Complete

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index
ProductId int ProductId

Example

http://api.plumb5.com/Analytics/GetSalePerformances

GetMobileVisits

Get MobileVisits report by Sessions,Unique Visits,New Visitors

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileVisits

GetTimeonMobile

Get TimeonMobile report by Sessions,Unique Visits,New Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetTimeonMobile

GetMobileVisitors

Get MobileVisitors report by Device Id,Device Name,Session

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index
Key string Search Category
SearchText string Search Text

Example

http://api.plumb5.com/Analytics/GetMobileVisitors

GetMobileFrequency

Get MobileFrequency report by Visit Count,Unique Visitors

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileFrequency

GetMobileRecency

Get MobileRecency report by Unique Visitors,Session

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileRecency

GetMobileTimeSpend

Get MobileTimeSpend report by Session,Unique Visitors

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileTimeSpend

GetMobileEventTracking

Get MobileEventTracking report by Type,Value,Total Clicks,Unique Visits,Sessions

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileEventTracking

GetMobileDevice

Get MobileDevice report by Sessions,Unique Visits,New Visits,Return Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.
OffSet int 1 Start Index
FetchNext int 10 End Index

Example

http://api.plumb5.com/Analytics/GetMobileDevice

GetMobileOS

Get MobileOS report by Sessions,Unique Visits,New Visits,Return Visits

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd.
ToDate string yyyy-mm-dd.

Example

http://api.plumb5.com/Analytics/GetMobileOS

Contact

ImportContacts

Methods for importing contacts.(Method Type="POST").

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupId int Group Id
Columns string null column name seperated by ','
File Excel File(.xls) Your file should contains Columns eg:- Name, EmailId, PhoneNumber, Location, Age, Gender, MaritalStatus, Education, Occupation, Interests

Example

http://api.plumb5.com/Contact/ImportContacts

AddContacts

Methods for importing contacts.(Method Type="GET").

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Name string Name of the contact number
EmailId string EmailId of the contact
PhoneNumber string Phone Number of the contact
GroupId int Group Id (Optional)
Location string Location of the contact (Optional)
Age int Age of the contact (Optional)
Gender string Gender of the contact (Optional)
MaritalStatus string MaritalStatus of the contact (Optional)
Education string Education of the contact (Optional)
Occupation string Occupation of the contact (Optional)
Interests string Interests of the contact (Optional)
LeadType short int 0 for contact, 1 Lead and 2 for customer

Example

http://api.plumb5.com/Contact/AddContacts

GetContacts

Methods for getting Contacts

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index
AgeRange1 int null Filter by AgeRange1
AgeRange2 int null Filter by AgeRange2
GroupId int null Filter by GroupId
EmailId string null Filter by EmailId

Example

http://api.plumb5.com/Contact/GetContacts

GetGroups

Methods for ting Group List.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupName string null Group Name
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Contact/GetGroups

CreateOrUpdateGroup

Methods for Creating (Provide GroupName and Description)/Updating Groups (Provide GroupId,GroupName and Description).

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupId int 0 Existing GroupId to update groupName and description
GroupName string Group Name
Description string Group Description

Example

http://api.plumb5.com/Contact/CreateOrUpdateGroup

FilterContactsandaddtogroup

Methods for filtering Contacts and added to group

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index
AgeRange1 int null Filer by AgeRange1
AgeRange2 int null Filer by AgeRange2
GroupId int null Filer by GroupId
EmailId string null Filer by EmailId
GroupName string null GroupName

Example

http://api.plumb5.com/Contact/FilterContactsandaddtogroup

Mail Marketing

GetMailCampaigns

Methods for Sending and monitoring progress of your MailCampaigns.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetMailCampaigns

GetCampaignResponse

Methods for getting mail campaign responses.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
mailCampaignId int mailCampaignId.
fromDateTime string yyyy-mm-dd.
toDateTime string yyyy-mm-dd.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignResponse

GetCampaignOpenedResponse

Methods to get campaign Opened response.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignOpenedResponse

GetCampaignSentResponse

Methods for getting mail campaign sent response report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignSentResponse

GetCampaignClickResponse

Methods for mail campaign response Click.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignClickResponse

GetCampaignOutputResponse

Methods for mail campaign response output.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignOutputResponse

GetCampaignForwardResponse

Methods for mail campaign response Forward.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignForwardResponse

GetCampaignBouncedResponse

Methods for mail campaign response Bounced.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignBouncedResponse

GetMailTemplate

Methods for getting Template.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Mails/GetMailTemplate

GetMailCampaignEffectiveness

Methods to get mail campaign effectiveness

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailCampaignId int MailCampaignId.
MailTemplateId int MailTemplateId.
fromDateTime string yyyy-mm-dd.
toDateTime string yyyy-mm-dd.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetMailCampaignEffectiveness

GetCampaignEffectivenessUrl

Methods for mail effectiveness.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignEffectivenessUrl

GetCampaignEffectivenessClick

Methods for mail effectiveness.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignEffectivenessClick

GetCampaignEffectivenessUniqueClick

Methods for mail effectiveness.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailSendingSettingId int MailSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetCampaignEffectivenessUniqueClick

AddTemplate

Methods for adding template.(Method Type="POST")

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailCampaignId string MailCampaignId
TemplateName string Template Name
File .htm,images file Upload .htm,images file

Example

http://api.plumb5.com/Mails/AddTemplate

EditTemplate

Methods for editing template.(Method Type="POST")

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
TemplateId int Template Id
File .htm,images file Upload .htm,images file

Example

http://api.plumb5.com/Mails/EditTemplate

SendMailToGroup

Methods for Mailing to Group.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CampaignName string Campaign Identifier (To recognize each mail)
TemplateId int APIKEY of your account.
GroupId int GroupId.
Subject string Mail Subject.
FromName string From Name.
FromEmailId string From Email.
ScheduleDate string null yyyy-mm-dd.
ReportMailId string Report to Email.
Subscribe bool true Subscribe.
Forward bool true Forward.

Example

http://api.plumb5.com/Mails/SendMailToGroup

SendMailToContact

Methods for Mailing to individual.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
TemplateId int APIKEY of your account.
ToEmailId string recipient emailId
Subject string Mail Subject.
FromName string From Name.
FromEmailId string From Email.
ReplyToEmailId string null Report to Email.
Subscribe bool true Subscribe.
Forward bool true Forward.

Example

http://api.plumb5.com/Mails/SendMailToContact

GetFilteredTemplateList

Methods for getting FilteredTemplateList Template.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
templateName string null templateName.
MailCampaignId int 0 MailCampaignId
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetFilteredTemplateList

GetSplitTestReport

Methods for getting Split Test Report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetSplitTestReport

GetMailHistoryDetails

Methods for getting Mail History Details.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
fromDateTime string yyyy-mm-dd.
toDateTime string yyyy-mm-dd.
templateId int templateId.
CampaignId int CampaignId.
emailid string emailid.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetMailHistoryDetails

UpdateScheduledDrip

Methods for Updating Scheduled Drip

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
MailTemplateId int MailTemplateId.
subject string subject.
ScheduledDate string yyyy-mm-dd.
DripConditionType Short DripConditionType.

Example

http://api.plumb5.com/Mails/UpdateScheduledDrip

GetBouncedContacts

Methods for getting bounced contacts

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Mails/GetBouncedContactsmo

SMS Marketing

GetTemplate

Methods for Getting template list.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
templatename string null template name.
campaignId int 0 campaign Id
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/SmsDetails/GetTemplate

CreateOrUpdateTemplate

Methods for create (Provide smsCampaignId,TemplateName,MessageContent) or update template (Provide smsCampaignId,TemplateName,MessageContent).

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
smsCampaignId int sms Campaign Id.
smstemplateId string null sms template Id.
TemplateName string Template Name.
MessageContent string Message Content.

Example

http://api.plumb5.com/SmsDetails/CreateOrUpdateTemplate

SendSMSToGroup

Methods for sending sms to group.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupId int 0 GroupId.
CampaignName string Campaign Name.
TemplateId int Template Name.
Promotional bool true Is Promotional or Transatcional.

Example

http://api.plumb5.com/SmsDetails/SendSMSToGroup

SendSMSToContact

Methods for sending sms to individual.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
PhoneNumber string Contact number
SmsTemplateId int Template Id
Promotional bool true Is Promotional or Transatcional.

Example

http://api.plumb5.com/SmsDetails/SendSMSToContact

GetSMSShortenUrl

Methods to get sms shorten url.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
ShortenText string ShortenText.

Example

http://api.plumb5.com/SmsDetails/GetSMSShortenUrl

GetSMSCampaign

Methods to get sms campaign.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/SmsDetails/GetSMSCampaign

CreateOrUpdateCampaign

Methods to create(Provide Name) or update(Provide Name,CampaignId) campaign.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Name string Name.
CampaignId int 0 CampaignId.

Example

http://api.plumb5.com/SmsDetails/CreateOrUpdateCampaign

SMSReport

Methods to Get SMS report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
fromDateTime string yyyy-mm-dd.
toDateTime string 0 yyyy-mm-dd.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/SmsDetails/SMSReport

GetSMSSentreport

Methods to Get SMS sent report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
SmsSendingSettingId int SmsSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/SmsDetails/GetSMSSentreport

GetSMSDeliveredReport

Methods to Get SMS delivered report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
SmsSendingSettingId int SmsSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/SmsDetails/GetSMSDeliveredReport

GetSMSClickedReport

Methods to Get SMS clicked report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
SmsSendingSettingId int SmsSendingSettingId.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/SmsDetails/GetSMSClickedReport

GetSMSSettingId

Methods to Get SMS setting id.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupId int GroupId.
TemplateId int TemplateId

Example

http://api.plumb5.com/SmsDetails/GetSMSSettingId

SendTransactionSMS

Methods to send transactional sms.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
SMSSendingSettingId int SMSSendingSettingId.
Name string Name
PhoneNumber string PhoneNumber

Example

http://api.plumb5.com/SmsDetails/SendTransactionSMS

Form

GetForms

Methods for Getting form.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Formss/GetForms

GetFormResponse

Methods for form response.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
FromDate string yyyy-mm-dd
ToDate string yyyy-mm-dd
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Formss/GetFormResponse

Chat

GetChat

Methods for Getting chats.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Chat/GetChat

GetChatReport

Methods to get chat report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index
ChatId int 0 ChatId
TrackIp string null IP Address
searchtext string null searchtext
FromDate string yyyy-mm-dd
ToDate string yyyy-mm-dd

Example

http://api.plumb5.com/Chat/GetChatReport

Prospect

GetLeads

Methods for Getting leads.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
StartDate string yyyy-mm-dd
EndDate string yyyy-mm-dd
OffSet int 0 Start Index
FetchNext int 0 End Index
Stageid int 0 Stageid
EmailId string null EmailId
Phonenumber int null Phonenumber
keyword string null keyword
refferal string null refferal
Field1 string null Field1
Field2 string null Field2
Field3 string null Field3
Field4,....Field60 string null Field4,.... Field60

Example

http://api.plumb5.com/Prospect/GetLeads

AllSource

Methods for Getting All Source.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int 0 Start Index
FetchNext int 0 End Index

Example

http://api.plumb5.com/Prospect/AllSource

AddOrUpdateLead

Methods for Posting leads.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
LmsGroupId int LmsGroupId Source (Lms Group).
Name string Contact Name
EmailId string Contact EmailId
PhoneNumber string Contact PhoneNumber
AssignToSalesPersonUserId int 0 Assign to particular sales person
Field1 string null All these fields are corresponding to your account LMS fields index
Field2 string null
Field3 string null
Field4,....Field60 string null

Example

http://api.plumb5.com/Prospect/AddOrUpdateLead

UpdateRemarks

Methods for Updating Remarks.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
LmsLeadId int LmsLeadId Source (Identification of LMS Lead).
Remarks string Remarks on lead

Example

http://api.plumb5.com/Prospect/UpdateRemarks

Social

Get Group LookUp

Method for Get Group LookUp from FullConatct Details

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
GroupId int Group ID

Example

http://api.plumb5.com/Social/GetGroupLookUp

Get Connected Socially

Get Connected Socially from Facebook,Twitter,LinkedIn,Google,Yahoo,Picasa,Youtube,Gravatar,Vimeo and other social networks

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetConnectedSocially

Get Socially Active

Get Socially Active from Facebook,Twitter,LinkedIn,Google,Yahoo,Picasa,Youtube,Gravatar,Vimeo and other social networks

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetSociallyActive

Get Socially Responsive

Get Socially Responsive from facebook,Twitter and LinkedIn

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetInfluncers

Get Influncers

Get Influncers from Twitter

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetInfluncers

Get All Crawler Data

Methods for Get All Crawler Data,Crawler Data By crawler id,Crawler data by filter action

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CrawlerId int CrawlerId
Channel string Channel
Action string Action
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetAllCrawlerData

Insert Crawler

Methods for Insert Crawler

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CrawlerName string Crawler Name
AsaString int As a String
RemoveAds int Remove Ads
Keyword string Keyword
Depth int Depth
CatListss string CatListss
OtherDomains string Other Domains
IgnoreDomains string Ignore Domainss
PriWords string PriWords
IgnoreWord string Ignore Word
duration string duration
SubCategory string Sub Category
FileType string File Type
SearchType string Search Type

Example

http://api.plumb5.com/Social/InsertCrawlerInfo

Edit Crawler

Methods for Edit Crawler

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CrawlerId int Crawler Id
CrawlerName string Crawler Name
AsaString int As a String
RemoveAds int Remove Ads
Keyword string Keyword
Depth int Depth
CatListss string CatListss
OtherDomains string Other Domains
IgnoreDomains string Ignore Domainss
PriWords string PriWords
IgnoreWord string Ignore Word
duration string duration
SubCategory string Sub Category
FileType string File Type
SearchType string Search Type

Example

http://api.plumb5.com/Social/EditCrawlerInfo

Reset Crawler

Methods for Reset Crawler

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CrawlerId int CrawlerId

Example

http://api.plumb5.com/Social/ResetCrawler

Get Templates

Method for Get Templates

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetTemplates

Get Message Reports

Method for Get Message Reports,Message Reports By Network Name

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
NetworkName string Network Name
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetMessageReports

Get Message History

Method for Get Message History,Message History By Network Name

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
NetworkName string Network Name
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetMessageHistory

Get Broadcast List cheduler

Method for Get Broadcast List Scheduler

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetBroadcastListScheduler

Get Broadcast PostHistory

Method for Get Broadcast PostHistory,BroadcastPostHistory By Networkname

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
NetworkName string Network Name
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetBroadcastPostHistory

Get Brodcast Reports

Method for Get Brodcast Reports, Broadcast Reports By Network Name

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
NetworkName string Network Name
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Social/GetBrodcastReports

Get Social Alerts

Method for Get Social Alerts

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetSocialAlerts

Get Google Alerts

Method for Get Google Alerts

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Social/GetGoogleAlerts

Community

Get Cafe List

Get all cafes list

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Community/GetAllCafe

Get CafeUsers List

Get CafeUsers List

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetCafeUsers

Reports by Participations

Report of Score assigned to the Users based on their participation in Discussion,Polls etc.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
SelectType int Action.
GroupId int Group Id.

Example

http://api.plumb5.com/Community/GetReportsParticipations

Widget Report

Widget Report With Widget Id.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
WidgetId int WidgetId.

Example

http://api.plumb5.com/Community/GetWidgetReports

Custom Reports

Custom Report.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
SelectType string Action.
SelectKey string Search keyword.
Score1 int Score.
Score2 int Score.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/CustomReports

Community Analytics

Community Analytics.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetCommunityAnalytics

Update Cafe Information

Method for Update Cafe Information

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/UpdateCafeInformation

Get Cafe Information

Method for Get Cafe Information by Id

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetCafeInformation

Insert Cafe Profile Field

Method to Insert Cafe Profile Field.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
FieldName string Field Name.
FieldType int Type of Field.
FieldOptions string Field Options.
Mandatory int Is Mandatory Field.
PublishStatus int Publish Status.
ShowOnDetails int Show Details.
ErrorMesg string Message to be displayed on Error Occurance.
ImportFields int Import Fields.
ProfileDate datetime Creation Date.

Example

http://api.plumb5.com/Community/AddProfilefields

Edit Cafe Profile Field

Method to Edit Cafe Profile Fields.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Id int Profile ID.
CafeId int Cafe ID.
FieldName string Field Name.
FieldType int Type of Field.
FieldOptions string Field Options.
Mandatory int Is Mandatory Field.
PublishStatus int Publish Status.
ShowOnDetails int Show Details.
ErrorMesg string Message to be displayed on Error Occurance.
ImportFields int Import Fields.
ProfileDate datetime Creation Date.

Example

http://api.plumb5.com/Community/EditProfilefields

Add Menu

Method to Insert cafe Menu.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
ContactId int Admin ID.
CafeId int Cafe ID.
TabName string Tab Name.
TabText string Tab Text.
ContentHolder int Content Holder.
TabUrl string Tab Url.
TabPosition int Tab Position.
ContentView int Content View.
Title1 string Title.
Title2 string Title.
Title3 string Title.
Title4 string Title.
rulename string Rule Name.
rulefor string Rule For.
textvalue string Text Value.
point int Point.

Example

http://api.plumb5.com/Community/AddMenu

Get Screener

Method to Display Screener list.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetScreener

Insert Screener

Method to Insert Screener.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Title string Screener Title.
ScreenerStatus int Screener Status.
Appear int Appear.
Msg string Message.
SurveyId int Survey Id.
Score int Score.

Example

http://api.plumb5.com/Community/InsertScreener

Edit Screener

Method to Edit Screener.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Id int Screener ID.
CafeId int Cafe ID.
Title string Screener Title.
ScreenerStatus int Screener Status.
Appear int Appear.
Msg string Message.
SurveyId int Survey Id.
Score int Score.

Example

http://api.plumb5.com/Community/EditScreener

Get Discussion

Method to Display Discussion List.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetDiscussion

Get Article

Method for Get Article

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetArticle

Get Offers

Method to Display Offers List.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.

Example

http://api.plumb5.com/Community/GetOffers

Get Survey

Method for Get Survey,Survey Question By PageId,Survey Question By QuetionId,Survey Answers By QuetionId, Survey Report with SurveyId.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
PageId int Page Id
QuetionId int QuetionId
SurveyId int Survey ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetSurvey

Create Survey Embed

Method to Create Embed Survey.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
ContactId int Admin ID.
Title string Survey Title.
Status int Status.
Privacy int Privacy.
EmbedStatus int Embed Status.
OptionWebTrackIP int OptionWebTrackIP.
OptionEmbTrackIP int OptionEmbTrackIP.
ReportToMailId string ReportToMailId.

Example

http://api.plumb5.com/Community/CreateSurvey

Edit Survey Embed

Method to Edit Survey Embed

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Id int Survey ID.
CafeId int Cafe ID.
ContactId int Admin ID.
Title string Survey Title.
Status int Status.
Privacy int Privacy.
EmbedStatus int Embed Status.
OptionWebTrackIP int OptionWebTrackIP.
OptionEmbTrackIP int OptionEmbTrackIP.
ReportToMailId string ReportToMailId.

Example

http://api.plumb5.com/Community/EditSurvey

Get Poll List

Method for Get Poll List,Get Poll List By Id,Get Poll ReportList by Id and Answer

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
PollId int PollId
Answer string Answer
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetPollList

Insert Poll

Method to Create Poll with all the fields.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Title string Survey Title.
PollIdentity int PollIdentity.
Question String Poll Question.
Answers string Poll Answer.
AnswerScore int Answer Score.
Multipleoption int Multiple option.
ShowReport int ShowReport.
IpStatus int IpStatus.
PollPrivacy int PollPrivacy.
PollStatus int PollStatus.
EmbedStatus int EmbedStatus.
Privacy int Privacy.
IpAddressStatus int IpAddressStatus.

Example

http://api.plumb5.com/Community/InsertPoll

Edit Poll

Method to Edit Poll with all the fields.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Id int Poll ID.
CafeId int Cafe ID.
Title string Survey Title.
PollIdentity int PollIdentity.
Question String Poll Question.
Answers string Poll Answer.
AnswerScore int Answer Score.
Multipleoption int Multiple option.
ShowReport int ShowReport.
IpStatus int IpStatus.
PollPrivacy int PollPrivacy.
PollStatus int PollStatus.
EmbedStatus int EmbedStatus.
Privacy int Privacy.
IpAddressStatus int IpAddressStatus.

Example

http://api.plumb5.com/Community/EditPoll

Get Messages

Method for Get Messages,Get Message List By Id

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Id int Id
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetMessages

Get Group

Method for Get Group

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetGroup

Add Group

Method for Add Group

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
GroupName string Group Name
GroupDesc int Group Description

Example

http://api.plumb5.com/Community/AddGroup

Edit Group

Method for Edit Group

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
GroupId int Group Id
GroupName string Group Name
GroupDesc int Group Description

Example

http://api.plumb5.com/Community/EditGroup

Remove Group using GroupId

Method for Remove Group using GroupId

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
GroupId int Group Id

Example

http://api.plumb5.com/Community/RemoveGroupusingGroupId

Get Rewards

Method for Get Rewards,Get Downloaded Rewards

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
RewardId int RewardId
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetRewards

Insert Reward

Method to Insert Reward.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
RewardsTitle string Rewards Title.
RewardsDetails string Rewards Description.
RewardsImage string Rewards Image Url.
RewardsLimits int Reward Download Limit
RewardsTermsConditions string Rewards Terms Conditions
RewardsStatus int Reward Status(Active/Inactive)
RewardsUsedScore int Score Gained on Downloaing Rewrds
RewardsUsedScore int Score Gained on Use of Rewrds
RewardsDownloadScore int Score Gained on Download of Rewrds
RewardsExpiresOn datetime Rewards Expiry Date
RewardsImgStatus int Rewards ImgStatus

Example

http://api.plumb5.com/Community/InsertRewards

Edit Reward

Method to Edit Reward.

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
Id int Reward ID.
CafeId int Cafe ID.
RewardsTitle string Rewards Title.
RewardsDetails string Rewards Description.
RewardsImage string Rewards Image Url.
RewardsLimits int Reward Download Limit
RewardsTermsConditions string Rewards Terms Conditions
RewardsStatus int Reward Status(Active/Inactive)
RewardsUsedScore int Score Gained on Downloaing Rewrds
RewardsUsedScore int Score Gained on Use of Rewrds
RewardsDownloadScore int Score Gained on Download of Rewrds
RewardsExpiresOn datetime Rewards Expiry Date
RewardsImgStatus int Rewards ImgStatus

Example

http://api.plumb5.com/Community/EditRewards

Get Widget

Method for Get Widget

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetWidget

Add Widget

Method for Add Widget

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
WidgetTitle string Widget Title
WidgetType int Widget Type
HtmlContent string Html Content
WidgetStatus int Widget Status

Example

http://api.plumb5.com/Community/AddWidget

Edit Widget

Method for Edit Widget

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
WidgetTitle string Widget Title
WidgetType int Widget Type
HtmlContent string Html Content
WidgetStatus int Widget Status
WidgetId int WidgetId

Example

http://api.plumb5.com/Community/EditWidget

FeedbackList

Method for Feedback List

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/FeedbackList

Update Feedback

Method for Update Feedback

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Rule1 string Rule1
Rule2 string Rule2
Rule3 string Rule3
Rule4 string Rule4
Text1 string Text1
Text2 string Text2
Text3 string Text3
Text4 string Text4
category string category

Example

http://api.plumb5.com/Community/UpdateFeedback

Get Page

Method for Get Page

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetPage

Add Page

Method for Add Page

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Title string Title
Layout int Layout
Content string Content

Example

http://api.plumb5.com/Community/AddPage

Edit Page

Method for Edit Page

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
Title string Title
Layout int Layout
Content string Content
Id int Id

Example

http://api.plumb5.com/Community/EditPage

Get Script

Method for Get Script

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
OffSet int Start Index.
FetchNext int End Index.

Example

http://api.plumb5.com/Community/GetScript

Add Script

Method for Add Script

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
ScriptName string Script Name
Script string Script

Example

http://api.plumb5.com/Community/AddScript

Edit Script

Method for Edit Script

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.
CafeId int Cafe ID.
ScriptName string Script Name
Script string Script
Id int Id

Example

http://api.plumb5.com/Community/EditScript

Get Notification

Method for Get Notification

Parameters

Name Type Default Description
ApiKey string APIKEY of your account.
AdsId int Account ID.

Example

http://api.plumb5.com/Community/GetNotification

Transaction

Import Transaction .

Import transaction (Method Type="POST")

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
Columns string null
File Excel File(.xls) ContactIdentiFication: 1(PhoneNumber), 2(EmailAddress)

Example

http://api.plumb5.com/TransactionDetails/ImportTranscation?ApiKey=ApiKey&AdsId=AdsId

Add Transaction .

Add transaction

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
ProductId string mandatory
Quantity int mandatory
UNITCOST double mandatory
PurchasePrice decimal mandatory
OrderId string mandatory
ContactIdentiFication string mandatory ContactIdentiFication: 1(PhoneNumber), 2(EmailAddress)
PhoneNumber string mandatory(If ContactIdentiFication: 1 )
EmailAddress string mandatory(If ContactIdentiFication: 2 )
StoreNumber string Optional
TransactionDate datetime Optional yyyy-mm-dd(default current date)
IsOnlineOrOfflineTransaction bool Optional
AlternateOrderId string Optional
OfferCode string Optional
Discount decimal Optional
FreeProductId1 string Optional
FreeProductId2 string Optional

Example

http://api.plumb5.com/TransactionDetails/AddTranscation?ApiKey=ApiKey&AdsId=AdsId&ProductId=ProductId&Quantity=Quantity&UNITCOST=UNITCOST&PurchasePrice=PurchasePrice&OrderId=OrderId&ContactIdentiFication=1&PhoneNumber=PhoneNumber&TransactionDate=yyyy-mm-dd

Product

Import Product

Import Product (Method Type="POST")

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
Columns string null
File Excel File(.xls)

Example

http://api.plumb5.com/ProductDetails/ImportProduct

Add Product

Add Product

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
ProductId string mandatory
Name string mandatory
MRP decimal mandatory
CreateDate string mandatory mm/dd/yyyy
SecondaryName string optional
StoreNumber string optional
ProductImageUrl string optional
ProductPageUrl string optional
ProductCategoryUrl string optional
ProductSubCategoryUrl string optional
Brand string optional
ShortTitle string optional
Description string optional
CategoryId1,2...5 string optional category name
SubCategoryId1,2...5 string optional subcategory name
Inventory double optional
MinOrderQty double optional
MaxOrderQty double optional
Threshold int optional
SeasonalSegment string optional
IsActive bool optional
SellingPrice decimal optional
TAX decimal optional
PriceGap decimal optional
Discount decimal optional
PriceUpdateDate string mm/dd/yyyy
Rating string optional
SlabPrice1,2...6 double optional
SlabQty1,2...6 double optional
SlabsDetailsUpdateDate string mm/dd/yyyy
FreeProductId1,2 string optional
FreeProductName1,2 string optional
FreeProductDesp1,2 string optional
FreeProductQty1,2 string optional
FreeProductStock1,2 string optional
FreeProduct1isActive,2 bool optional
FreeProductUpdateDate1,2 string optional mm/dd/yyyy
ProductAffinityWithThisProduct string optional
ProductAffinityWithThisCategoryAndSameCategory string optional
OfferCode string optional
SKU string optional
slug string optional
Weight double optional(only in gm)

Example

http://api.plumb5.com/ProductDetails/AddProduct?ApiKey=&ApiKey...

Update Product

Update Product

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
ProductId string mandatory
Name string optional
MRP decimal optional
CreateDate string optional mm/dd/yyyy
SecondaryName string optional
StoreNumber string optional
ProductImageUrl string optional
ProductPageUrl string optional
ProductCategoryUrl string optional
ProductSubCategoryUrl string optional
Brand string optional
ShortTitle string optional
Description string optional
CategoryId1,2...5 string optional category name
SubCategoryId1,2...5 string optional subcategory name
Inventory double optional
MinOrderQty double optional
MaxOrderQty double optional
Threshold int optional
SeasonalSegment string optional
IsActive bool optional
SellingPrice decimal optional
TAX decimal optional
PriceGap decimal optional
Discount decimal optional
PriceUpdateDate string mm/dd/yyyy
Rating string optional
SlabPrice1,2...6 double optional
SlabQty1,2...6 double optional
SlabsDetailsUpdateDate string mm/dd/yyyy
FreeProductId1,2 string optional
FreeProductName1,2 string optional
FreeProductDesp1,2 string optional
FreeProductQty1,2 string optional
FreeProductStock1,2 string optional
FreeProduct1isActive,2 bool optional
FreeProductUpdateDate1,2 string optional mm/dd/yyyy
ProductAffinityWithThisProduct string optional
ProductAffinityWithThisCategoryAndSameCategory string optional
OfferCode string optional
SKU string optional
slug string optional
Weight string optional

Example

http://api.plumb5.com/ProductDetails/UpdateProduct?ApiKey=&ApiKey...

Update Product price

Update Product Price

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
ProductId string mandatory
MRP decimal mandatory
SellingPrice decimal optional
TAX decimal optional
PriceGap decimal optional
Discount decimal optional
PriceUpdateDate string optional mm/dd/yyyy

Example

http://api.plumb5.com/ProductDetails/UpdateProductPrice?ApiKey=&ApiKey...

Import Product price

Import Product Price(Method Type="POST")

Parameters

Name Type Default Description
ApiKey string mandatory APIKEY of your account.
AdsId int mandatory Account ID.
Columns string null
File Excel File(.xls)

Example

http://api.plumb5.com/ProductDetails/ImportProductPrice