| Package | Description |
|---|---|
| sibApi | |
| sibModel |
| Class and Description |
|---|
| AbTestCampaignResult
AbTestCampaignResult
|
| AddChildDomain
AddChildDomain
|
| AddContactToList
AddContactToList
|
| AddCredits
AddCredits
|
| BlockDomain
BlockDomain
|
| CreateAttribute
CreateAttribute
|
| CreateChild
CreateChild
|
| CreateContact
CreateContact
|
| CreateDoiContact
CreateDoiContact
|
| CreatedProcessId
CreatedProcessId
|
| CreateEmailCampaign
CreateEmailCampaign
|
| CreateList
CreateList
|
| CreateModel
CreateModel
|
| CreateReseller
CreateReseller
|
| CreateSender
CreateSender
|
| CreateSenderModel
CreateSenderModel
|
| CreateSmsCampaign
CreateSmsCampaign
|
| CreateSmtpEmail
CreateSmtpEmail
|
| CreateSmtpTemplate
CreateSmtpTemplate
|
| CreateUpdateContactModel
CreateUpdateContactModel
|
| CreateUpdateFolder
CreateUpdateFolder
|
| CreateWebhook
CreateWebhook
|
| DeleteHardbounces
DeleteHardbounces
|
| EmailExportRecipients
EmailExportRecipients
|
| GetAccount
GetAccount
|
| GetAggregatedReport
GetAggregatedReport
|
| GetAttributes
GetAttributes
|
| GetBlockedDomains
list of blocked domains
|
| GetChildAccountCreationStatus
GetChildAccountCreationStatus
|
| GetChildDomains
GetChildDomains
|
| GetChildInfo
GetChildInfo
|
| GetChildrenList
GetChildrenList
|
| GetContactCampaignStats
Campaign Statistics for the contact
|
| GetContacts
GetContacts
|
| GetEmailCampaign
GetEmailCampaign
|
| GetEmailCampaigns
GetEmailCampaigns
|
| GetEmailEventReport
GetEmailEventReport
|
| GetExtendedContactDetails
GetExtendedContactDetails
|
| GetExtendedList
GetExtendedList
|
| GetFolder
GetFolder
|
| GetFolderLists
GetFolderLists
|
| GetFolders
GetFolders
|
| GetIps
GetIps
|
| GetIpsFromSender
GetIpsFromSender
|
| GetLists
GetLists
|
| GetProcess
GetProcess
|
| GetProcesses
GetProcesses
|
| GetReports
GetReports
|
| GetSendersList
GetSendersList
|
| GetSharedTemplateUrl
GetSharedTemplateUrl
|
| GetSmsCampaign
GetSmsCampaign
|
| GetSmsCampaigns
GetSmsCampaigns
|
| GetSmsEventReport
GetSmsEventReport
|
| GetSmtpTemplateOverview
GetSmtpTemplateOverview
|
| GetSmtpTemplates
GetSmtpTemplates
|
| GetSsoToken
GetSsoToken
|
| GetTransacAggregatedSmsReport
GetTransacAggregatedSmsReport
|
| GetTransacBlockedContacts
GetTransacBlockedContacts
|
| GetTransacEmailContent
GetTransacEmailContent
|
| GetTransacEmailsList
GetTransacEmailsList
|
| GetTransacSmsReport
GetTransacSmsReport
|
| GetWebhook
GetWebhook
|
| GetWebhooks
GetWebhooks
|
| ManageIp
ManageIp
|
| PostContactInfo
PostContactInfo
|
| RemainingCreditModel
RemainingCreditModel
|
| RemoveContactFromList
RemoveContactFromList
|
| RemoveCredits
RemoveCredits
|
| RequestContactExport
RequestContactExport
|
| RequestContactImport
RequestContactImport
|
| RequestSmsRecipientExport
RequestSmsRecipientExport
|
| SendEmail
SendEmail
|
| SendReport
SendReport
|
| SendSms
SendSms
|
| SendSmtpEmail
SendSmtpEmail
|
| SendTemplateEmail
SendTemplateEmail
|
| SendTestEmail
SendTestEmail
|
| SendTestSms
SendTestSms
|
| SendTransacSms
SendTransacSms
|
| UpdateAttribute
UpdateAttribute
|
| UpdateCampaignStatus
Status of the campaign
|
| UpdateChild
UpdateChild
|
| UpdateChildAccountStatus
UpdateChildAccountStatus
|
| UpdateChildDomain
UpdateChildDomain
|
| UpdateContact
UpdateContact
|
| UpdateEmailCampaign
UpdateEmailCampaign
|
| UpdateList
UpdateList
|
| UpdateSender
UpdateSender
|
| UpdateSmsCampaign
UpdateSmsCampaign
|
| UpdateSmtpTemplate
UpdateSmtpTemplate
|
| UpdateWebhook
UpdateWebhook
|
| UploadImageToGallery
UploadImageToGallery
|
| Class and Description |
|---|
| AbTestCampaignResult
AbTestCampaignResult
|
| AbTestCampaignResult.WinningCriteriaEnum
Criteria choosen for winning version (Open/Click)
|
| AbTestCampaignResult.WinningVersionEnum
Winning Campaign Info.
|
| AbTestCampaignResultClickedLinks
AbTestCampaignResultClickedLinks
|
| AbTestCampaignResultStatistics
AbTestCampaignResultStatistics
|
| AbTestVersionClicks
Information on clicked links for a particular version
|
| AbTestVersionClicksInner
AbTestVersionClicksInner
|
| AbTestVersionStats
Percentage of a particular event for both versions
|
| AddChildDomain
AddChildDomain
|
| AddContactToList
AddContactToList
|
| AddCredits
AddCredits
|
| BlockDomain
BlockDomain
|
| CreateAttribute
CreateAttribute
|
| CreateAttribute.TypeEnum
Type of the attribute.
|
| CreateAttributeEnumeration
CreateAttributeEnumeration
|
| CreateChild
CreateChild
|
| CreateChild.LanguageEnum
Language of the child account
|
| CreateContact
CreateContact
|
| CreateDoiContact
CreateDoiContact
|
| CreatedProcessId
CreatedProcessId
|
| CreateEmailCampaign
CreateEmailCampaign
|
| CreateEmailCampaign.WinnerCriteriaEnum
Choose the metrics that will determinate the winning version.
|
| CreateEmailCampaignRecipients
List ids to include/exclude from campaign
|
| CreateEmailCampaignSender
Sender details including id or email and name (optional).
|
| CreateList
CreateList
|
| CreateModel
CreateModel
|
| CreateReseller
CreateReseller
|
| CreateSender
CreateSender
|
| CreateSenderIps
CreateSenderIps
|
| CreateSenderModel
CreateSenderModel
|
| CreateSmsCampaign
CreateSmsCampaign
|
| CreateSmsCampaignRecipients
CreateSmsCampaignRecipients
|
| CreateSmtpEmail
CreateSmtpEmail
|
| CreateSmtpTemplate
CreateSmtpTemplate
|
| CreateSmtpTemplateSender
Sender details including id or email and name (optional).
|
| CreateUpdateContactModel
CreateUpdateContactModel
|
| CreateUpdateFolder
CreateUpdateFolder
|
| CreateWebhook
CreateWebhook
|
| CreateWebhook.EventsEnum
Gets or Sets events
|
| CreateWebhook.TypeEnum
Type of the webhook
|
| DeleteHardbounces
DeleteHardbounces
|
| EmailExportRecipients
EmailExportRecipients
|
| EmailExportRecipients.RecipientsTypeEnum
Type of recipients to export for a campaign
|
| ErrorModel
ErrorModel
|
| ErrorModel.CodeEnum
Error code displayed in case of a failure
|
| GetAccount
GetAccount
|
| GetAccountMarketingAutomation
GetAccountMarketingAutomation
|
| GetAccountPlan
GetAccountPlan
|
| GetAccountPlan.CreditsTypeEnum
This is the type of the credit, "Send Limit" is one of the possible types of credit of a user.
|
| GetAccountPlan.TypeEnum
Displays the plan type of the user
|
| GetAccountRelay
Information about your transactional email account
|
| GetAccountRelayData
Data regarding the transactional email account
|
| GetAggregatedReport
GetAggregatedReport
|
| GetAttributes
GetAttributes
|
| GetAttributesAttributes
GetAttributesAttributes
|
| GetAttributesAttributes.CategoryEnum
Category of the attribute
|
| GetAttributesAttributes.TypeEnum
Type of the attribute
|
| GetAttributesEnumeration
GetAttributesEnumeration
|
| GetBlockedDomains
list of blocked domains
|
| GetCampaignOverview
GetCampaignOverview
|
| GetCampaignOverview.StatusEnum
Status of the campaign
|
| GetCampaignOverview.TypeEnum
Type of campaign
|
| GetCampaignRecipients
GetCampaignRecipients
|
| GetCampaignStats
GetCampaignStats
|
| GetChildAccountCreationStatus
GetChildAccountCreationStatus
|
| GetChildDomain
GetChildDomain
|
| GetChildInfo
GetChildInfo
|
| GetChildInfoApiKeys
API Keys associated to child account
|
| GetChildInfoApiKeysV2
GetChildInfoApiKeysV2
|
| GetChildInfoApiKeysV3
GetChildInfoApiKeysV3
|
| GetChildInfoCredits
Credits available for your child
|
| GetChildInfoStatistics
Statistics about your child account activity
|
| GetChildrenList
GetChildrenList
|
| GetClient
GetClient
|
| GetContactCampaignStats
Campaign Statistics for the contact
|
| GetContactCampaignStatsClicked
GetContactCampaignStatsClicked
|
| GetContactCampaignStatsOpened
GetContactCampaignStatsOpened
|
| GetContactCampaignStatsTransacAttributes
GetContactCampaignStatsTransacAttributes
|
| GetContactCampaignStatsUnsubscriptions
GetContactCampaignStatsUnsubscriptions
|
| GetContactDetails
GetContactDetails
|
| GetContacts
GetContacts
|
| GetDeviceBrowserStats
GetDeviceBrowserStats
|
| GetEmailCampaign
GetEmailCampaign
|
| GetEmailCampaign.StatusEnum
Status of the campaign
|
| GetEmailCampaign.TypeEnum
Type of campaign
|
| GetEmailCampaigns
GetEmailCampaigns
|
| GetEmailEventReport
GetEmailEventReport
|
| GetEmailEventReportEvents
GetEmailEventReportEvents
|
| GetEmailEventReportEvents.EventEnum
Event which occurred
|
| GetExtendedCampaignOverview
GetExtendedCampaignOverview
|
| GetExtendedCampaignOverview.StatusEnum
Status of the campaign
|
| GetExtendedCampaignOverview.TypeEnum
Type of campaign
|
| GetExtendedCampaignOverviewSender
GetExtendedCampaignOverviewSender
|
| GetExtendedCampaignStats
GetExtendedCampaignStats
|
| GetExtendedClient
GetExtendedClient
|
| GetExtendedClientAddress
Address informations
|
| GetExtendedContactDetails
GetExtendedContactDetails
|
| GetExtendedContactDetailsStatistics
Campaign statistics of the contact
|
| GetExtendedContactDetailsStatisticsClicked
GetExtendedContactDetailsStatisticsClicked
|
| GetExtendedContactDetailsStatisticsLinks
GetExtendedContactDetailsStatisticsLinks
|
| GetExtendedContactDetailsStatisticsMessagesSent
GetExtendedContactDetailsStatisticsMessagesSent
|
| GetExtendedContactDetailsStatisticsOpened
GetExtendedContactDetailsStatisticsOpened
|
| GetExtendedContactDetailsStatisticsUnsubscriptions
Listing of the unsubscription for the contact
|
| GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
|
| GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
|
| GetExtendedList
GetExtendedList
|
| GetExtendedListCampaignStats
GetExtendedListCampaignStats
|
| GetFolder
GetFolder
|
| GetFolderLists
GetFolderLists
|
| GetFolders
GetFolders
|
| GetIp
GetIp
|
| GetIpFromSender
GetIpFromSender
|
| GetIps
GetIps
|
| GetIpsFromSender
GetIpsFromSender
|
| GetList
GetList
|
| GetLists
GetLists
|
| GetProcess
GetProcess
|
| GetProcess.StatusEnum
Status of the process
|
| GetProcesses
GetProcesses
|
| GetReports
GetReports
|
| GetReportsReports
GetReportsReports
|
| GetSendersList
GetSendersList
|
| GetSendersListIps
GetSendersListIps
|
| GetSendersListSenders
GetSendersListSenders
|
| GetSharedTemplateUrl
GetSharedTemplateUrl
|
| GetSmsCampaign
GetSmsCampaign
|
| GetSmsCampaign.StatusEnum
Status of the SMS Campaign
|
| GetSmsCampaignOverview
GetSmsCampaignOverview
|
| GetSmsCampaignOverview.StatusEnum
Status of the SMS Campaign
|
| GetSmsCampaigns
GetSmsCampaigns
|
| GetSmsCampaignStats
GetSmsCampaignStats
|
| GetSmsEventReport
GetSmsEventReport
|
| GetSmsEventReportEvents
GetSmsEventReportEvents
|
| GetSmsEventReportEvents.EventEnum
Event which occurred
|
| GetSmtpTemplateOverview
GetSmtpTemplateOverview
|
| GetSmtpTemplateOverviewSender
GetSmtpTemplateOverviewSender
|
| GetSmtpTemplates
GetSmtpTemplates
|
| GetSsoToken
GetSsoToken
|
| GetStatsByBrowser
GetStatsByBrowser
|
| GetStatsByDevice
GetStatsByDevice
|
| GetStatsByDomain
GetStatsByDomain
|
| GetTransacAggregatedSmsReport
GetTransacAggregatedSmsReport
|
| GetTransacBlockedContacts
GetTransacBlockedContacts
|
| GetTransacBlockedContactsContacts
GetTransacBlockedContactsContacts
|
| GetTransacBlockedContactsReason
Reason for blocking / unsubscribing
|
| GetTransacBlockedContactsReason.CodeEnum
Reason code for blocking / unsubscribing (This code is safe for comparison)
|
| GetTransacEmailContent
GetTransacEmailContent
|
| GetTransacEmailContentEvents
GetTransacEmailContentEvents
|
| GetTransacEmailsList
GetTransacEmailsList
|
| GetTransacEmailsListTransactionalEmails
GetTransacEmailsListTransactionalEmails
|
| GetTransacSmsReport
GetTransacSmsReport
|
| GetTransacSmsReportReports
GetTransacSmsReportReports
|
| GetWebhook
GetWebhook
|
| GetWebhook.TypeEnum
Type of webhook (marketing or transac)
|
| GetWebhooks
GetWebhooks
|
| ManageIp
ManageIp
|
| PostContactInfo
PostContactInfo
|
| PostContactInfoContacts
PostContactInfoContacts
|
| PostSendFailed
PostSendFailed
|
| PostSendSmsTestFailed
PostSendSmsTestFailed
|
| RemainingCreditModel
RemainingCreditModel
|
| RemainingCreditModelChild
Credits remaining for child account
|
| RemainingCreditModelReseller
RemainingCreditModelReseller
|
| RemoveContactFromList
RemoveContactFromList
|
| RemoveCredits
RemoveCredits
|
| RequestContactExport
RequestContactExport
|
| RequestContactExportCustomContactFilter
Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request.
|
| RequestContactExportCustomContactFilter.ActionForContactsEnum
Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.
|
| RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum
Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.
|
| RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum
Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.
|
| RequestContactImport
RequestContactImport
|
| RequestContactImportNewList
To create a new list and import the contacts into it, pass the listName and an optional folderId.
|
| RequestSmsRecipientExport
RequestSmsRecipientExport
|
| RequestSmsRecipientExport.RecipientsTypeEnum
Filter the recipients based on how they interacted with the campaign
|
| SendEmail
SendEmail
|
| SendEmailAttachment
SendEmailAttachment
|
| SendReport
SendReport
|
| SendReport.LanguageEnum
Language of email content for campaign report sending.
|
| SendReportEmail
Custom attributes for the report email.
|
| SendSms
SendSms
|
| SendSmtpEmail
SendSmtpEmail
|
| SendSmtpEmailAttachment
SendSmtpEmailAttachment
|
| SendSmtpEmailBcc
SendSmtpEmailBcc
|
| SendSmtpEmailCc
SendSmtpEmailCc
|
| SendSmtpEmailMessageVersions
SendSmtpEmailMessageVersions
|
| SendSmtpEmailReplyTo
Email (required), along with name (optional), on which transactional mail recipients will be able to reply back.
|
| SendSmtpEmailReplyTo1
Email (required), along with name (optional), on which transactional mail recipients will be able to reply back.
|
| SendSmtpEmailSender
Mandatory if `templateId` is not passed.
|
| SendSmtpEmailTo
SendSmtpEmailTo
|
| SendSmtpEmailTo1
SendSmtpEmailTo1
|
| SendTemplateEmail
SendTemplateEmail
|
| SendTestEmail
SendTestEmail
|
| SendTestSms
SendTestSms
|
| SendTransacSms
SendTransacSms
|
| SendTransacSms.TypeEnum
Type of the SMS.
|
| UpdateAttribute
UpdateAttribute
|
| UpdateAttributeEnumeration
UpdateAttributeEnumeration
|
| UpdateCampaignStatus
Status of the campaign
|
| UpdateCampaignStatus.StatusEnum
Note:- replicateTemplate status will be available only for template type campaigns.
|
| UpdateChild
UpdateChild
|
| UpdateChildAccountStatus
UpdateChildAccountStatus
|
| UpdateChildDomain
UpdateChildDomain
|
| UpdateContact
UpdateContact
|
| UpdateEmailCampaign
UpdateEmailCampaign
|
| UpdateEmailCampaign.WinnerCriteriaEnum
Choose the metrics that will determinate the winning version.
|
| UpdateEmailCampaignRecipients
List ids to include/exclude from campaign
|
| UpdateEmailCampaignSender
Sender details including id or email and name (optional).
|
| UpdateList
UpdateList
|
| UpdateSender
UpdateSender
|
| UpdateSmsCampaign
UpdateSmsCampaign
|
| UpdateSmtpTemplate
UpdateSmtpTemplate
|
| UpdateSmtpTemplateSender
Sender details including id or email and name (optional).
|
| UpdateWebhook
UpdateWebhook
|
| UpdateWebhook.EventsEnum
Gets or Sets events
|
| UploadImageToGallery
UploadImageToGallery
|
Copyright © 2021. All rights reserved.