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 listResellerApi.addCredits(String childIdentifier, AddCredits addCredits) Add Email and/or SMS credits to a specific child accountResellerApi.addCredits(String childIdentifier, AddCredits addCredits, Map<String, String> additionalHeaders) Add Email and/or SMS credits to a specific child accountvoidResellerApi.associateIpToChild(String childIdentifier, ManageIp ip) Associate a dedicated IP to the childvoidResellerApi.associateIpToChild(String childIdentifier, ManageIp ip, Map<String, String> additionalHeaders) Associate a dedicated IP to the childDomainsApi.authenticateDomain(String domainName) Authenticate a domainDomainsApi.authenticateDomain(String domainName, Map<String, String> additionalHeaders) Authenticate a domainvoidTransactionalEmailsApi.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 sameCompaniesApi.companiesAttributesGet()Get company attributesCompaniesApi.companiesAttributesGet(Map<String, String> additionalHeaders) Get company attributesCompaniesApi.companiesGet(String filters, Long linkedContactsIds, String linkedDealsIds, Long page, Long limit, String sort, String sortBy) Get all CompaniesCompaniesApi.companiesGet(String filters, Long linkedContactsIds, String linkedDealsIds, 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 companyvoidCompaniesApi.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 companyvoidConversationsApi.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.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.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 planvoidMasterAccountApi.corporateSubAccountIdPlanPut(Long id, SubAccountUpdatePlanRequest subAccountUpdatePlanRequest, Map<String, String> additionalHeaders) Update sub-account plan This endpoint will update the sub-account planMasterAccountApi.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.MasterAccountApi.corporateSubAccountSsoTokenPost(CorporateSubAccountSsoTokenPostRequest corporateSubAccountSsoTokenPostRequest) Generate SSO token to access Brevo 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 Brevo 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.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 attributeEcommerceApi.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 timevoidResellerApi.createChildDomain(String childIdentifier, AddChildDomain addChildDomain) Create a domain for a child accountvoidResellerApi.createChildDomain(String childIdentifier, AddChildDomain addChildDomain, Map<String, String> additionalHeaders) Create a domain for a child accountContactsApi.createContact(CreateContact createContact) Create a contactContactsApi.createContact(CreateContact createContact, Map<String, String> additionalHeaders) Create a contactCouponsApi.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 campaignExternalFeedsApi.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 listvoidEcommerceApi.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 orderResellerApi.createResellerChild(CreateChild createChild) Creates a reseller childResellerApi.createResellerChild(CreateChild createChild, Map<String, String> additionalHeaders) Creates a reseller childSendersApi.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 templateEcommerceApi.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 productWebhooksApi.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 templateDealsApi.crmAttributesDealsGet()Get deal attributesDealsApi.crmAttributesDealsGet(Map<String, String> additionalHeaders) Get deal attributesDealsApi.crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, Long offset, Long limit, String sort) Get all dealsDealsApi.crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, 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 dealvoidDealsApi.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 attributevoidTransactionalEmailsApi.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 domainsvoidResellerApi.deleteChildDomain(String childIdentifier, String domainName) Delete the sender domain of the reseller child based on the childIdentifier and domainName passedvoidResellerApi.deleteChildDomain(String childIdentifier, String domainName, Map<String, String> additionalHeaders) Delete the sender domain of the reseller child based on the childIdentifier and domainName passedvoidContactsApi.deleteContact(GetContactInfoIdentifierParameter identifier) Delete a contactvoidContactsApi.deleteContact(GetContactInfoIdentifierParameter identifier, Map<String, String> additionalHeaders) Delete a contactvoidDomainsApi.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 listvoidResellerApi.deleteResellerChild(String childIdentifier) Delete a single reseller child based on the child identifier suppliedvoidResellerApi.deleteResellerChild(String childIdentifier, Map<String, String> additionalHeaders) Delete a single reseller child based on the child identifier suppliedvoidTransactionalEmailsApi.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 templatevoidWebhooksApi.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 campaignvoidResellerApi.dissociateIpFromChild(String childIdentifier, ManageIp ip) Dissociate a dedicated IP to the childvoidResellerApi.dissociateIpFromChild(String childIdentifier, ManageIp ip, Map<String, String> additionalHeaders) Dissociate a dedicated IP to the childvoidEcommerceApi.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.UserApi.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(ExportWebhooksHistoryRequest exportWebhooksHistoryRequest) Export all webhook events This endpoint will submit a request to get the history of webhooks in the CSV file.WebhooksApi.exportWebhooksHistory(ExportWebhooksHistoryRequest exportWebhooksHistoryRequest, 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, Long limit, Long offset) Get user activity logsAccountApi.getAccountActivity(String startDate, String endDate, Long limit, Long offset, Map<String, String> additionalHeaders) Get user activity logsMasterAccountApi.getAccountActivity(String startDate, String endDate, Long limit, Long offset) Get user activity logsMasterAccountApi.getAccountActivity(String startDate, String endDate, 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 attributesTransactionalEmailsApi.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 detailsResellerApi.getChildAccountCreationStatus(String childIdentifier) Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier suppliedResellerApi.getChildAccountCreationStatus(String childIdentifier, Map<String, String> additionalHeaders) Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier suppliedResellerApi.getChildDomains(String childIdentifier) Get all sender domains for a specific child accountResellerApi.getChildDomains(String childIdentifier, Map<String, String> additionalHeaders) Get all sender domains for a specific child accountResellerApi.getChildInfo(String childIdentifier) Get a child account's detailsResellerApi.getChildInfo(String childIdentifier, Map<String, String> additionalHeaders) Get a child account's detailsContactsApi.getContactInfo(GetContactInfoIdentifierParameter identifier, String startDate, String endDate) Get a contact's details Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default.ContactsApi.getContactInfo(GetContactInfoIdentifierParameter identifier, String startDate, String endDate, Map<String, String> additionalHeaders) Get a contact's details Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default.ContactsApi.getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds) Get all the contactsContactsApi.getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds, 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 accountCouponsApi.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) Get all your coupon collectionsCouponsApi.getCouponCollections(Long limit, Long offset, String sort, 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 detailsGet all the listsGet all the listsvoidEcommerceApi.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 ordersProcessApi.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 productsResellerApi.getResellerChilds(Long limit, Long offset) Get the list of all children accountsGet the list of all children accountsTransactionalEmailsApi.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 templatesResellerApi.getSsoToken(String childIdentifier) Get session token to access Brevo (SSO) It returns a session [token] which will remain valid for a short period of time.ResellerApi.getSsoToken(String childIdentifier, Map<String, String> additionalHeaders) Get session token to access Brevo (SSO) It returns a session [token] which will remain valid for a short period of time.MasterAccountApi.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.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\" **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\" **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> 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> 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> 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> TProcessApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) <T> TResellerApi.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> 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) UserApi.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 permissionContactsApi.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 listResellerApi.removeCredits(String childIdentifier, RemoveCredits removeCredits) Remove Email and/or SMS credits from a specific child accountResellerApi.removeCredits(String childIdentifier, RemoveCredits removeCredits, Map<String, String> additionalHeaders) Remove Email and/or SMS credits from a specific child accountContactsApi.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.voidEmailCampaignsApi.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 approvalvoidTransactionalEmailsApi.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 logvoidContactsApi.updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute) Update contact attributevoidContactsApi.updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, Map<String, String> additionalHeaders) Update contact attributevoidContactsApi.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 statusvoidResellerApi.updateChildAccountStatus(String childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) Update info of reseller's child account status based on the identifier suppliedvoidResellerApi.updateChildAccountStatus(String childIdentifier, UpdateChildAccountStatus updateChildAccountStatus, Map<String, String> additionalHeaders) Update info of reseller's child account status based on the identifier suppliedvoidResellerApi.updateChildDomain(String childIdentifier, String domainName, UpdateChildDomain updateChildDomain) Update the sender domain of reseller's child based on the childIdentifier and domainName passedvoidResellerApi.updateChildDomain(String childIdentifier, String domainName, UpdateChildDomain updateChildDomain, Map<String, String> additionalHeaders) Update the sender domain of reseller's child based on the childIdentifier and domainName passedvoidContactsApi.updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact) Update a contactvoidContactsApi.updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact, Map<String, String> additionalHeaders) Update a contactCouponsApi.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 listvoidResellerApi.updateResellerChild(String childIdentifier, UpdateChild resellerChild) Update info of reseller's child based on the child identifier suppliedvoidResellerApi.updateResellerChild(String childIdentifier, UpdateChild resellerChild, Map<String, String> additionalHeaders) Update info of reseller's child based on the child identifier suppliedvoidSendersApi.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 templatevoidWebhooksApi.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 galleryvoidSendersApi.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.<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).