API Reference

Import contacts

post
https://api.brevo.com/v3/contacts/import

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample for fileBody:

EMAILLASTNAMEFIRSTNAMESMS
[email protected]SmithJohn3123456793
harry6#@example.comEdmundHarry3111222226
how#ard6#@example.comSternHoward3777888902
[email protected]JaneDoe2344556681
Body Params

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

boolean
Defaults to false

To disable email notification

boolean
Defaults to false

To blacklist all the contacts for email

boolean
Defaults to false

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 )

string

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.

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

jsonBody
array of objects

Mandatory if fileUrl and fileBody is not defined. JSON content to be imported. Maximum allowed json body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files.

jsonBody
listIds
array of int64s

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

listIds
newList
object

To create a new list and import the contacts into it, pass the listName and an optional folderId.

url

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

boolean
Defaults to false

To blacklist all the contacts for sms

boolean
Defaults to true

To facilitate the choice to update the existing contacts

Responses

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago