All Classes and Interfaces
Class
Description
AbTestCampaignResult
Criteria choosen for winning version (Open/Click)
Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending.
AbTestCampaignResultClickedLinks
AbTestCampaignResultStatistics
AbTestVersionClicksInner
Percentage of a particular event for both versions
AddContactToListByEmails
AddContactToListByExtIDs
AddContactToListByIDs
AddContactToListRequest
AddSubscriptionMemberPayload
AggregateBalance
AuthenticateDomainModel
Balance
BalanceDataPerContact
BalanceDefinition
startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year
BalanceDefinitionPage
BalanceLimit
Represents an order linked to a balance definition, including amount, due date, and transaction details.
BlockDomain
Specify the payment currency and amount.
Currency code for the payment amount.
CompaniesIdPatchRequest
CompaniesImportPost200Response
CompaniesImportPost400Response
CompaniesLinkUnlinkIdPatchRequest
List of companies
Created company id
CompaniesPostRequest
Company Details
List of attributes
ComponentItems
ContactBalancesResp
ContactErrorModel
Error code displayed in case of a failure
ConversationsAgentOnlinePingPostRequest
a Conversations message
`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.
ConversationsMessageAttachmentsInner
ConversationsMessageFile
image info is passed in case the file is an image
Status of the message forwarding to the source.
An object containing details about the email sender (applicable only to messages in email threads).
An object containing details of the reply-to email address (applicable only to messages in email threads).
ConversationsMessagesIdPutRequest
ConversationsMessagesPostRequest
ConversationsMessageToInner
ConversationsPushedMessagesPostRequest
ConversionSourceMetrics
Gets or Sets conversionSource
ConversionSourceProduct
CorporateGroupDetailsResponse
CorporateGroupDetailsResponseGroup
CorporateGroupDetailsResponseSubAccountsInner
CorporateGroupDetailsResponseUsersInner
CorporateGroupIdPutRequest
CorporateGroupPost201Response
CorporateGroupPostRequest
CorporateGroupUnlinkGroupIdSubAccountsPutRequest
CorporateIpGet200ResponseInner
CorporateSsoTokenPostRequest
CorporateSubAccountIpAssociatePostRequest
CorporateSubAccountIpDissociatePutRequest
CorporateSubAccountKeyPostRequest
CorporateSubAccountSsoTokenPostRequest
**Set target after login success** * **automation** - Redirect to Automation after login * **email_campaign** - Redirect to Email Campaign after login * **contacts** - Redirect to Contacts after login * **landing_pages** - Redirect to Landing Pages after login * **email_transactional** - Redirect to Email Transactional after login * **senders** - Redirect to Senders after login * **sms_campaign** - Redirect to Sms Campaign after login * **sms_transactional** - Redirect to Sms Transactional after login
CorporateUserEmailPermissionsPutRequest
Permission on features
feature name
Gets or Sets permissions
CorporateUserInvitationActionEmailPut200Response
CreateApiKeyResponse
CreateAttribute
Type of the attribute.
CreateAttributeEnumerationInner
Payload for creating a new balance definition, specifying expiration rules, rounding strategies, and constraints.
Defines when the balance expires within the selected duration.
Unit of time for balance validity.
Defines whether partial credit is allowed when reaching max balance.
Defines rounding strategy for credit transactions.
Defines rounding strategy for debit transactions.
Unit of balance measurement.
Payload for setting transaction or amount-based limits on a balance.
Defines whether the limit applies to transaction count or amount.
Unit of time for which the limit is applicable.
Specifies whether the limit applies to credit or debit transactions.
Payload for creating a new balance linked to a specific balance definition.
CreateCategoryModel
CreateContact
CreateCouponCollection201Response
CreateCouponCollectionRequest
CreateCouponsRequest
CreatedBatchId
CreateDoiContact
CreateDomain
CreateDomainModel
CreateDomainModelDnsRecords
CreateDomainModelDnsRecordsDkimRecord
CreatedProcessId
CreateEmailCampaign
Choose the metrics that will determinate the winning version.
To reduce your carbon footprint, set an expiration date for your email.
unit of the duration
Segment ids and List ids to include/exclude from campaign
Sender details including id or email and name (_optional_).
CreateExternalFeed
Auth type of the feed: * `basic` * `token` * `noAuth`
CreateExternalFeed201Response
CreateList
CreateLoyaltyProgramPayload
CreateModel
Payload for creating an order linked to a balance definition.
CreatePaymentRequest
CreatePaymentResponse
CreateProductModel
CreateSender
CreateSenderIpsInner
CreateSenderModel
CreateSmsCampaign
CreateSmsCampaignRecipients
CreateSmtpEmail
CreateSmtpTemplate
Sender details including id or email and name (_optional_).
CreateSubAccount
Set the language of the sub-account
CreateSubAccountResponse
CreateSubscriptionPayload
CreateSubscriptionResponse
CreateTierGroupRequest
Select real_time to downgrade tier on real time balance updates.
Select real_time to upgrade tier on real time balance updates.
Payload for creating a transaction, specifying balance details and optional expiration.
CreateUpdateBatchCategory
CreateUpdateBatchCategoryModel
CreateUpdateBatchProducts
CreateUpdateBatchProductsModel
CreateUpdateCategories
CreateUpdateCategory
CreateUpdateContactModel
CreateUpdateFolder
CreateUpdateProduct
CreateUpdateProducts
CreateWebhook
channel of webhook
Gets or Sets events
Type of the webhook
CreateWhatsAppCampaign
Segment ids and List ids to include/exclude from campaign
CreateWhatsAppTemplate
Category of the template
source of the template
CrmAttributesPost200Response
CrmAttributesPostRequest
The type of attribute (must be one of the defined enums)
The type of object the attribute belongs to (prefilled with `companies` or `deal`, mandatory)
CrmDealsIdPatchRequest
CrmDealsLinkUnlinkIdPatchRequest
Created deal id
CrmDealsPostRequest
CrmTasksIdPatchRequest
Task Details
CrmTasksPostRequest
Deal Details
List of attributes
List of Deals
DeleteHardbounces
EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response
Gets or Sets conversionSource
EcommerceAttributionMetricsGet200Response
Attribution list aggregated totals
EcommerceAttributionProductsConversionSourceConversionSourceIdGet200Response
EcommerceConfigDisplayCurrencyGet200Response
EmailExportRecipients
Type of recipients to export for a campaign
ErrorModel
Error code displayed in case of a failure
ErrorResponse
Event
EventContactPropertiesValue
EventEventPropertiesValue
Identifies the contact associated with the event.
ExportWebhooksHistory
Filter the history for a specific event type
Filter the history based on webhook type
File data that is uploaded
Downloadable file link
GetAccount
GetAccountActivity
GetAccountActivityLogsInner
GetAccountAllOfMarketingAutomation
GetAccountAllOfPlan
This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user
Displays the plan type of the user
Information about your transactional email account
Data regarding the transactional email account
GetAggregatedReport
GetAllExternalFeeds
GetAllExternalFeedsFeedsInner
Auth type of the feed: * `basic` * `token` * `noAuth`
GetAttributes
GetAttributesAttributesInner
Category of the attribute
Type of the attribute
GetAttributesAttributesInnerEnumerationInner
GetBlockedDomains
GetCampaignOverview
Status of the campaign
Type of campaign
GetCampaignRecipients
GetCampaignStats
GetCategories
GetCategoryDetails
GetClient
Campaign Statistics for the contact
GetContactCampaignStatsClickedInner
GetContactCampaignStatsOpenedInner
GetContactCampaignStatsTransacAttributesInner
GetContactCampaignStatsUnsubscriptions
GetContactDetails
GetContactInfoIdentifierParameter
GetContacts
GetCorporateInvitedUsersList
GetCorporateInvitedUsersListUsersInner
Feature accessiblity given to the user.
Admin user groups list
Check admin user permissions
Granular feature permissions given to the user.
Groups details
GetCouponCollection
GetDeviceBrowserStats
GetDomainConfigurationModel
GetDomainsList
GetDomainsListDomainsInner
GetEmailCampaign
Status of the campaign
Type of campaign
GetEmailCampaigns
GetEmailCampaignsCampaignsInner
Status of the campaign
Type of campaign
GetEmailEventReport
GetEmailEventReportEventsInner
Event which occurred
GetExtendedCampaignOverview
Status of the campaign
Type of campaign
GetExtendedCampaignOverviewAllOfSender
GetExtendedCampaignStats
GetExtendedClient
Address informations
GetExtendedContactDetails
Campaign statistics of the contact
GetExtendedContactDetailsAllOfStatisticsClicked
GetExtendedContactDetailsAllOfStatisticsLinks
GetExtendedContactDetailsAllOfStatisticsMessagesSent
GetExtendedContactDetailsAllOfStatisticsOpened
Listing of the unsubscription for the contact
GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription
GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription
GetExtendedList
GetExtendedListAllOfCampaignStats
GetExternalFeedByUUID
Auth type of the feed: * `basic` * `token` * `noAuth`
GetExternalFeedByUUIDHeadersInner
GetFolder
GetFolderLists
GetFolders
GetInboundEmailEvents
GetInboundEmailEventsByUuid
GetInboundEmailEventsByUuidAttachmentsInner
GetInboundEmailEventsByUuidLogsInner
Type of the event
GetInboundEmailEventsEventsInner
GetInvitedUsersList
GetInvitedUsersListUsersInner
Feature accessiblity given to the user.
GetIp
GetIpFromSender
GetIps
GetIpsFromSender
GetList
GetLists
GetListsListsInner
GetPaymentRequest
Status of the payment request.
GetProcess
Status of the process
GetProcesses
GetProductDetails
GetProducts
Getrecords200Response
Getrecords200ResponseRecordsInner
Getrecords200ResponseRecordsInnerAssociationsInner
Getrecords200ResponseRecordsInnerAssociationsInnerOneOf
Getrecords200ResponseRecordsInnerAssociationsInnerOneOf1
Getrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInner
Getrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInnerOneOf
Getrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInnerOneOf1
Identifiers attached with the associated object record.
Identifiers attached with the associated object record.
Getrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInner
Getrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInnerOneOf
Getrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInnerOneOf1
Identifiers attached with the associated object record.
Identifiers attached with the associated object record.
Identifiers attached with the object record.
GetReports
GetReportsReportsInner
GetScheduledEmailByBatchId
GetScheduledEmailByBatchIdBatchesInner
Current status of the scheduled batch
GetScheduledEmailById200Response
Current status of the scheduled email
GetScheduledEmailByMessageId
Current status of the scheduled email
GetSegments
GetSendersList
GetSendersListSendersInner
GetSendersListSendersInnerIpsInner
GetSharedTemplateUrl
GetSmsCampaign
Status of the SMS Campaign
GetSmsCampaignOverview
Status of the SMS Campaign
GetSmsCampaigns
GetSmsCampaignsCampaignsInner
Status of the SMS Campaign
GetSmsCampaignStats
GetSmsEventReport
GetSmsEventReportEventsInner
Event which occurred
GetSmtpTemplateOverview
GetSmtpTemplateOverviewSender
GetSmtpTemplates
GetSsoToken
GetStatsByDevice
GetSubAccountGroups200ResponseInner
GetTransacAggregatedSmsReport
GetTransacBlockedContacts
GetTransacBlockedContactsContactsInner
Reason for blocking / unsubscribing
Reason code for blocking / unsubscribing (This code is safe for comparison)
GetTransacEmailContent
GetTransacEmailContentEventsInner
GetTransacEmailsList
GetTransacEmailsListTransactionalEmailsInner
GetTransacSmsReport
GetTransacSmsReportReportsInner
Check user permission
GetUserPermissionPrivilegesInner
GetWebhook
channel of webhook
Type of webhook (marketing or transactional)
GetWebhooks
GetWhatsappCampaignOverview
Status of the WhatsApp Campaign
GetWhatsappCampaigns
GetWhatsappCampaignsCampaignsInner
Status of the WhatsApp Campaign
GetWhatsAppConfig
Status of the name associated with WhatsApp Phone number
Quality status of phone number associated with WhatsApp account.
Status information related to WhatsApp API account
GetWhatsappEventReport
GetWhatsappEventReportEventsInner
Event which occurred
GetWhatsappTemplates
GetWhatsappTemplatesTemplatesInner
InviteAdminUser
Privileges given to the user
Feature name
Gets or Sets permissions
Inviteuser
Privileges given to the user
Feature name
Gets or Sets permissions
InviteuserResponse
Class that add parsing/formatting support for Java 8+
OffsetDateTime class.LoyaltyProgram
Loyalty Program state
LoyaltyProgramPage
LoyaltyProgramValidationError
LoyaltyTierPage
MainAttributeRewardPayload
MainBillingPayload
MainCodeCountHttpResponse
MainCreateRedeemPayload
MainCreateRewardPayload
MainCreateRewardResponse
MainErrorResponse
MainFilter
MainGenerator
MainGetContactRewardsPayload
Sort the documents in ascending or descending order
Sort documents by field
MainIdentifiersPayload
MainLimit
MainModelContactReward
MainModelContactRewardsResp
MainNodeResponse
MainOrderPayload
MainProduct
MainProductPayload
MainRedeem
MainResultParameterResponse
MainReward
Select startOfPeriod to configure rewards expiry on start of day/week/month/year.
MainRewardAttribution
MainRewardConfigurations
MainRewardPage
MainRewardPageObj
MainRewardValidate
MainRule
MainRuleConditionResponse
MainRuleEventResponse
MainRuleResultResponse
MainValidateRewardPayload
MainValueResponse
MainVoucherRevokePayload
MasterDetailsResponse
Billing details of the master account organization
Billing address of master account
Billing name of master account holder
Plan details
Plan period type
MasterDetailsResponsePlanInfoFeaturesInner
MemberContact
Optional.
ModelSubscriptionBalanceResp
Note Details
Note data to be saved
Updated Note ID
Optional.
Channel used to send the notifications.
Order
OrderBatch
Billing details of an order.
Identifies the contact associated with the order.
OrderMetaInfoValue
Details for the Products in an order.
Otp
PatchLoyaltyProgramPayload
List of stages
List of stages
PostContactInfo
PostContactInfoContacts
PostContactInfoContactsFailure
PostContactInfoContactsSuccess
PostSendFailed
PostSendSmsTestFailed
Revoke user permission
PutresendcancelinvitationResponse
Revoke user permission
PutRevokeUserPermissionResponse
RemoveContactFromListByAll
RemoveContactFromListByEmails
RemoveContactFromListByExtIDs
RemoveContactFromListByIDs
RemoveContactFromListRequest
RequestContactExport
Set the filter for the contacts to be exported.
**Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only.
**Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory.
**Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.
RequestContactImport
RequestContactImportJsonBodyInner
To create a new list and import the contacts into it, pass the listName and an optional folderId.
RequestSmsRecipientExport
Filter the recipients based on how they interacted with the campaign
ScheduleSmtpEmail
SendReport
Language of email content for campaign report sending.
Custom attributes for the report email.
SendSms
SendSmsAsync
SendSmtpEmail
SendSmtpEmailAttachmentInner
SendSmtpEmailBccInner
SendSmtpEmailCcInner
SendSmtpEmailMessageVersionsInner
Email (**required**), along with name (_optional_), on which transactional mail recipients will be able to reply back.
**Mandatory if `templateId` is not passed**.
SendSmtpEmailToInner
SendTestEmail
SendTestSms
SendTransacSms
Type of the SMS.
SendWhatsappMessage201Response
SendWhatsappMessageRequest
SendWhatsappMessageTemplate
SendWhatsappMessageText
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
List of enable/disable applications on the sub-account
SubAccountDetailsResponse
SubAccountDetailsResponseGroupsInner
Sub-account plan details
Credits quota and remaining credits on the sub-account
Email credits remaining on the sub-account
externalFeeds credits remaining on the sub-account
SMS credits remaining on the sub-account
Whatsapp credits remaining on the sub-account
Push credits remaining on the sub-account
Features available on the sub-account
Inbox details / Not available on ENTv2
Landing page details / Not available on ENTv2
Sales and service users to use phone, sales and conversations
Marketing users to manage the marketing channels
SubAccountsResponse
SubAccountsResponseSubAccountsInner
SubAccountsResponseSubAccountsInnerGroupsInner
Details of the plan to be changed
Features details to update
Details of the plan to be changed
Credit details to update
Features details to update
Subscription
SubscriptionAggregateBalance
SubscriptionAttributedReward
SubscriptionBalances
SubscriptionHandlerInfo
SubscriptionMember
SubscriptionTier
Task Details
List of tasks
Task reminder date/time for a task
Gets or Sets types
Unit of time before reminder is to be sent
Task types details
TemplatePreviewModel
TemplatePreviewRequestBody
Tier
TierAccessConditionsInner
TierForContact
TierGroup
Select real_time to downgrade tier on real time balance updates.
Select real_time to upgrade tier on real time balance updates.
TierGroupPage
TierRequest
TierRequestAccessConditionsInner
TierRequestPutPayload
TierRequestTierRewardsInner
TierTierRewardsInner
Represents a transaction involving a balance, including status and timestamps.
Represents a record of a past transaction, including status and key timestamps.
Response containing transaction history details for a specific balance and contact.
UnauthorizedResponse
UpdateAttribute
UpdateAttributeEnumerationInner
Payload for updating an existing balance definition, including expiry rules, rounding strategies, and constraints.
Defines when the balance expires within the selected duration.
Unit of time for balance validity.
Defines whether partial credit is allowed when reaching max balance.
Rounding strategy for credit transactions.
Rounding strategy for debit transactions.
Unit of balance measurement.
Payload for updating an existing balance limit, specifying constraints on transactions or amounts.
Defines whether the limit applies to transaction count or amount.
Unit of time for which the limit is applicable.
Specifies whether the limit applies to credit or debit transactions.
UpdateBatchContacts
UpdateBatchContactsContactsInner
UpdateBatchContactsModel
Status of the campaign
Note:- **replicateTemplate** status will be available **only for template type campaigns
UpdateContact
UpdateCouponCollection200Response
UpdateCouponCollectionRequest
UpdateEmailCampaign
Choose the metrics that will determinate the winning version.
To reduce your carbon footprint, set an expiration date for your email.
unit of the duration
Segment ids and List ids to include/exclude from campaign
Sender details including id or email and name (optional).
UpdateExternalFeed
Auth type of the feed: * `basic` * `token` * `noAuth`
UpdateList
UpdateLoyaltyProgramPayload
UpdateSender
UpdateSmsCampaign
UpdateSmtpTemplate
Sender details including id or email and name (_optional_).
UpdateTierGroupRequest
Select real_time to downgrade tier on real time balance updates.
Select real_time to upgrade tier on real time balance updates.
UpdateUserResponse
UpdateWebhook
Gets or Sets events
UpdateWhatsAppCampaign
Status of the campaign
UploadImageModel
UploadImageToGallery
Upsertrecords202Response
UpsertrecordsRequest
UpsertrecordsRequestRecordsInner
UpsertrecordsRequestRecordsInnerOneOf
UpsertrecordsRequestRecordsInnerOneOf1
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInner
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInner
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInnerOneOf
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInnerOneOf1
Identifiers attached with the associated object record.
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOfRecordsInner
UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOfRecordsInnerIdentifiers
Identifiers attached with the object record.
UpsertrecordsRequestRecordsInnerOneOfAssociationsInner
UpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInner
Identifiers attached with the associated object record.
UpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInnerOneOf
UpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInnerOneOfIdentifiers
Identifiers attached with the object record.
VariablesItems
WhatsappCampStats
WhatsappCampTemplate