contacts

Import contacts

It returns the background process ID which on completion calls the notify URL that you have set in the input. Note: - Any contact attribute that doesn't exist in your account will be ignored at import end.

post/contacts/import

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/import
  • Auth: API key in header api-key

Request body

disableNotificationboolean

To disable email notification

emailBlacklistboolean

To blacklist all the contacts for email

emptyContactsAttributesboolean

To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( **only available if updateExistingContacts set to true **)

fileBodystring

Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.

fileUrlstring url

Mandatory if fileBody and jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: #### .txt, .csv, .json

listIdsinteger[]

Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].

consentGroupIdsinteger[]

Optional. Ids of the consent groups to which all imported contacts will be added. Requires consent groups to be enabled for the organisation. For example, [1, 3].

notifyUrlstring url

URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

smsBlacklistboolean

To blacklist all the contacts for sms

updateExistingContactsboolean

To facilitate the choice to update the existing contacts

Response

process id created

processIdinteger required

Id of the process created

Changes

No recorded changes to this operation across all 1 revision of this API.