Uses of Class
software.xdev.brevo.client.ApiException
Packages that use ApiException
-
Uses of ApiException in software.xdev.brevo.api
Methods in software.xdev.brevo.api that throw ApiExceptionModifier and TypeMethodDescriptionContactsApi.addContactToList(Long listId, AddContactToListRequest addContactToListRequest) Add existing contacts to a listContactsApi.addContactToList(Long listId, AddContactToListRequest addContactToListRequest, Map<String, String> additionalHeaders) Add existing contacts to a listTierApi.addSubscriptionToTier(UUID pid, UUID cid, UUID tid) Assign a tier Manually assigns a tier to a specific membership.Assign a tier Manually assigns a tier to a specific membership.DomainsApi.authenticateDomain(String domainName) Authenticate a domainDomainsApi.authenticateDomain(String domainName, Map<String, String> additionalHeaders) Authenticate a domainBalanceApi.beginTransaction(UUID pid, CreateTransactionPayload createTransactionPayload) Create new transaction Creates new transaction and returns informationBalanceApi.beginTransaction(UUID pid, CreateTransactionPayload createTransactionPayload, Map<String, String> additionalHeaders) Create new transaction Creates new transaction and returns informationvoidTransactionalEmailsApi.blockNewDomain(BlockDomain blockDomain) Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the samevoidTransactionalEmailsApi.blockNewDomain(BlockDomain blockDomain, Map<String, String> additionalHeaders) Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the sameBalanceApi.cancelTransaction(UUID pid, UUID tid) Cancel transaction Cancels transactionCancel transaction Cancels transactionCompaniesApi.companiesGet(String filters, Long linkedContactsIds, String linkedDealsIds, String modifiedSince, String createdSince, Long page, Long limit, String sort, String sortBy) Get all CompaniesCompaniesApi.companiesGet(String filters, Long linkedContactsIds, String linkedDealsIds, String modifiedSince, String createdSince, Long page, Long limit, String sort, String sortBy, Map<String, String> additionalHeaders) Get all CompaniesvoidCompaniesApi.companiesIdDelete(String id) Delete a companyvoidCompaniesApi.companiesIdDelete(String id, Map<String, String> additionalHeaders) Delete a companyCompaniesApi.companiesIdGet(String id) Get a companyCompaniesApi.companiesIdGet(String id, Map<String, String> additionalHeaders) Get a companyCompaniesApi.companiesIdPatch(String id, CompaniesIdPatchRequest companiesIdPatchRequest) Update a companyCompaniesApi.companiesIdPatch(String id, CompaniesIdPatchRequest companiesIdPatchRequest, Map<String, String> additionalHeaders) Update a companyCompaniesApi.companiesImportPost(File _file, Object mapping) Import companies(creation and updation) Import companies from a CSV file with mapping options.Import companies(creation and updation) Import companies from a CSV file with mapping options.voidCompaniesApi.companiesLinkUnlinkIdPatch(String id, CompaniesLinkUnlinkIdPatchRequest companiesLinkUnlinkIdPatchRequest) Link and Unlink company with contact and dealvoidCompaniesApi.companiesLinkUnlinkIdPatch(String id, CompaniesLinkUnlinkIdPatchRequest companiesLinkUnlinkIdPatchRequest, Map<String, String> additionalHeaders) Link and Unlink company with contact and dealCompaniesApi.companiesPost(CompaniesPostRequest companiesPostRequest) Create a companyCompaniesApi.companiesPost(CompaniesPostRequest companiesPostRequest, Map<String, String> additionalHeaders) Create a companyRewardApi.completeRedeemTransaction(UUID pid, String tid) Complete redeem voucher request Completes voucher redeem request.Complete redeem voucher request Completes voucher redeem request.BalanceApi.completeTransaction(UUID pid, UUID tid) Complete transaction Completes transactionComplete transaction Completes transactionvoidConversationsApi.conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest) Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.voidConversationsApi.conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest, Map<String, String> additionalHeaders) Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.voidConversationsApi.conversationsMessagesIdDelete(String id) Delete a message sent by an agent Only agents’ messages can be deleted.voidConversationsApi.conversationsMessagesIdDelete(String id, Map<String, String> additionalHeaders) Delete a message sent by an agent Only agents’ messages can be deleted.ConversationsApi.conversationsMessagesIdGet(String id) Get a messageConversationsApi.conversationsMessagesIdGet(String id, Map<String, String> additionalHeaders) Get a messageConversationsApi.conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest) Update a message sent by an agent Only agents’ messages can be edited.ConversationsApi.conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String, String> additionalHeaders) Update a message sent by an agent Only agents’ messages can be edited.ConversationsApi.conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest) Send a message as an agentConversationsApi.conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest, Map<String, String> additionalHeaders) Send a message as an agentvoidConversationsApi.conversationsPushedMessagesIdDelete(String id) Delete an automated messagevoidConversationsApi.conversationsPushedMessagesIdDelete(String id, Map<String, String> additionalHeaders) Delete an automated messageConversationsApi.conversationsPushedMessagesIdGet(String id) Get an automated messageConversationsApi.conversationsPushedMessagesIdGet(String id, Map<String, String> additionalHeaders) Get an automated messageConversationsApi.conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest) Update an automated messageConversationsApi.conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String, String> additionalHeaders) Update an automated messageConversationsApi.conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest) Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.ConversationsApi.conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest, Map<String, String> additionalHeaders) Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.voidMasterAccountApi.corporateGroupIdDelete(String id) Delete a group This endpoint allows you to delete a group of sub-organizations.voidMasterAccountApi.corporateGroupIdDelete(String id, Map<String, String> additionalHeaders) Delete a group This endpoint allows you to delete a group of sub-organizations.MasterAccountApi.corporateGroupIdGet(String id) GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.MasterAccountApi.corporateGroupIdGet(String id, Map<String, String> additionalHeaders) GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.voidMasterAccountApi.corporateGroupIdPut(String id, CorporateGroupIdPutRequest corporateGroupIdPutRequest) Update a group of sub-accounts This endpoint allows to update a group of sub-accountsvoidMasterAccountApi.corporateGroupIdPut(String id, CorporateGroupIdPutRequest corporateGroupIdPutRequest, Map<String, String> additionalHeaders) Update a group of sub-accounts This endpoint allows to update a group of sub-accountsMasterAccountApi.corporateGroupPost(CorporateGroupPostRequest corporateGroupPostRequest) Create a group of sub-accounts This endpoint allows to create a group of sub-accountsMasterAccountApi.corporateGroupPost(CorporateGroupPostRequest corporateGroupPostRequest, Map<String, String> additionalHeaders) Create a group of sub-accounts This endpoint allows to create a group of sub-accountsvoidMasterAccountApi.corporateGroupUnlinkGroupIdSubAccountsPut(String groupId, CorporateGroupUnlinkGroupIdSubAccountsPutRequest corporateGroupUnlinkGroupIdSubAccountsPutRequest) Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.voidMasterAccountApi.corporateGroupUnlinkGroupIdSubAccountsPut(String groupId, CorporateGroupUnlinkGroupIdSubAccountsPutRequest corporateGroupUnlinkGroupIdSubAccountsPutRequest, Map<String, String> additionalHeaders) Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.MasterAccountApi.corporateIpGet()List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin accountMasterAccountApi.corporateIpGet(Map<String, String> additionalHeaders) List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin accountMasterAccountApi.corporateMasterAccountGet()Get the details of requested master account This endpoint will provide the details of the master account.MasterAccountApi.corporateMasterAccountGet(Map<String, String> additionalHeaders) Get the details of requested master account This endpoint will provide the details of the master account.MasterAccountApi.corporateSsoTokenPost(CorporateSsoTokenPostRequest corporateSsoTokenPostRequest) Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.MasterAccountApi.corporateSsoTokenPost(CorporateSsoTokenPostRequest corporateSsoTokenPostRequest, Map<String, String> additionalHeaders) Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.MasterAccountApi.corporateSubAccountGet(Integer offset, Integer limit) Get the list of all the sub-accounts of the master account.MasterAccountApi.corporateSubAccountGet(Integer offset, Integer limit, Map<String, String> additionalHeaders) Get the list of all the sub-accounts of the master account.voidMasterAccountApi.corporateSubAccountIdApplicationsTogglePut(Long id, SubAccountAppsToggleRequest subAccountAppsToggleRequest) Enable/disable sub-account application(s) API endpoints for the Corporate owner to enable/disable applications on the sub-accountvoidMasterAccountApi.corporateSubAccountIdApplicationsTogglePut(Long id, SubAccountAppsToggleRequest subAccountAppsToggleRequest, Map<String, String> additionalHeaders) Enable/disable sub-account application(s) API endpoints for the Corporate owner to enable/disable applications on the sub-accountvoidMasterAccountApi.corporateSubAccountIdDelete(Long id) Delete a sub-accountvoidMasterAccountApi.corporateSubAccountIdDelete(Long id, Map<String, String> additionalHeaders) Delete a sub-accountMasterAccountApi.corporateSubAccountIdGet(Long id) Get sub-account details This endpoint will provide the details for the specified sub-account companyMasterAccountApi.corporateSubAccountIdGet(Long id, Map<String, String> additionalHeaders) Get sub-account details This endpoint will provide the details for the specified sub-account companyvoidMasterAccountApi.corporateSubAccountIdPlanPut(Long id, SubAccountUpdatePlanRequest subAccountUpdatePlanRequest) Update sub-account plan This endpoint will update the sub-account plan.voidMasterAccountApi.corporateSubAccountIdPlanPut(Long id, SubAccountUpdatePlanRequest subAccountUpdatePlanRequest, Map<String, String> additionalHeaders) Update sub-account plan This endpoint will update the sub-account plan.MasterAccountApi.corporateSubAccountIpAssociatePost(CorporateSubAccountIpAssociatePostRequest corporateSubAccountIpAssociatePostRequest) Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accountsMasterAccountApi.corporateSubAccountIpAssociatePost(CorporateSubAccountIpAssociatePostRequest corporateSubAccountIpAssociatePostRequest, Map<String, String> additionalHeaders) Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accountsvoidMasterAccountApi.corporateSubAccountIpDissociatePut(CorporateSubAccountIpDissociatePutRequest corporateSubAccountIpDissociatePutRequest) Dissociate an IP to sub-accounts This endpoint allows to dissociate an IP from sub-accountsvoidMasterAccountApi.corporateSubAccountIpDissociatePut(CorporateSubAccountIpDissociatePutRequest corporateSubAccountIpDissociatePutRequest, Map<String, String> additionalHeaders) Dissociate an IP to sub-accounts This endpoint allows to dissociate an IP from sub-accountsMasterAccountApi.corporateSubAccountKeyPost(CorporateSubAccountKeyPostRequest corporateSubAccountKeyPostRequest) Create an API key for a sub-account This endpoint will generate an API v3 key for a sub accountMasterAccountApi.corporateSubAccountKeyPost(CorporateSubAccountKeyPostRequest corporateSubAccountKeyPostRequest, Map<String, String> additionalHeaders) Create an API key for a sub-account This endpoint will generate an API v3 key for a sub accountMasterAccountApi.corporateSubAccountPost(CreateSubAccount createSubAccount) Create a new sub-account under a master account.MasterAccountApi.corporateSubAccountPost(CreateSubAccount createSubAccount, Map<String, String> additionalHeaders) Create a new sub-account under a master account.voidMasterAccountApi.corporateSubAccountsPlanPut(SubAccountsUpdatePlanRequest subAccountsUpdatePlanRequest) Update sub-accounts plan This endpoint will update multiple sub-accounts plan.voidMasterAccountApi.corporateSubAccountsPlanPut(SubAccountsUpdatePlanRequest subAccountsUpdatePlanRequest, Map<String, String> additionalHeaders) Update sub-accounts plan This endpoint will update multiple sub-accounts plan.MasterAccountApi.corporateSubAccountSsoTokenPost(CorporateSubAccountSsoTokenPostRequest corporateSubAccountSsoTokenPostRequest) Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.MasterAccountApi.corporateSubAccountSsoTokenPost(CorporateSubAccountSsoTokenPostRequest corporateSubAccountSsoTokenPostRequest, Map<String, String> additionalHeaders) Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.voidMasterAccountApi.corporateUserEmailPermissionsPut(String email, CorporateUserEmailPermissionsPutRequest corporateUserEmailPermissionsPutRequest) Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin accountvoidMasterAccountApi.corporateUserEmailPermissionsPut(String email, CorporateUserEmailPermissionsPutRequest corporateUserEmailPermissionsPutRequest, Map<String, String> additionalHeaders) Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin accountMasterAccountApi.corporateUserInvitationActionEmailPut(String action, String email) Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitationMasterAccountApi.corporateUserInvitationActionEmailPut(String action, String email, Map<String, String> additionalHeaders) Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitationvoidMasterAccountApi.corporateUserRevokeEmailDelete(String email) Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin accountvoidMasterAccountApi.corporateUserRevokeEmailDelete(String email, Map<String, String> additionalHeaders) Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin accountvoidContactsApi.createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute) Create contact attributevoidContactsApi.createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute, Map<String, String> additionalHeaders) Create contact attributeBalanceApi.createBalanceLimit(UUID pid, UUID bdid, CreateBalanceLimitPayload createBalanceLimitPayload) Create balance limits Creates balance limit and sends the created UUID along with the dataBalanceApi.createBalanceLimit(UUID pid, UUID bdid, CreateBalanceLimitPayload createBalanceLimitPayload, Map<String, String> additionalHeaders) Create balance limits Creates balance limit and sends the created UUID along with the dataBalanceApi.createBalanceOrder(UUID pid, CreateOrderPayload createOrderPayload) Create balance order Returns created orderBalanceApi.createBalanceOrder(UUID pid, CreateOrderPayload createOrderPayload, Map<String, String> additionalHeaders) Create balance order Returns created orderEcommerceApi.createBatchOrder(OrderBatch orderBatch) Create orders in batch Create multiple orders at one time instead of one order at a timeEcommerceApi.createBatchOrder(OrderBatch orderBatch, Map<String, String> additionalHeaders) Create orders in batch Create multiple orders at one time instead of one order at a timeContactsApi.createContact(CreateContact createContact) Create a contact Creates new contacts on Brevo.ContactsApi.createContact(CreateContact createContact, Map<String, String> additionalHeaders) Create a contact Creates new contacts on Brevo.CouponsApi.createCouponCollection(CreateCouponCollectionRequest createCouponCollectionRequest) Create а coupon collectionCouponsApi.createCouponCollection(CreateCouponCollectionRequest createCouponCollectionRequest, Map<String, String> additionalHeaders) Create а coupon collectionvoidCouponsApi.createCoupons(CreateCouponsRequest createCouponsRequest) Create coupons for a coupon collectionvoidCouponsApi.createCoupons(CreateCouponsRequest createCouponsRequest, Map<String, String> additionalHeaders) Create coupons for a coupon collectionvoidContactsApi.createDoiContact(CreateDoiContact createDoiContact) Create Contact via DOI (Double-Opt-In) FlowvoidContactsApi.createDoiContact(CreateDoiContact createDoiContact, Map<String, String> additionalHeaders) Create Contact via DOI (Double-Opt-In) FlowDomainsApi.createDomain(CreateDomain domain) Create a new domainDomainsApi.createDomain(CreateDomain domain, Map<String, String> additionalHeaders) Create a new domainEmailCampaignsApi.createEmailCampaign(CreateEmailCampaign createEmailCampaign) Create an email campaignEmailCampaignsApi.createEmailCampaign(CreateEmailCampaign createEmailCampaign, Map<String, String> additionalHeaders) Create an email campaignvoidEventApi.createEvent(Event event) Create an event Create an event to track a contact's interaction.voidEventApi.createEvent(Event event, Map<String, String> additionalHeaders) Create an event Create an event to track a contact's interaction.ExternalFeedsApi.createExternalFeed(CreateExternalFeed createExternalFeed) Create an external feed This endpoint will create an external feed.ExternalFeedsApi.createExternalFeed(CreateExternalFeed createExternalFeed, Map<String, String> additionalHeaders) Create an external feed This endpoint will create an external feed.ContactsApi.createFolder(CreateUpdateFolder createFolder) Create a folderContactsApi.createFolder(CreateUpdateFolder createFolder, Map<String, String> additionalHeaders) Create a folderContactsApi.createList(CreateList createList) Create a listContactsApi.createList(CreateList createList, Map<String, String> additionalHeaders) Create a listProgramApi.createNewLP(CreateLoyaltyProgramPayload createLoyaltyProgramPayload) Create loyalty program Creates loyalty programProgramApi.createNewLP(CreateLoyaltyProgramPayload createLoyaltyProgramPayload, Map<String, String> additionalHeaders) Create loyalty program Creates loyalty programvoidEcommerceApi.createOrder(Order order) Managing the status of the order Manages the transactional status of the ordervoidEcommerceApi.createOrder(Order order, Map<String, String> additionalHeaders) Managing the status of the order Manages the transactional status of the orderPaymentsApi.createPaymentRequest(CreatePaymentRequest createPaymentRequest) Create a payment requestPaymentsApi.createPaymentRequest(CreatePaymentRequest createPaymentRequest, Map<String, String> additionalHeaders) Create a payment requestRewardApi.createReward(UUID pid, MainCreateRewardPayload mainCreateRewardPayload) Create a reward Creates a new reward in the loyalty program.RewardApi.createReward(UUID pid, MainCreateRewardPayload mainCreateRewardPayload, Map<String, String> additionalHeaders) Create a reward Creates a new reward in the loyalty program.SendersApi.createSender(CreateSender sender) Create a new senderSendersApi.createSender(CreateSender sender, Map<String, String> additionalHeaders) Create a new senderSmsCampaignsApi.createSmsCampaign(CreateSmsCampaign createSmsCampaign) Creates an SMS campaignSmsCampaignsApi.createSmsCampaign(CreateSmsCampaign createSmsCampaign, Map<String, String> additionalHeaders) Creates an SMS campaignTransactionalEmailsApi.createSmtpTemplate(CreateSmtpTemplate createSmtpTemplate) Create an email templateTransactionalEmailsApi.createSmtpTemplate(CreateSmtpTemplate createSmtpTemplate, Map<String, String> additionalHeaders) Create an email templateTierApi.createTierForTierGroup(UUID pid, UUID gid, TierRequest tierRequest) Create a tier Creates a new tier in a loyalty program tier group.TierApi.createTierForTierGroup(UUID pid, UUID gid, TierRequest tierRequest, Map<String, String> additionalHeaders) Create a tier Creates a new tier in a loyalty program tier group.TierApi.createTierGroup(UUID pid, CreateTierGroupRequest createTierGroupRequest) Create a tier group Creates a new tier group in a loyalty program.TierApi.createTierGroup(UUID pid, CreateTierGroupRequest createTierGroupRequest, Map<String, String> additionalHeaders) Create a tier group Creates a new tier group in a loyalty program.EcommerceApi.createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory) Create categories in batchEcommerceApi.createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory, Map<String, String> additionalHeaders) Create categories in batchEcommerceApi.createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts) Create products in batchEcommerceApi.createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts, Map<String, String> additionalHeaders) Create products in batchEcommerceApi.createUpdateCategory(CreateUpdateCategory createUpdateCategory) Create/Update a categoryEcommerceApi.createUpdateCategory(CreateUpdateCategory createUpdateCategory, Map<String, String> additionalHeaders) Create/Update a categoryEcommerceApi.createUpdateProduct(CreateUpdateProduct createUpdateProduct) Create/Update a productEcommerceApi.createUpdateProduct(CreateUpdateProduct createUpdateProduct, Map<String, String> additionalHeaders) Create/Update a productRewardApi.createVoucher(UUID pid, MainAttributeRewardPayload mainAttributeRewardPayload) Create a voucher Create a voucher and attribute it to a specific membership.RewardApi.createVoucher(UUID pid, MainAttributeRewardPayload mainAttributeRewardPayload, Map<String, String> additionalHeaders) Create a voucher Create a voucher and attribute it to a specific membership.WebhooksApi.createWebhook(CreateWebhook createWebhook) Create a webhookWebhooksApi.createWebhook(CreateWebhook createWebhook, Map<String, String> additionalHeaders) Create a webhookWhatsAppCampaignsApi.createWhatsAppCampaign(CreateWhatsAppCampaign createWhatsAppCampaign) Create and Send a WhatsApp campaignWhatsAppCampaignsApi.createWhatsAppCampaign(CreateWhatsAppCampaign createWhatsAppCampaign, Map<String, String> additionalHeaders) Create and Send a WhatsApp campaignWhatsAppCampaignsApi.createWhatsAppTemplate(CreateWhatsAppTemplate createWhatsAppTemplate) Create a WhatsApp templateWhatsAppCampaignsApi.createWhatsAppTemplate(CreateWhatsAppTemplate createWhatsAppTemplate, Map<String, String> additionalHeaders) Create a WhatsApp templateCompaniesApi.crmAttributesCompaniesGet()Get company attributesCompaniesApi.crmAttributesCompaniesGet(Map<String, String> additionalHeaders) Get company attributesDealsApi.crmAttributesDealsGet()Get deal attributesDealsApi.crmAttributesDealsGet(Map<String, String> additionalHeaders) Get deal attributesCompaniesApi.crmAttributesPost(CrmAttributesPostRequest crmAttributesPostRequest) Create a company/deal attributeCompaniesApi.crmAttributesPost(CrmAttributesPostRequest crmAttributesPostRequest, Map<String, String> additionalHeaders) Create a company/deal attributeDealsApi.crmAttributesPost(CrmAttributesPostRequest crmAttributesPostRequest) Create a company/deal attributeDealsApi.crmAttributesPost(CrmAttributesPostRequest crmAttributesPostRequest, Map<String, String> additionalHeaders) Create a company/deal attributeDealsApi.crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, String modifiedSince, String createdSince, Long offset, Long limit, String sort) Get all dealsDealsApi.crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, String modifiedSince, String createdSince, Long offset, Long limit, String sort, Map<String, String> additionalHeaders) Get all dealsvoidDealsApi.crmDealsIdDelete(String id) Delete a dealvoidDealsApi.crmDealsIdDelete(String id, Map<String, String> additionalHeaders) Delete a dealDealsApi.crmDealsIdGet(String id) Get a dealDealsApi.crmDealsIdGet(String id, Map<String, String> additionalHeaders) Get a dealvoidDealsApi.crmDealsIdPatch(String id, CrmDealsIdPatchRequest crmDealsIdPatchRequest) Update a dealvoidDealsApi.crmDealsIdPatch(String id, CrmDealsIdPatchRequest crmDealsIdPatchRequest, Map<String, String> additionalHeaders) Update a dealDealsApi.crmDealsImportPost(File _file, Object mapping) Import deals(creation and updation) Import deals from a CSV file with mapping options.Import deals(creation and updation) Import deals from a CSV file with mapping options.voidDealsApi.crmDealsLinkUnlinkIdPatch(String id, CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest) Link and Unlink a deal with contacts and companiesvoidDealsApi.crmDealsLinkUnlinkIdPatch(String id, CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest, Map<String, String> additionalHeaders) Link and Unlink a deal with contacts and companiesDealsApi.crmDealsPost(CrmDealsPostRequest crmDealsPostRequest) Create a dealDealsApi.crmDealsPost(CrmDealsPostRequest crmDealsPostRequest, Map<String, String> additionalHeaders) Create a dealFilesApi.crmFilesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort) Get all filesFilesApi.crmFilesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, Map<String, String> additionalHeaders) Get all filesFilesApi.crmFilesIdDataGet(String id) Get file detailsFilesApi.crmFilesIdDataGet(String id, Map<String, String> additionalHeaders) Get file detailsvoidFilesApi.crmFilesIdDelete(String id) Delete a filevoidFilesApi.crmFilesIdDelete(String id, Map<String, String> additionalHeaders) Delete a fileFilesApi.crmFilesIdGet(String id) Download a fileFilesApi.crmFilesIdGet(String id, Map<String, String> additionalHeaders) Download a fileFilesApi.crmFilesPost(File _file, String dealId, Long contactId, String companyId) Upload a fileFilesApi.crmFilesPost(File _file, String dealId, Long contactId, String companyId, Map<String, String> additionalHeaders) Upload a fileNotesApi.crmNotesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort) Get all notesNotesApi.crmNotesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, Map<String, String> additionalHeaders) Get all notesvoidNotesApi.crmNotesIdDelete(String id) Delete a notevoidNotesApi.crmNotesIdDelete(String id, Map<String, String> additionalHeaders) Delete a noteNotesApi.crmNotesIdGet(String id) Get a noteNotesApi.crmNotesIdGet(String id, Map<String, String> additionalHeaders) Get a notevoidNotesApi.crmNotesIdPatch(String id, NoteData noteData) Update a notevoidUpdate a noteNotesApi.crmNotesPost(NoteData noteData) Create a noteNotesApi.crmNotesPost(NoteData noteData, Map<String, String> additionalHeaders) Create a noteDealsApi.crmPipelineDetailsAllGet()Get all pipelinesDealsApi.crmPipelineDetailsAllGet(Map<String, String> additionalHeaders) Get all pipelinesDealsApi.crmPipelineDetailsGet()Deprecated.DealsApi.crmPipelineDetailsGet(Map<String, String> additionalHeaders) Deprecated.DealsApi.crmPipelineDetailsPipelineIDGet(String pipelineID) Get a pipelineDealsApi.crmPipelineDetailsPipelineIDGet(String pipelineID, Map<String, String> additionalHeaders) Get a pipelineTasksApi.crmTasksGet(String filterType, String filterStatus, String filterDate, String filterAssignTo, String filterContacts, String filterDeals, String filterCompanies, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, String sortBy) Get all tasksTasksApi.crmTasksGet(String filterType, String filterStatus, String filterDate, String filterAssignTo, String filterContacts, String filterDeals, String filterCompanies, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, String sortBy, Map<String, String> additionalHeaders) Get all tasksvoidTasksApi.crmTasksIdDelete(String id) Delete a taskvoidTasksApi.crmTasksIdDelete(String id, Map<String, String> additionalHeaders) Delete a taskTasksApi.crmTasksIdGet(String id) Get a taskTasksApi.crmTasksIdGet(String id, Map<String, String> additionalHeaders) Get a taskvoidTasksApi.crmTasksIdPatch(String id, CrmTasksIdPatchRequest crmTasksIdPatchRequest) Update a taskvoidTasksApi.crmTasksIdPatch(String id, CrmTasksIdPatchRequest crmTasksIdPatchRequest, Map<String, String> additionalHeaders) Update a taskTasksApi.crmTasksPost(CrmTasksPostRequest crmTasksPostRequest) Create a taskTasksApi.crmTasksPost(CrmTasksPostRequest crmTasksPostRequest, Map<String, String> additionalHeaders) Create a taskTasksApi.crmTasktypesGet()Get all task typesTasksApi.crmTasktypesGet(Map<String, String> additionalHeaders) Get all task typesvoidContactsApi.deleteAttribute(String attributeCategory, String attributeName) Delete an attributevoidContactsApi.deleteAttribute(String attributeCategory, String attributeName, Map<String, String> additionalHeaders) Delete an attributevoidBalanceApi.deleteBalanceDefinition(UUID pid, UUID bdid) Delete balance definition Delete Balance definitionvoidDelete balance definition Delete Balance definitionvoidBalanceApi.deleteBalanceLimit(UUID pid, UUID bdid, UUID blid) Delete balance limit Delete balance limitvoidDelete balance limit Delete balance limitvoidTransactionalEmailsApi.deleteBlockedDomain(String domain) Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domainsvoidTransactionalEmailsApi.deleteBlockedDomain(String domain, Map<String, String> additionalHeaders) Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domainsvoidContactsApi.deleteContact(GetContactInfoIdentifierParameter identifier, String identifierType) Delete a contact There are 2 ways to delete a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?voidContactsApi.deleteContact(GetContactInfoIdentifierParameter identifier, String identifierType, Map<String, String> additionalHeaders) Delete a contact There are 2 ways to delete a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?voidProgramApi.deleteContactMembers(UUID pid, String memberContactIds) Delete subscription member Deletes member from a subscriptionvoidProgramApi.deleteContactMembers(UUID pid, String memberContactIds, Map<String, String> additionalHeaders) Delete subscription member Deletes member from a subscriptionvoidDomainsApi.deleteDomain(String domainName) Delete a domainvoidDomainsApi.deleteDomain(String domainName, Map<String, String> additionalHeaders) Delete a domainvoidEmailCampaignsApi.deleteEmailCampaign(Long campaignId) Delete an email campaignvoidEmailCampaignsApi.deleteEmailCampaign(Long campaignId, Map<String, String> additionalHeaders) Delete an email campaignvoidExternalFeedsApi.deleteExternalFeed(String uuid) Delete an external feed This endpoint will delete an external feed.voidExternalFeedsApi.deleteExternalFeed(String uuid, Map<String, String> additionalHeaders) Delete an external feed This endpoint will delete an external feed.voidContactsApi.deleteFolder(Long folderId) Delete a folder (and all its lists)voidContactsApi.deleteFolder(Long folderId, Map<String, String> additionalHeaders) Delete a folder (and all its lists)voidTransactionalEmailsApi.deleteHardbounces(DeleteHardbounces deleteHardbounces) Delete hardbounces Delete hardbounces.voidTransactionalEmailsApi.deleteHardbounces(DeleteHardbounces deleteHardbounces, Map<String, String> additionalHeaders) Delete hardbounces Delete hardbounces.voidContactsApi.deleteList(Long listId) Delete a listvoidContactsApi.deleteList(Long listId, Map<String, String> additionalHeaders) Delete a listvoidProgramApi.deleteLoyaltyProgram(UUID pid) Delete Loyalty Program Deletes Loyalty ProgramvoidProgramApi.deleteLoyaltyProgram(UUID pid, Map<String, String> additionalHeaders) Delete Loyalty Program Deletes Loyalty ProgramvoidContactsApi.deleteMultiAttributeOptions(String attributeType, String multipleChoiceAttribute, String multipleChoiceAttributeOption) Delete a multiple-choice attribute optionvoidContactsApi.deleteMultiAttributeOptions(String attributeType, String multipleChoiceAttribute, String multipleChoiceAttributeOption, Map<String, String> additionalHeaders) Delete a multiple-choice attribute optionvoidPaymentsApi.deletePaymentRequest(UUID id) Delete a payment request.voidPaymentsApi.deletePaymentRequest(UUID id, Map<String, String> additionalHeaders) Delete a payment request.voidTransactionalEmailsApi.deleteScheduledEmailById(String identifier) Delete scheduled emails by batchId or messageId Delete scheduled batch of emails by batchId or single scheduled email by messageIdvoidTransactionalEmailsApi.deleteScheduledEmailById(String identifier, Map<String, String> additionalHeaders) Delete scheduled emails by batchId or messageId Delete scheduled batch of emails by batchId or single scheduled email by messageIdvoidSendersApi.deleteSender(Long senderId) Delete a sendervoidSendersApi.deleteSender(Long senderId, Map<String, String> additionalHeaders) Delete a sendervoidSmsCampaignsApi.deleteSmsCampaign(Long campaignId) Delete an SMS campaignvoidSmsCampaignsApi.deleteSmsCampaign(Long campaignId, Map<String, String> additionalHeaders) Delete an SMS campaignvoidTransactionalEmailsApi.deleteSmtpTemplate(Long templateId) Delete an inactive email templatevoidTransactionalEmailsApi.deleteSmtpTemplate(Long templateId, Map<String, String> additionalHeaders) Delete an inactive email templateTierApi.deleteTier(UUID pid, UUID tid) Delete tier Deletes a tier from a loyalty program tier group.Delete tier Deletes a tier from a loyalty program tier group.TierApi.deleteTierGroup(UUID pid, UUID gid) Delete tier group Deletes a tier group from a loyalty program.Delete tier group Deletes a tier group from a loyalty program.voidWebhooksApi.deleteWebhook(Long webhookId) Delete a webhookvoidWebhooksApi.deleteWebhook(Long webhookId, Map<String, String> additionalHeaders) Delete a webhookvoidWhatsAppCampaignsApi.deleteWhatsAppCampaign(Long campaignId) Delete a WhatsApp campaignvoidWhatsAppCampaignsApi.deleteWhatsAppCampaign(Long campaignId, Map<String, String> additionalHeaders) Delete a WhatsApp campaignvoidEcommerceApi.ecommerceActivatePost()Activate the eCommerce app Getting access to Brevo eCommerce.voidEcommerceApi.ecommerceActivatePost(Map<String, String> additionalHeaders) Activate the eCommerce app Getting access to Brevo eCommerce.EcommerceApi.ecommerceAttributionMetricsConversionSourceConversionSourceIdGet(String conversionSource, String conversionSourceId) Get detailed attribution metrics for a single Brevo campaign or workflowEcommerceApi.ecommerceAttributionMetricsConversionSourceConversionSourceIdGet(String conversionSource, String conversionSourceId, Map<String, String> additionalHeaders) Get detailed attribution metrics for a single Brevo campaign or workflowEcommerceApi.ecommerceAttributionMetricsGet(OffsetDateTime periodFrom, OffsetDateTime periodTo, List<String> emailCampaignId, List<String> smsCampaignId, List<String> automationWorkflowEmailId, List<String> automationWorkflowSmsId) Get attribution metrics for one or more Brevo campaigns or workflowsEcommerceApi.ecommerceAttributionMetricsGet(OffsetDateTime periodFrom, OffsetDateTime periodTo, List<String> emailCampaignId, List<String> smsCampaignId, List<String> automationWorkflowEmailId, List<String> automationWorkflowSmsId, Map<String, String> additionalHeaders) Get attribution metrics for one or more Brevo campaigns or workflowsEcommerceApi.ecommerceAttributionProductsConversionSourceConversionSourceIdGet(String conversionSource, String conversionSourceId) Get attributed product sales for a single Brevo campaign or workflowEcommerceApi.ecommerceAttributionProductsConversionSourceConversionSourceIdGet(String conversionSource, String conversionSourceId, Map<String, String> additionalHeaders) Get attributed product sales for a single Brevo campaign or workflowEcommerceApi.ecommerceConfigDisplayCurrencyGet()Get the ISO 4217 compliant display currency code for your Brevo accountEcommerceApi.ecommerceConfigDisplayCurrencyGet(Map<String, String> additionalHeaders) Get the ISO 4217 compliant display currency code for your Brevo accountUserApi.editUserPermission(Inviteuser inviteuser) Update permission for a user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo.UserApi.editUserPermission(Inviteuser inviteuser, Map<String, String> additionalHeaders) Update permission for a user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo.EmailCampaignsApi.emailExportRecipients(Long campaignId, EmailExportRecipients emailExportRecipients) Export the recipients of an email campaignEmailCampaignsApi.emailExportRecipients(Long campaignId, EmailExportRecipients emailExportRecipients, Map<String, String> additionalHeaders) Export the recipients of an email campaignWebhooksApi.exportWebhooksHistory(ExportWebhooksHistory exportWebhooksHistory) Export all webhook events This endpoint will submit a request to get the history of webhooks in the CSV file.WebhooksApi.exportWebhooksHistory(ExportWebhooksHistory exportWebhooksHistory, Map<String, String> additionalHeaders) Export all webhook events This endpoint will submit a request to get the history of webhooks in the CSV file.EmailCampaignsApi.getAbTestCampaignResult(Long campaignId) Get an A/B test email campaign results Obtain winning version of an A/B test email campaignEmailCampaignsApi.getAbTestCampaignResult(Long campaignId, Map<String, String> additionalHeaders) Get an A/B test email campaign results Obtain winning version of an A/B test email campaignAccountApi.getAccount()Get your account information, plan and credits detailsAccountApi.getAccount(Map<String, String> additionalHeaders) Get your account information, plan and credits detailsAccountApi.getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset) Get user activity logsAccountApi.getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset, Map<String, String> additionalHeaders) Get user activity logsMasterAccountApi.getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset) Get user activity logsMasterAccountApi.getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset, Map<String, String> additionalHeaders) Get user activity logsTransactionalEmailsApi.getAggregatedSmtpReport(String startDate, String endDate, Long days, String tag) Get your transactional email activity aggregated over a period of time This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed.TransactionalEmailsApi.getAggregatedSmtpReport(String startDate, String endDate, Long days, String tag, Map<String, String> additionalHeaders) Get your transactional email activity aggregated over a period of time This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed.ExternalFeedsApi.getAllExternalFeeds(String search, LocalDate startDate, LocalDate endDate, String sort, String authType, Long limit, Long offset) Fetch all external feeds This endpoint can fetch all created external feeds.ExternalFeedsApi.getAllExternalFeeds(String search, LocalDate startDate, LocalDate endDate, String sort, String authType, Long limit, Long offset, Map<String, String> additionalHeaders) Fetch all external feeds This endpoint can fetch all created external feeds.ContactsApi.getAttributes()List all attributesContactsApi.getAttributes(Map<String, String> additionalHeaders) List all attributesBalanceApi.getBalanceDefinition(UUID pid, UUID bdid, String version) Get balance definition Returns balance definitionBalanceApi.getBalanceDefinition(UUID pid, UUID bdid, String version, Map<String, String> additionalHeaders) Get balance definition Returns balance definitionBalanceApi.getBalanceDefinitionList(UUID pid, Integer limit, Integer offset, String sortField, String sort, String version) Get balance definition list Returns balance definition pageBalanceApi.getBalanceDefinitionList(UUID pid, Integer limit, Integer offset, String sortField, String sort, String version, Map<String, String> additionalHeaders) Get balance definition list Returns balance definition pageBalanceApi.getBalanceLimit(UUID pid, UUID bdid, UUID blid, String version) Get balance limits Fetches balance limits and send the created UUID along with the dataBalanceApi.getBalanceLimit(UUID pid, UUID bdid, UUID blid, String version, Map<String, String> additionalHeaders) Get balance limits Fetches balance limits and send the created UUID along with the dataTransactionalEmailsApi.getBlockedDomains()Get the list of blocked domains Get the list of blocked domainsTransactionalEmailsApi.getBlockedDomains(Map<String, String> additionalHeaders) Get the list of blocked domains Get the list of blocked domainsEcommerceApi.getCategories(Long limit, Long offset, String sort, List<String> ids, String name, String modifiedSince, String createdSince) Return all your categoriesEcommerceApi.getCategories(Long limit, Long offset, String sort, List<String> ids, String name, String modifiedSince, String createdSince, Map<String, String> additionalHeaders) Return all your categoriesEcommerceApi.getCategoryInfo(String id) Get a category detailsEcommerceApi.getCategoryInfo(String id, Map<String, String> additionalHeaders) Get a category detailsRewardApi.getCodeCount(UUID pid, UUID cpid) Get code count Get code countGet code count Get code countBalanceApi.getContactBalances(UUID pid) Get balance list Returns balance listBalanceApi.getContactBalances(UUID pid, Map<String, String> additionalHeaders) Get balance list Returns balance listContactsApi.getContactInfo(GetContactInfoIdentifierParameter identifier, String identifierType, String startDate, String endDate) Get a contact's details There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?ContactsApi.getContactInfo(GetContactInfoIdentifierParameter identifier, String identifierType, String startDate, String endDate, Map<String, String> additionalHeaders) Get a contact's details There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?ContactsApi.getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds, String filter) Get all the contactsContactsApi.getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds, String filter, Map<String, String> additionalHeaders) Get all the contactsContactsApi.getContactsFromList(Long listId, String modifiedSince, Long limit, Long offset, String sort) Get contacts in a listContactsApi.getContactsFromList(Long listId, String modifiedSince, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Get contacts in a listContactsApi.getContactStats(GetContactInfoIdentifierParameter identifier, String startDate, String endDate) Get email campaigns' statistics for a contactContactsApi.getContactStats(GetContactInfoIdentifierParameter identifier, String startDate, String endDate, Map<String, String> additionalHeaders) Get email campaigns' statistics for a contactMasterAccountApi.getCorporateInvitedUsersList()Get the list of all admin users This endpoint allows you to list all Admin users of your Admin accountMasterAccountApi.getCorporateInvitedUsersList(Map<String, String> additionalHeaders) Get the list of all admin users This endpoint allows you to list all Admin users of your Admin accountMasterAccountApi.getCorporateUserPermission(String email) Check admin user permissions This endpoint will provide the list of admin user permissionsMasterAccountApi.getCorporateUserPermission(String email, Map<String, String> additionalHeaders) Check admin user permissions This endpoint will provide the list of admin user permissionsCouponsApi.getCouponCollection(String id) Get a coupon collection by idCouponsApi.getCouponCollection(String id, Map<String, String> additionalHeaders) Get a coupon collection by idCouponsApi.getCouponCollections(Long limit, Long offset, String sort, String sortBy) Get all your coupon collectionsCouponsApi.getCouponCollections(Long limit, Long offset, String sort, String sortBy, Map<String, String> additionalHeaders) Get all your coupon collectionsDomainsApi.getDomainConfiguration(String domainName) Validate domain configurationDomainsApi.getDomainConfiguration(String domainName, Map<String, String> additionalHeaders) Validate domain configurationDomainsApi.getDomains()Get the list of all your domainsDomainsApi.getDomains(Map<String, String> additionalHeaders) Get the list of all your domainsEmailCampaignsApi.getEmailCampaign(Long campaignId, String statistics) Get an email campaign reportEmailCampaignsApi.getEmailCampaign(Long campaignId, String statistics, Map<String, String> additionalHeaders) Get an email campaign reportEmailCampaignsApi.getEmailCampaigns(String type, String status, String statistics, String startDate, String endDate, Long limit, Long offset, String sort, Boolean excludeHtmlContent) Return all your created email campaignsEmailCampaignsApi.getEmailCampaigns(String type, String status, String statistics, String startDate, String endDate, Long limit, Long offset, String sort, Boolean excludeHtmlContent, Map<String, String> additionalHeaders) Return all your created email campaignsTransactionalEmailsApi.getEmailEventReport(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort) Get all your transactional email activity (unaggregated events) This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed.TransactionalEmailsApi.getEmailEventReport(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort, Map<String, String> additionalHeaders) Get all your transactional email activity (unaggregated events) This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed.ExternalFeedsApi.getExternalFeedByUUID(String uuid) Get an external feed by UUID This endpoint will update an external feed.ExternalFeedsApi.getExternalFeedByUUID(String uuid, Map<String, String> additionalHeaders) Get an external feed by UUID This endpoint will update an external feed.Returns a folder's detailsReturns a folder's detailsContactsApi.getFolderLists(Long folderId, Long limit, Long offset, String sort) Get lists in a folderContactsApi.getFolderLists(Long folderId, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Get lists in a folderContactsApi.getFolders(Long limit, Long offset, String sort) Get all foldersGet all foldersInboundParsingApi.getInboundEmailAttachment(String downloadToken) Retrieve inbound attachment with download token.InboundParsingApi.getInboundEmailAttachment(String downloadToken, Map<String, String> additionalHeaders) Retrieve inbound attachment with download token.InboundParsingApi.getInboundEmailEvents(String sender, String startDate, String endDate, Long limit, Long offset, String sort) Get the list of all the events for the received emails.InboundParsingApi.getInboundEmailEvents(String sender, String startDate, String endDate, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Get the list of all the events for the received emails.InboundParsingApi.getInboundEmailEventsByUuid(String uuid) Fetch all events history for one particular received email.InboundParsingApi.getInboundEmailEventsByUuid(String uuid, Map<String, String> additionalHeaders) Fetch all events history for one particular received email.UserApi.getInvitedUsersList()Get the list of all your usersUserApi.getInvitedUsersList(Map<String, String> additionalHeaders) Get the list of all your usersSendersApi.getIps()Get all the dedicated IPs for your accountGet all the dedicated IPs for your accountSendersApi.getIpsFromSender(Long senderId) Get all the dedicated IPs for a senderSendersApi.getIpsFromSender(Long senderId, Map<String, String> additionalHeaders) Get all the dedicated IPs for a senderGet a list's detailsContactsApi.getList(Long listId, String startDate, String endDate, Map<String, String> additionalHeaders) Get a list's detailsTierApi.getListOfTierGroups(UUID pid, String version) List tier groups Returns the list of tier groups defined within the loyalty program.List tier groups Returns the list of tier groups defined within the loyalty program.Get all the listsGet all the listsProgramApi.getLoyaltyProgramInfo(UUID pid) Get loyalty program Info Returns loyalty programProgramApi.getLoyaltyProgramInfo(UUID pid, Map<String, String> additionalHeaders) Get loyalty program Info Returns loyalty programTierApi.getLoyaltyProgramTier(UUID pid, String version) List tiers Returns the list of tiers defined within the loyalty program.List tiers Returns the list of tiers defined within the loyalty program.Get loyalty program list Returns list of loyalty programsProgramApi.getLPList(Integer limit, Integer offset, String sortField, String sort, Map<String, String> additionalHeaders) Get loyalty program list Returns list of loyalty programsvoidEcommerceApi.getOrders(Long limit, Long offset, String sort, String modifiedSince, String createdSince) Get order details Get all the ordersvoidEcommerceApi.getOrders(Long limit, Long offset, String sort, String modifiedSince, String createdSince, Map<String, String> additionalHeaders) Get order details Get all the ordersProgramApi.getParameterSubscriptionInfo(UUID pid, String contactId, String params, String loyaltySubscriptionId) Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscriptionProgramApi.getParameterSubscriptionInfo(UUID pid, String contactId, String params, String loyaltySubscriptionId, Map<String, String> additionalHeaders) Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscriptionPaymentsApi.getPaymentRequest(String id) Get payment request detailsPaymentsApi.getPaymentRequest(String id, Map<String, String> additionalHeaders) Get payment request detailsProcessApi.getProcess(Long processId) Return the informations for a processProcessApi.getProcess(Long processId, Map<String, String> additionalHeaders) Return the informations for a processProcessApi.getProcesses(Long limit, Long offset, String sort) Return all the processes for your accountReturn all the processes for your accountEcommerceApi.getProductInfo(String id) Get a product's detailsEcommerceApi.getProductInfo(String id, Map<String, String> additionalHeaders) Get a product's detailsEcommerceApi.getProducts(Long limit, Long offset, String sort, List<String> ids, String name, BigDecimal priceLte, BigDecimal priceGte, BigDecimal priceLt, BigDecimal priceGt, BigDecimal priceEq, BigDecimal priceNe, List<String> categories, String modifiedSince, String createdSince) Return all your productsEcommerceApi.getProducts(Long limit, Long offset, String sort, List<String> ids, String name, BigDecimal priceLte, BigDecimal priceGte, BigDecimal priceLt, BigDecimal priceGt, BigDecimal priceEq, BigDecimal priceNe, List<String> categories, String modifiedSince, String createdSince, Map<String, String> additionalHeaders) Return all your productsCustomObjectsApi.getrecords(String objectType, Long limit, Long pageNum, String sort, String association) Get the list of object records and total records count for an object.CustomObjectsApi.getrecords(String objectType, Long limit, Long pageNum, String sort, String association, Map<String, String> additionalHeaders) Get the list of object records and total records count for an object.TransactionalEmailsApi.getScheduledEmailById(String identifier, LocalDate startDate, LocalDate endDate, String sort, String status, Long limit, Long offset) Fetch scheduled emails by batchId or messageId Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)TransactionalEmailsApi.getScheduledEmailById(String identifier, LocalDate startDate, LocalDate endDate, String sort, String status, Long limit, Long offset, Map<String, String> additionalHeaders) Fetch scheduled emails by batchId or messageId Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)ContactsApi.getSegments(Long limit, Long offset, String sort) Get all the segmentsGet all the segmentsSendersApi.getSenders(String ip, String domain) Get the list of all your sendersGet the list of all your sendersEmailCampaignsApi.getSharedTemplateUrl(Long campaignId) Get a shared template url Get a unique URL to share & import an email template from one Brevo account to another.EmailCampaignsApi.getSharedTemplateUrl(Long campaignId, Map<String, String> additionalHeaders) Get a shared template url Get a unique URL to share & import an email template from one Brevo account to another.SmsCampaignsApi.getSmsCampaign(Long campaignId) Get an SMS campaignSmsCampaignsApi.getSmsCampaign(Long campaignId, Map<String, String> additionalHeaders) Get an SMS campaignSmsCampaignsApi.getSmsCampaigns(String status, String startDate, String endDate, Long limit, Long offset, String sort) Returns the information for all your created SMS campaignsSmsCampaignsApi.getSmsCampaigns(String status, String startDate, String endDate, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Returns the information for all your created SMS campaignsTransactionalSmsApi.getSmsEvents(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort) Get all your SMS activity (unaggregated events)TransactionalSmsApi.getSmsEvents(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort, Map<String, String> additionalHeaders) Get all your SMS activity (unaggregated events)TransactionalEmailsApi.getSmtpReport(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort) Get your transactional email activity aggregated per dayTransactionalEmailsApi.getSmtpReport(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort, Map<String, String> additionalHeaders) Get your transactional email activity aggregated per dayTransactionalEmailsApi.getSmtpTemplate(Long templateId) Returns the template informationTransactionalEmailsApi.getSmtpTemplate(Long templateId, Map<String, String> additionalHeaders) Returns the template informationTransactionalEmailsApi.getSmtpTemplates(Boolean templateStatus, Long limit, Long offset, String sort) Get the list of email templatesTransactionalEmailsApi.getSmtpTemplates(Boolean templateStatus, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Get the list of email templatesMasterAccountApi.getSubAccountGroups()Get the list of groups This endpoint allows you to list all groups created on your Admin account.MasterAccountApi.getSubAccountGroups(Map<String, String> additionalHeaders) Get the list of groups This endpoint allows you to list all groups created on your Admin account.BalanceApi.getSubscriptionBalances(Integer cid, UUID pid) Get subscription balances Returns subscription balancesGet subscription balances Returns subscription balancesTierApi.getTierGroup(UUID pid, UUID gid, String version) Get tier group Returns tier group information.Get tier group Returns tier group information.TransactionalSmsApi.getTransacAggregatedSmsReport(String startDate, String endDate, Long days, String tag) Get your SMS activity aggregated over a period of timeTransactionalSmsApi.getTransacAggregatedSmsReport(String startDate, String endDate, Long days, String tag, Map<String, String> additionalHeaders) Get your SMS activity aggregated over a period of timeTransactionalEmailsApi.getTransacBlockedContacts(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort) Get the list of blocked or unsubscribed transactional contactsTransactionalEmailsApi.getTransacBlockedContacts(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort, Map<String, String> additionalHeaders) Get the list of blocked or unsubscribed transactional contactsTransactionalEmailsApi.getTransacEmailContent(String uuid) Get the personalized content of a sent transactional emailTransactionalEmailsApi.getTransacEmailContent(String uuid, Map<String, String> additionalHeaders) Get the personalized content of a sent transactional emailTransactionalEmailsApi.getTransacEmailsList(String email, Long templateId, String messageId, String startDate, String endDate, String sort, Long limit, Long offset) Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default.TransactionalEmailsApi.getTransacEmailsList(String email, Long templateId, String messageId, String startDate, String endDate, String sort, Long limit, Long offset, Map<String, String> additionalHeaders) Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default.TransactionalSmsApi.getTransacSmsReport(String startDate, String endDate, Long days, String tag, String sort) Get your SMS activity aggregated per dayTransactionalSmsApi.getTransacSmsReport(String startDate, String endDate, Long days, String tag, String sort, Map<String, String> additionalHeaders) Get your SMS activity aggregated per dayUserApi.getUserPermission(String email) Check user permissionUserApi.getUserPermission(String email, Map<String, String> additionalHeaders) Check user permissionWebhooksApi.getWebhook(Long webhookId) Get a webhook detailsWebhooksApi.getWebhook(Long webhookId, Map<String, String> additionalHeaders) Get a webhook detailsWebhooksApi.getWebhooks(String type, String sort) Get all webhooksGet all webhooksWhatsAppCampaignsApi.getWhatsAppCampaign(Long campaignId) Get a WhatsApp campaignWhatsAppCampaignsApi.getWhatsAppCampaign(Long campaignId, Map<String, String> additionalHeaders) Get a WhatsApp campaignWhatsAppCampaignsApi.getWhatsAppCampaigns(String startDate, String endDate, Long limit, Long offset, String sort) Return all your created WhatsApp campaignsWhatsAppCampaignsApi.getWhatsAppCampaigns(String startDate, String endDate, Long limit, Long offset, String sort, Map<String, String> additionalHeaders) Return all your created WhatsApp campaignsWhatsAppCampaignsApi.getWhatsAppConfig()Get your WhatsApp API account informationWhatsAppCampaignsApi.getWhatsAppConfig(Map<String, String> additionalHeaders) Get your WhatsApp API account informationTransactionalWhatsAppApi.getWhatsappEventReport(Long limit, Long offset, String startDate, String endDate, Long days, String contactNumber, String event, String sort) Get all your WhatsApp activity (unaggregated events) This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed.TransactionalWhatsAppApi.getWhatsappEventReport(Long limit, Long offset, String startDate, String endDate, Long days, String contactNumber, String event, String sort, Map<String, String> additionalHeaders) Get all your WhatsApp activity (unaggregated events) This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed.WhatsAppCampaignsApi.getWhatsAppTemplates(String startDate, String endDate, Long limit, Long offset, String sort, String source) Return all your created WhatsApp templatesWhatsAppCampaignsApi.getWhatsAppTemplates(String startDate, String endDate, Long limit, Long offset, String sort, String source, Map<String, String> additionalHeaders) Return all your created WhatsApp templatesContactsApi.importContacts(RequestContactImport requestContactImport) Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.ContactsApi.importContacts(RequestContactImport requestContactImport, Map<String, String> additionalHeaders) Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.MasterAccountApi.inviteAdminUser(InviteAdminUser inviteAdminUser) Send invitation to an admin user `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" - `sub_organization_groups` - \"create\" - \"edit_delete\" - `create_sub_organizations` - \"all\" - `manage_sub_organizations` - \"all\" - `analytics` - \"download_data\" - \"create_alerts\" - \"my_looks\" - \"explore_create\" - `security` - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.MasterAccountApi.inviteAdminUser(InviteAdminUser inviteAdminUser, Map<String, String> additionalHeaders) Send invitation to an admin user `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" - `sub_organization_groups` - \"create\" - \"edit_delete\" - `create_sub_organizations` - \"all\" - `manage_sub_organizations` - \"all\" - `analytics` - \"download_data\" - \"create_alerts\" - \"my_looks\" - \"explore_create\" - `security` - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.UserApi.inviteuser(Inviteuser inviteuser) Send invitation to user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo.UserApi.inviteuser(Inviteuser inviteuser, Map<String, String> additionalHeaders) Send invitation to user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo.<T> TAccountApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TBalanceApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TCompaniesApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TContactsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TConversationsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TCouponsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TCustomObjectsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TDealsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TDomainsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TEcommerceApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TEmailCampaignsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TEventApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TExternalFeedsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TFilesApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TInboundParsingApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TMasterAccountApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TNotesApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TPaymentsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TProcessApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TProgramApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TRewardApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TSendersApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TSmsCampaignsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TTasksApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TTierApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TTransactionalEmailsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TTransactionalSmsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TTransactionalWhatsAppApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TUserApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TWebhooksApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TWhatsAppCampaignsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) BalanceApi.loyaltyBalanceProgramsPidActiveBalanceGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort) Get Active Balances API Returns Active BalancesBalanceApi.loyaltyBalanceProgramsPidActiveBalanceGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, Map<String, String> additionalHeaders) Get Active Balances API Returns Active BalancesBalanceApi.loyaltyBalanceProgramsPidBalanceDefinitionsPost(UUID pid, CreateBalanceDefinitionPayload createBalanceDefinitionPayload) Create balance definition Creates balance definition and returns informationBalanceApi.loyaltyBalanceProgramsPidBalanceDefinitionsPost(UUID pid, CreateBalanceDefinitionPayload createBalanceDefinitionPayload, Map<String, String> additionalHeaders) Create balance definition Creates balance definition and returns informationBalanceApi.loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(UUID pid, UUID cid, CreateBalancePayload createBalancePayload) Create subscription balances Creates a balance for a contactBalanceApi.loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(UUID pid, UUID cid, CreateBalancePayload createBalancePayload, Map<String, String> additionalHeaders) Create subscription balances Creates a balance for a contactBalanceApi.loyaltyBalanceProgramsPidTransactionHistoryGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, List<String> filters) Get Transaction History API Returns transaction historyBalanceApi.loyaltyBalanceProgramsPidTransactionHistoryGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, List<String> filters, Map<String, String> additionalHeaders) Get Transaction History API Returns transaction historyRewardApi.loyaltyOfferProgramsPidOffersGet(UUID pid, Integer limit, Integer offset, String state, String version) Get Reward Page API Returns a reward pageRewardApi.loyaltyOfferProgramsPidOffersGet(UUID pid, Integer limit, Integer offset, String state, String version, Map<String, String> additionalHeaders) Get Reward Page API Returns a reward pageRewardApi.loyaltyOfferProgramsPidRewardsRidGet(UUID pid, UUID rid, String version) Get reward information Returns reward information.RewardApi.loyaltyOfferProgramsPidRewardsRidGet(UUID pid, UUID rid, String version, Map<String, String> additionalHeaders) Get reward information Returns reward information.RewardApi.loyaltyOfferProgramsPidVouchersGet(UUID pid, Integer contactId, Integer limit, Integer offset, String sort, String sortField, String metadataKeyValue, String rewardId) Get voucher for a contact Get voucher for a contactRewardApi.loyaltyOfferProgramsPidVouchersGet(UUID pid, Integer contactId, Integer limit, Integer offset, String sort, String sortField, String metadataKeyValue, String rewardId, Map<String, String> additionalHeaders) Get voucher for a contact Get voucher for a contactProgramApi.partiallyUpdateLoyaltyProgram(UUID pid, PatchLoyaltyProgramPayload patchLoyaltyProgramPayload) Partially update loyalty program Partially updates loyalty programProgramApi.partiallyUpdateLoyaltyProgram(UUID pid, PatchLoyaltyProgramPayload patchLoyaltyProgramPayload, Map<String, String> additionalHeaders) Partially update loyalty program Partially updates loyalty programvoidProgramApi.publishLoyaltyProgram(UUID pid) Publish loyalty program Publishes loyalty programvoidProgramApi.publishLoyaltyProgram(UUID pid, Map<String, String> additionalHeaders) Publish loyalty program Publishes loyalty programUserApi.putresendcancelinvitation(String action, String email) Resend / Cancel invitationUserApi.putresendcancelinvitation(String action, String email, Map<String, String> additionalHeaders) Resend / Cancel invitationUserApi.putRevokeUserPermission(String email) Revoke user permissionUserApi.putRevokeUserPermission(String email, Map<String, String> additionalHeaders) Revoke user permissionRewardApi.redeemVoucher(UUID pid, MainCreateRedeemPayload mainCreateRedeemPayload) Create redeem voucher request Creates a request to redeem a voucher.RewardApi.redeemVoucher(UUID pid, MainCreateRedeemPayload mainCreateRedeemPayload, Map<String, String> additionalHeaders) Create redeem voucher request Creates a request to redeem a voucher.ContactsApi.removeContactFromList(Long listId, RemoveContactFromListRequest contactEmails) Delete a contact from a listContactsApi.removeContactFromList(Long listId, RemoveContactFromListRequest contactEmails, Map<String, String> additionalHeaders) Delete a contact from a listContactsApi.requestContactExport(RequestContactExport requestContactExport) Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.ContactsApi.requestContactExport(RequestContactExport requestContactExport, Map<String, String> additionalHeaders) Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.SmsCampaignsApi.requestSmsRecipientExport(Long campaignId, RequestSmsRecipientExport recipientExport) Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.SmsCampaignsApi.requestSmsRecipientExport(Long campaignId, RequestSmsRecipientExport recipientExport, Map<String, String> additionalHeaders) Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.voidRewardApi.revokeVouchers(UUID pid, String attributedRewardIds) Revoke vouchers Revoke attributed vouchers.voidRewardApi.revokeVouchers(UUID pid, String attributedRewardIds, Map<String, String> additionalHeaders) Revoke vouchers Revoke attributed vouchers.TransactionalSmsApi.sendAsyncTransactionalSms(SendTransacSms sendTransacSms) Send SMS message asynchronously to a mobile numberTransactionalSmsApi.sendAsyncTransactionalSms(SendTransacSms sendTransacSms, Map<String, String> additionalHeaders) Send SMS message asynchronously to a mobile numbervoidEmailCampaignsApi.sendEmailCampaignNow(Long campaignId) Send an email campaign immediately, based on campaignIdvoidEmailCampaignsApi.sendEmailCampaignNow(Long campaignId, Map<String, String> additionalHeaders) Send an email campaign immediately, based on campaignIdvoidEmailCampaignsApi.sendReport(Long campaignId, SendReport sendReport) Send the report of a campaign A PDF will be sent to the specified email addressesvoidEmailCampaignsApi.sendReport(Long campaignId, SendReport sendReport, Map<String, String> additionalHeaders) Send the report of a campaign A PDF will be sent to the specified email addressesvoidSmsCampaignsApi.sendSmsCampaignNow(Long campaignId) Send your SMS campaign immediatelyvoidSmsCampaignsApi.sendSmsCampaignNow(Long campaignId, Map<String, String> additionalHeaders) Send your SMS campaign immediatelyvoidSmsCampaignsApi.sendSmsReport(Long campaignId, SendReport sendReport) Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.voidSmsCampaignsApi.sendSmsReport(Long campaignId, SendReport sendReport, Map<String, String> additionalHeaders) Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.voidEmailCampaignsApi.sendTestEmail(Long campaignId, SendTestEmail sendTestEmail) Send an email campaign to your test listvoidEmailCampaignsApi.sendTestEmail(Long campaignId, SendTestEmail sendTestEmail, Map<String, String> additionalHeaders) Send an email campaign to your test listvoidSmsCampaignsApi.sendTestSms(Long campaignId, SendTestSms sendTestSms) Send a test SMS campaignvoidSmsCampaignsApi.sendTestSms(Long campaignId, SendTestSms sendTestSms, Map<String, String> additionalHeaders) Send a test SMS campaignvoidTransactionalEmailsApi.sendTestTemplate(Long templateId, SendTestEmail sendTestEmail) Send a template to your test listvoidTransactionalEmailsApi.sendTestTemplate(Long templateId, SendTestEmail sendTestEmail, Map<String, String> additionalHeaders) Send a template to your test listTransactionalEmailsApi.sendTransacEmail(SendSmtpEmail sendSmtpEmail) Send a transactional emailTransactionalEmailsApi.sendTransacEmail(SendSmtpEmail sendSmtpEmail, Map<String, String> additionalHeaders) Send a transactional emailTransactionalSmsApi.sendTransacSms(SendTransacSms sendTransacSms) Send SMS message to a mobile numberTransactionalSmsApi.sendTransacSms(SendTransacSms sendTransacSms, Map<String, String> additionalHeaders) Send SMS message to a mobile numberTransactionalWhatsAppApi.sendWhatsappMessage(SendWhatsappMessageRequest sendWhatsappMessageRequest) Send a WhatsApp message This endpoint is used to send a WhatsApp message.TransactionalWhatsAppApi.sendWhatsappMessage(SendWhatsappMessageRequest sendWhatsappMessageRequest, Map<String, String> additionalHeaders) Send a WhatsApp message This endpoint is used to send a WhatsApp message.voidWhatsAppCampaignsApi.sendWhatsAppTemplateApproval(Long templateId) Send your WhatsApp template for approvalvoidWhatsAppCampaignsApi.sendWhatsAppTemplateApproval(Long templateId, Map<String, String> additionalHeaders) Send your WhatsApp template for approvalEcommerceApi.setConfigDisplayCurrency(EcommerceConfigDisplayCurrencyGet200Response ecommerceConfigDisplayCurrencyGet200Response) Set the ISO 4217 compliant display currency code for your Brevo accountEcommerceApi.setConfigDisplayCurrency(EcommerceConfigDisplayCurrencyGet200Response ecommerceConfigDisplayCurrencyGet200Response, Map<String, String> additionalHeaders) Set the ISO 4217 compliant display currency code for your Brevo accountvoidTransactionalEmailsApi.smtpBlockedContactsEmailDelete(String email) Unblock or resubscribe a transactional contactvoidTransactionalEmailsApi.smtpBlockedContactsEmailDelete(String email, Map<String, String> additionalHeaders) Unblock or resubscribe a transactional contactvoidTransactionalEmailsApi.smtpLogIdentifierDelete(String identifier) Delete an SMTP transactional logvoidTransactionalEmailsApi.smtpLogIdentifierDelete(String identifier, Map<String, String> additionalHeaders) Delete an SMTP transactional logProgramApi.subscribeMemberToASubscription(UUID pid, AddSubscriptionMemberPayload addSubscriptionMemberPayload) Create subscription member Add member to a subscriptionProgramApi.subscribeMemberToASubscription(UUID pid, AddSubscriptionMemberPayload addSubscriptionMemberPayload, Map<String, String> additionalHeaders) Create subscription member Add member to a subscriptionProgramApi.subscribeToLoyaltyProgram(UUID pid, CreateSubscriptionPayload createSubscriptionPayload) Create subscription Subscribes to a loyalty programProgramApi.subscribeToLoyaltyProgram(UUID pid, CreateSubscriptionPayload createSubscriptionPayload, Map<String, String> additionalHeaders) Create subscription Subscribes to a loyalty programTransactionalEmailsApi.templatePreview(TemplatePreviewRequestBody templatePreviewRequestBody) Generate the rendered preview of transactional templateTransactionalEmailsApi.templatePreview(TemplatePreviewRequestBody templatePreviewRequestBody, Map<String, String> additionalHeaders) Generate the rendered preview of transactional templatevoidContactsApi.updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute) Update contact attributevoidContactsApi.updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, Map<String, String> additionalHeaders) Update contact attributeBalanceApi.updateBalanceDefinition(UUID pid, UUID bdid, UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload) Update balance definition Updates Balance definitionBalanceApi.updateBalanceDefinition(UUID pid, UUID bdid, UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload, Map<String, String> additionalHeaders) Update balance definition Updates Balance definitionBalanceApi.updateBalanceLimit(UUID pid, UUID bdid, UUID blid, UpdateBalanceLimitPayload updateBalanceLimitPayload) Updates balance limit Updates balance limitBalanceApi.updateBalanceLimit(UUID pid, UUID bdid, UUID blid, UpdateBalanceLimitPayload updateBalanceLimitPayload, Map<String, String> additionalHeaders) Updates balance limit Updates balance limitvoidContactsApi.updateBatchContacts(UpdateBatchContacts updateBatchContacts) Update multiple contactsvoidContactsApi.updateBatchContacts(UpdateBatchContacts updateBatchContacts, Map<String, String> additionalHeaders) Update multiple contactsvoidEmailCampaignsApi.updateCampaignStatus(Long campaignId, UpdateCampaignStatus updateCampaignStatus) Update an email campaign statusvoidEmailCampaignsApi.updateCampaignStatus(Long campaignId, UpdateCampaignStatus updateCampaignStatus, Map<String, String> additionalHeaders) Update an email campaign statusvoidContactsApi.updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact, String identifierType) Update a contact There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?voidContactsApi.updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact, String identifierType, Map<String, String> additionalHeaders) Update a contact There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?CouponsApi.updateCouponCollection(String id, UpdateCouponCollectionRequest updateCouponCollectionRequest) Update a coupon collection by idCouponsApi.updateCouponCollection(String id, UpdateCouponCollectionRequest updateCouponCollectionRequest, Map<String, String> additionalHeaders) Update a coupon collection by idvoidEmailCampaignsApi.updateEmailCampaign(Long campaignId, UpdateEmailCampaign updateEmailCampaign) Update an email campaignvoidEmailCampaignsApi.updateEmailCampaign(Long campaignId, UpdateEmailCampaign updateEmailCampaign, Map<String, String> additionalHeaders) Update an email campaignvoidExternalFeedsApi.updateExternalFeed(String uuid, UpdateExternalFeed updateExternalFeed) Update an external feed This endpoint will update an external feed.voidExternalFeedsApi.updateExternalFeed(String uuid, UpdateExternalFeed updateExternalFeed, Map<String, String> additionalHeaders) Update an external feed This endpoint will update an external feed.voidContactsApi.updateFolder(Long folderId, CreateUpdateFolder updateFolder) Update a foldervoidContactsApi.updateFolder(Long folderId, CreateUpdateFolder updateFolder, Map<String, String> additionalHeaders) Update a foldervoidContactsApi.updateList(Long listId, UpdateList updateList) Update a listvoidContactsApi.updateList(Long listId, UpdateList updateList, Map<String, String> additionalHeaders) Update a listProgramApi.updateLoyaltyProgram(UUID pid, UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload) Update loyalty program Updates loyalty programProgramApi.updateLoyaltyProgram(UUID pid, UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload, Map<String, String> additionalHeaders) Update loyalty program Updates loyalty programvoidSendersApi.updateSender(Long senderId, UpdateSender sender) Update a sendervoidSendersApi.updateSender(Long senderId, UpdateSender sender, Map<String, String> additionalHeaders) Update a sendervoidSmsCampaignsApi.updateSmsCampaign(Long campaignId, UpdateSmsCampaign updateSmsCampaign) Update an SMS campaignvoidSmsCampaignsApi.updateSmsCampaign(Long campaignId, UpdateSmsCampaign updateSmsCampaign, Map<String, String> additionalHeaders) Update an SMS campaignvoidSmsCampaignsApi.updateSmsCampaignStatus(Long campaignId, UpdateCampaignStatus status) Update a campaign's statusvoidSmsCampaignsApi.updateSmsCampaignStatus(Long campaignId, UpdateCampaignStatus status, Map<String, String> additionalHeaders) Update a campaign's statusvoidTransactionalEmailsApi.updateSmtpTemplate(Long templateId, UpdateSmtpTemplate updateSmtpTemplate) Update an email templatevoidTransactionalEmailsApi.updateSmtpTemplate(Long templateId, UpdateSmtpTemplate updateSmtpTemplate, Map<String, String> additionalHeaders) Update an email templateTierApi.updateTier(UUID pid, UUID tid, TierRequestPutPayload tierRequestPutPayload) Update tier Modifies an existing tier for the specified tier group *(The changes will take effect with the next publication of the loyalty program)*TierApi.updateTier(UUID pid, UUID tid, TierRequestPutPayload tierRequestPutPayload, Map<String, String> additionalHeaders) Update tier Modifies an existing tier for the specified tier group *(The changes will take effect with the next publication of the loyalty program)*TierApi.updateTierGroup(UUID pid, UUID gid, UpdateTierGroupRequest updateTierGroupRequest) Update tier group Updates a tier group from a loyalty program.TierApi.updateTierGroup(UUID pid, UUID gid, UpdateTierGroupRequest updateTierGroupRequest, Map<String, String> additionalHeaders) Update tier group Updates a tier group from a loyalty program.voidWebhooksApi.updateWebhook(Long webhookId, UpdateWebhook updateWebhook) Update a webhookvoidWebhooksApi.updateWebhook(Long webhookId, UpdateWebhook updateWebhook, Map<String, String> additionalHeaders) Update a webhookvoidWhatsAppCampaignsApi.updateWhatsAppCampaign(Long campaignId, UpdateWhatsAppCampaign updateWhatsAppCampaign) Update a WhatsApp campaignvoidWhatsAppCampaignsApi.updateWhatsAppCampaign(Long campaignId, UpdateWhatsAppCampaign updateWhatsAppCampaign, Map<String, String> additionalHeaders) Update a WhatsApp campaignEmailCampaignsApi.uploadImageToGallery(UploadImageToGallery uploadImageToGallery) Upload an image to your account's image galleryEmailCampaignsApi.uploadImageToGallery(UploadImageToGallery uploadImageToGallery, Map<String, String> additionalHeaders) Upload an image to your account's image galleryCustomObjectsApi.upsertrecords(String objectType, UpsertrecordsRequest upsertrecordsRequest) Create/Update object records in bulk This API allows bulk upsert of object records in a single request.CustomObjectsApi.upsertrecords(String objectType, UpsertrecordsRequest upsertrecordsRequest, Map<String, String> additionalHeaders) Create/Update object records in bulk This API allows bulk upsert of object records in a single request.RewardApi.validateReward(UUID pid, MainValidateRewardPayload mainValidateRewardPayload) Validate a reward Validates a reward.RewardApi.validateReward(UUID pid, MainValidateRewardPayload mainValidateRewardPayload, Map<String, String> additionalHeaders) Validate a reward Validates a reward.voidSendersApi.validateSenderByOTP(Long senderId, Otp sender) Validate Sender using OTPvoidValidate Sender using OTP -
Uses of ApiException in software.xdev.brevo.client
Methods in software.xdev.brevo.client that throw ApiExceptionModifier and TypeMethodDescription<T> TApiClient.deserialize(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> valueType) Deserialize response body to Java object according to the Content-Type.protected org.apache.hc.core5.http.ContentTypeApiClient.getContentType(String headerValue) Parse content type object from header valueprotected StringApiClient.getResponseMimeType(org.apache.hc.core5.http.HttpResponse response) Get content type of a response or null if one was not provided<T> TApiClient.invokeAPI(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String accept, String contentType, String[] authNames, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Invoke API by sending HTTP request with the given options.voidDirectly invoke the API for the given URL.<T> TBaseApi.invokeAPI(String url, String method, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Directly invoke the API for the given URL.voidDirectly invoke the API for the given URL.<T> TBaseApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Directly invoke the API for the given URL.abstract <T> TBaseApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) Directly invoke the API for the given URL.voidDirectly invoke the API for the given URL.voidDirectly invoke the API for the given URL.protected <T> TApiClient.processResponse(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> returnType) org.apache.hc.core5.http.HttpEntityApiClient.serialize(Object obj, Map<String, Object> formParams, org.apache.hc.core5.http.ContentType contentType) Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).