Package software.xdev.brevo.api

Class ContactsApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.ContactsApi

public class ContactsApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
ContactsApi()
ContactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PostContactInfo	addContactToList(Long listId, AddContactToListRequest addContactToListRequest)	Add existing contacts to a list
PostContactInfo	addContactToList(Long listId, AddContactToListRequest addContactToListRequest, Map<String,String> additionalHeaders)	Add existing contacts to a list
void	createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute)	Create contact attribute
void	createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute, Map<String,String> additionalHeaders)	Create contact attribute
CreateUpdateContactModel	createContact(CreateContact createContact)	Create a contact
CreateUpdateContactModel	createContact(CreateContact createContact, Map<String,String> additionalHeaders)	Create a contact
void	createDoiContact(CreateDoiContact createDoiContact)	Create Contact via DOI (Double-Opt-In) Flow
void	createDoiContact(CreateDoiContact createDoiContact, Map<String,String> additionalHeaders)	Create Contact via DOI (Double-Opt-In) Flow
CreateModel	createFolder(CreateUpdateFolder createFolder)	Create a folder
CreateModel	createFolder(CreateUpdateFolder createFolder, Map<String,String> additionalHeaders)	Create a folder
CreateModel	createList(CreateList createList)	Create a list
CreateModel	createList(CreateList createList, Map<String,String> additionalHeaders)	Create a list
void	deleteAttribute(String attributeCategory, String attributeName)	Delete an attribute
void	deleteAttribute(String attributeCategory, String attributeName, Map<String,String> additionalHeaders)	Delete an attribute
void	deleteContact(GetContactInfoIdentifierParameter identifier)	Delete a contact
void	deleteContact(GetContactInfoIdentifierParameter identifier, Map<String,String> additionalHeaders)	Delete a contact
void	deleteFolder(Long folderId)	Delete a folder (and all its lists)
void	deleteFolder(Long folderId, Map<String,String> additionalHeaders)	Delete a folder (and all its lists)
void	deleteList(Long listId)	Delete a list
void	deleteList(Long listId, Map<String,String> additionalHeaders)	Delete a list
GetAttributes	getAttributes()	List all attributes
GetAttributes	getAttributes(Map<String,String> additionalHeaders)	List all attributes
GetExtendedContactDetails	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.
GetExtendedContactDetails	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.
GetContacts	getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds)	Get all the contacts
GetContacts	getContacts(Long limit, Long offset, String modifiedSince, String createdSince, String sort, Long segmentId, List<Long> listIds, Map<String,String> additionalHeaders)	Get all the contacts
GetContacts	getContactsFromList(Long listId, String modifiedSince, Long limit, Long offset, String sort)	Get contacts in a list
GetContacts	getContactsFromList(Long listId, String modifiedSince, Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get contacts in a list
GetContactCampaignStats	getContactStats(GetContactInfoIdentifierParameter identifier, String startDate, String endDate)	Get email campaigns' statistics for a contact
GetContactCampaignStats	getContactStats(GetContactInfoIdentifierParameter identifier, String startDate, String endDate, Map<String,String> additionalHeaders)	Get email campaigns' statistics for a contact
GetFolder	getFolder(Long folderId)	Returns a folder's details
GetFolder	getFolder(Long folderId, Map<String,String> additionalHeaders)	Returns a folder's details
GetFolderLists	getFolderLists(Long folderId, Long limit, Long offset, String sort)	Get lists in a folder
GetFolderLists	getFolderLists(Long folderId, Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get lists in a folder
GetFolders	getFolders(Long limit, Long offset, String sort)	Get all folders
GetFolders	getFolders(Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get all folders
GetExtendedList	getList(Long listId, String startDate, String endDate)	Get a list's details
GetExtendedList	getList(Long listId, String startDate, String endDate, Map<String,String> additionalHeaders)	Get a list's details
GetLists	getLists(Long limit, Long offset, String sort)	Get all the lists
GetLists	getLists(Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get all the lists
GetSegments	getSegments(Long limit, Long offset, String sort)	Get all the segments
GetSegments	getSegments(Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get all the segments
CreatedProcessId	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.
CreatedProcessId	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.
<T> T	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.
PostContactInfo	removeContactFromList(Long listId, RemoveContactFromListRequest contactEmails)	Delete a contact from a list
PostContactInfo	removeContactFromList(Long listId, RemoveContactFromListRequest contactEmails, Map<String,String> additionalHeaders)	Delete a contact from a list
CreatedProcessId	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.
CreatedProcessId	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.
void	updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute)	Update contact attribute
void	updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, Map<String,String> additionalHeaders)	Update contact attribute
void	updateBatchContacts(UpdateBatchContacts updateBatchContacts)	Update multiple contacts
void	updateBatchContacts(UpdateBatchContacts updateBatchContacts, Map<String,String> additionalHeaders)	Update multiple contacts
void	updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact)	Update a contact
void	updateContact(GetContactInfoIdentifierParameter identifier, UpdateContact updateContact, Map<String,String> additionalHeaders)	Update a contact
void	updateFolder(Long folderId, CreateUpdateFolder updateFolder)	Update a folder
void	updateFolder(Long folderId, CreateUpdateFolder updateFolder, Map<String,String> additionalHeaders)	Update a folder
void	updateList(Long listId, UpdateList updateList)	Update a list
void	updateList(Long listId, UpdateList updateList, Map<String,String> additionalHeaders)	Update a list

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContactsApi

public ContactsApi()

ContactsApi

public ContactsApi(ApiClient apiClient)

Method Details

addContactToList

public PostContactInfo addContactToList(Long listId,
 AddContactToListRequest addContactToListRequest)
                                 throws ApiException

Add existing contacts to a list

Parameters:

listId - Id of the list (required)

addContactToListRequest - Emails addresses OR IDs of the contacts (required)

Returns:

PostContactInfo

Throws:

ApiException - if fails to make API call

addContactToList

public PostContactInfo addContactToList(Long listId,
 AddContactToListRequest addContactToListRequest,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Add existing contacts to a list

Parameters:

listId - Id of the list (required)

addContactToListRequest - Emails addresses OR IDs of the contacts (required)

additionalHeaders - additionalHeaders for this call

Returns:

PostContactInfo

Throws:

ApiException - if fails to make API call

createAttribute

public void createAttribute(String attributeCategory,
 String attributeName,
 CreateAttribute createAttribute)
                     throws ApiException

Create contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

Throws:

ApiException - if fails to make API call

createAttribute

public void createAttribute(String attributeCategory,
 String attributeName,
 CreateAttribute createAttribute,
 Map<String,String> additionalHeaders)
                     throws ApiException

Create contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

createContact

public CreateUpdateContactModel createContact(CreateContact createContact)
                                       throws ApiException

Create a contact

Parameters:

createContact - Values to create a contact (required)

Returns:

CreateUpdateContactModel

Throws:

ApiException - if fails to make API call

createContact

public CreateUpdateContactModel createContact(CreateContact createContact,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Create a contact

Parameters:

createContact - Values to create a contact (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateUpdateContactModel

Throws:

ApiException - if fails to make API call

createDoiContact

public void createDoiContact(CreateDoiContact createDoiContact)
                      throws ApiException

Create Contact via DOI (Double-Opt-In) Flow

Parameters:

createDoiContact - Values to create the Double opt-in (DOI) contact (required)

Throws:

ApiException - if fails to make API call

createDoiContact

public void createDoiContact(CreateDoiContact createDoiContact,
 Map<String,String> additionalHeaders)
                      throws ApiException

Create Contact via DOI (Double-Opt-In) Flow

Parameters:

createDoiContact - Values to create the Double opt-in (DOI) contact (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

createFolder

public CreateModel createFolder(CreateUpdateFolder createFolder)
                         throws ApiException

Create a folder

Parameters:

createFolder - Name of the folder (required)

Returns:

CreateModel

Throws:

ApiException - if fails to make API call

createFolder

public CreateModel createFolder(CreateUpdateFolder createFolder,
 Map<String,String> additionalHeaders)
                         throws ApiException

Create a folder

Parameters:

createFolder - Name of the folder (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateModel

Throws:

ApiException - if fails to make API call

createList

public CreateModel createList(CreateList createList)
                       throws ApiException

Create a list

Parameters:

createList - Values to create a list (required)

Returns:

CreateModel

Throws:

ApiException - if fails to make API call

createList

public CreateModel createList(CreateList createList,
 Map<String,String> additionalHeaders)
                       throws ApiException

Create a list

Parameters:

createList - Values to create a list (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateModel

Throws:

ApiException - if fails to make API call

deleteAttribute

public void deleteAttribute(String attributeCategory,
 String attributeName)
                     throws ApiException

Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

Throws:

ApiException - if fails to make API call

deleteAttribute

public void deleteAttribute(String attributeCategory,
 String attributeName,
 Map<String,String> additionalHeaders)
                     throws ApiException

Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteContact

public void deleteContact(GetContactInfoIdentifierParameter identifier)
                   throws ApiException

Delete a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

Throws:

ApiException - if fails to make API call

deleteContact

public void deleteContact(GetContactInfoIdentifierParameter identifier,
 Map<String,String> additionalHeaders)
                   throws ApiException

Delete a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteFolder

public void deleteFolder(Long folderId)
                  throws ApiException

Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

Throws:

ApiException - if fails to make API call

deleteFolder

public void deleteFolder(Long folderId,
 Map<String,String> additionalHeaders)
                  throws ApiException

Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteList

public void deleteList(Long listId)
                throws ApiException

Delete a list

Parameters:

listId - Id of the list (required)

Throws:

ApiException - if fails to make API call

deleteList

public void deleteList(Long listId,
 Map<String,String> additionalHeaders)
                throws ApiException

Delete a list

Parameters:

listId - Id of the list (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getAttributes

public GetAttributes getAttributes()
                            throws ApiException

List all attributes

Returns:

GetAttributes

Throws:

ApiException - if fails to make API call

getAttributes

public GetAttributes getAttributes(Map<String,String> additionalHeaders)
                            throws ApiException

List all attributes

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

GetAttributes

Throws:

ApiException - if fails to make API call

getContactInfo

public GetExtendedContactDetails getContactInfo(GetContactInfoIdentifierParameter identifier,
 String startDate,
 String endDate)
                                         throws ApiException

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. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.

Parameters:

identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (required)

startDate - **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional)

Returns:

GetExtendedContactDetails

Throws:

ApiException - if fails to make API call

getContactInfo

public GetExtendedContactDetails getContactInfo(GetContactInfoIdentifierParameter identifier,
 String startDate,
 String endDate,
 Map<String,String> additionalHeaders)
                                         throws ApiException

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. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.

Parameters:

identifier - Email (urlencoded) OR ID of the contact OR its SMS attribute value (required)

startDate - **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetExtendedContactDetails

Throws:

ApiException - if fails to make API call

getContactStats

public GetContactCampaignStats getContactStats(GetContactInfoIdentifierParameter identifier,
 String startDate,
 String endDate)
                                        throws ApiException

Get email campaigns' statistics for a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

startDate - **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional)

Returns:

GetContactCampaignStats

Throws:

ApiException - if fails to make API call

getContactStats

public GetContactCampaignStats getContactStats(GetContactInfoIdentifierParameter identifier,
 String startDate,
 String endDate,
 Map<String,String> additionalHeaders)
                                        throws ApiException

Get email campaigns' statistics for a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

startDate - **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)

endDate - **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetContactCampaignStats

Throws:

ApiException - if fails to make API call

getContacts

public GetContacts getContacts(Long limit,
 Long offset,
 String modifiedSince,
 String createdSince,
 String sort,
 Long segmentId,
 List<Long> listIds)
                        throws ApiException

Get all the contacts

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

createdSince - Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

segmentId - Id of the segment. **Either listIds or segmentId can be passed.** (optional)

listIds - Ids of the list. **Either listIds or segmentId can be passed.** (optional)

Returns:

GetContacts

Throws:

ApiException - if fails to make API call

getContacts

public GetContacts getContacts(Long limit,
 Long offset,
 String modifiedSince,
 String createdSince,
 String sort,
 Long segmentId,
 List<Long> listIds,
 Map<String,String> additionalHeaders)
                        throws ApiException

Get all the contacts

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

createdSince - Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

segmentId - Id of the segment. **Either listIds or segmentId can be passed.** (optional)

listIds - Ids of the list. **Either listIds or segmentId can be passed.** (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetContacts

Throws:

ApiException - if fails to make API call

getContactsFromList

public GetContacts getContactsFromList(Long listId,
 String modifiedSince,
 Long limit,
 Long offset,
 String sort)
                                throws ApiException

Get contacts in a list

Parameters:

listId - Id of the list (required)

modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetContacts

Throws:

ApiException - if fails to make API call

getContactsFromList

public GetContacts getContactsFromList(Long listId,
 String modifiedSince,
 Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                                throws ApiException

Get contacts in a list

Parameters:

listId - Id of the list (required)

modifiedSince - Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

additionalHeaders - additionalHeaders for this call

Returns:

GetContacts

Throws:

ApiException - if fails to make API call

getFolder

public GetFolder getFolder(Long folderId)
                    throws ApiException

Returns a folder's details

Parameters:

folderId - id of the folder (required)

Returns:

GetFolder

Throws:

ApiException - if fails to make API call

getFolder

public GetFolder getFolder(Long folderId,
 Map<String,String> additionalHeaders)
                    throws ApiException

Returns a folder's details

Parameters:

folderId - id of the folder (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetFolder

Throws:

ApiException - if fails to make API call

getFolderLists

public GetFolderLists getFolderLists(Long folderId,
 Long limit,
 Long offset,
 String sort)
                              throws ApiException

Get lists in a folder

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetFolderLists

Throws:

ApiException - if fails to make API call

getFolderLists

public GetFolderLists getFolderLists(Long folderId,
 Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                              throws ApiException

Get lists in a folder

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

additionalHeaders - additionalHeaders for this call

Returns:

GetFolderLists

Throws:

ApiException - if fails to make API call

getFolders

public GetFolders getFolders(Long limit,
 Long offset,
 String sort)
                      throws ApiException

Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetFolders

Throws:

ApiException - if fails to make API call

getFolders

public GetFolders getFolders(Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                      throws ApiException

Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

additionalHeaders - additionalHeaders for this call

Returns:

GetFolders

Throws:

ApiException - if fails to make API call

getList

public GetExtendedList getList(Long listId,
 String startDate,
 String endDate)
                        throws ApiException

Get a list's details

Parameters:

listId - Id of the list (required)

startDate - **Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** (optional)

endDate - **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** (optional)

Returns:

GetExtendedList

Throws:

ApiException - if fails to make API call

getList

public GetExtendedList getList(Long listId,
 String startDate,
 String endDate,
 Map<String,String> additionalHeaders)
                        throws ApiException

Get a list's details

Parameters:

listId - Id of the list (required)

startDate - **Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** (optional)

endDate - **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetExtendedList

Throws:

ApiException - if fails to make API call

getLists

public GetLists getLists(Long limit,
 Long offset,
 String sort)
                  throws ApiException

Get all the lists

Parameters:

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetLists

Throws:

ApiException - if fails to make API call

getLists

public GetLists getLists(Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                  throws ApiException

Get all the lists

Parameters:

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

additionalHeaders - additionalHeaders for this call

Returns:

GetLists

Throws:

ApiException - if fails to make API call

getSegments

public GetSegments getSegments(Long limit,
 Long offset,
 String sort)
                        throws ApiException

Get all the segments

Parameters:

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetSegments

Throws:

ApiException - if fails to make API call

getSegments

public GetSegments getSegments(Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                        throws ApiException

Get all the segments

Parameters:

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

additionalHeaders - additionalHeaders for this call

Returns:

GetSegments

Throws:

ApiException - if fails to make API call

importContacts

public CreatedProcessId importContacts(RequestContactImport requestContactImport)
                                throws ApiException

Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

requestContactImport - Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)

Returns:

CreatedProcessId

Throws:

ApiException - if fails to make API call

importContacts

public CreatedProcessId importContacts(RequestContactImport requestContactImport,
 Map<String,String> additionalHeaders)
                                throws ApiException

Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

requestContactImport - Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreatedProcessId

Throws:

ApiException - if fails to make API call

removeContactFromList

public PostContactInfo removeContactFromList(Long listId,
 RemoveContactFromListRequest contactEmails)
                                      throws ApiException

Delete a contact from a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails adresses OR IDs of the contacts OR 'all' true (required)

Returns:

PostContactInfo

Throws:

ApiException - if fails to make API call

removeContactFromList

public PostContactInfo removeContactFromList(Long listId,
 RemoveContactFromListRequest contactEmails,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Delete a contact from a list

Parameters:

listId - Id of the list (required)

contactEmails - Emails adresses OR IDs of the contacts OR 'all' true (required)

additionalHeaders - additionalHeaders for this call

Returns:

PostContactInfo

Throws:

ApiException - if fails to make API call

requestContactExport

public CreatedProcessId requestContactExport(RequestContactExport requestContactExport)
                                      throws ApiException

Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Parameters:

requestContactExport - Values to request a contact export (required)

Returns:

CreatedProcessId

Throws:

ApiException - if fails to make API call

requestContactExport

public CreatedProcessId requestContactExport(RequestContactExport requestContactExport,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Parameters:

requestContactExport - Values to request a contact export (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreatedProcessId

Throws:

ApiException - if fails to make API call

updateAttribute

public void updateAttribute(String attributeCategory,
 String attributeName,
 UpdateAttribute updateAttribute)
                     throws ApiException

Update contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

Throws:

ApiException - if fails to make API call

updateAttribute

public void updateAttribute(String attributeCategory,
 String attributeName,
 UpdateAttribute updateAttribute,
 Map<String,String> additionalHeaders)
                     throws ApiException

Update contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateBatchContacts

public void updateBatchContacts(UpdateBatchContacts updateBatchContacts)
                         throws ApiException

Update multiple contacts

Parameters:

updateBatchContacts - Values to update multiple contacts (required)

Throws:

ApiException - if fails to make API call

updateBatchContacts

public void updateBatchContacts(UpdateBatchContacts updateBatchContacts,
 Map<String,String> additionalHeaders)
                         throws ApiException

Update multiple contacts

Parameters:

updateBatchContacts - Values to update multiple contacts (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateContact

public void updateContact(GetContactInfoIdentifierParameter identifier,
 UpdateContact updateContact)
                   throws ApiException

Update a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

updateContact - Values to update a contact (required)

Throws:

ApiException - if fails to make API call

updateContact

public void updateContact(GetContactInfoIdentifierParameter identifier,
 UpdateContact updateContact,
 Map<String,String> additionalHeaders)
                   throws ApiException

Update a contact

Parameters:

identifier - Email (urlencoded) OR ID of the contact (required)

updateContact - Values to update a contact (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateFolder

public void updateFolder(Long folderId,
 CreateUpdateFolder updateFolder)
                  throws ApiException

Update a folder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

Throws:

ApiException - if fails to make API call

updateFolder

public void updateFolder(Long folderId,
 CreateUpdateFolder updateFolder,
 Map<String,String> additionalHeaders)
                  throws ApiException

Update a folder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateList

public void updateList(Long listId,
 UpdateList updateList)
                throws ApiException

Update a list

Parameters:

listId - Id of the list (required)

updateList - Values to update a list (required)

Throws:

ApiException - if fails to make API call

updateList

public void updateList(Long listId,
 UpdateList updateList,
 Map<String,String> additionalHeaders)
                throws ApiException

Update a list

Parameters:

listId - Id of the list (required)

updateList - Values to update a list (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.