POST /contacts/import
It returns the background process ID which on completion calls the notify URL that you have set in the input.
Servers
- https://api.sendinblue.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fileUrl |
String | No |
Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv |
notifyUrl |
String | No |
URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 |
updateExistingContacts |
Boolean | No |
To facilitate the choice to update the existing contacts Default value: true |
emptyContactsAttributes |
Boolean | No |
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 SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if Default value: false |
smsBlacklist |
Boolean | No |
To blacklist all the contacts for sms Default value: false |
allowExport |
Boolean | No |
To enable allow export. if allow export will be true, we will save import_process_ids [12, 13, 14] in the users metadata Default value: false |
newList |
Object | No |
To create a new list and import the contacts into it, pass the listName and an optional folderId. |
newList.folderId |
Integer | No |
Id of the folder where this new list shall be created (Mandatory if listName is not empty). |
newList.listName |
String | No |
List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). |
fileBody |
String | No |
Mandatory if fileUrl 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. |
disableNotification |
Boolean | No |
To disable email notification Default value: false |
listIds[] |
Array | No |
Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. |
disableFrontendNotification |
Boolean | No |
To disable frontend notification Default value: false |
jsonBody[] |
Array | No |
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[].attributes |
Object | No |
List of attributes to be imported. Example for all attribute types parsing.
|
jsonBody[].email |
String | No | |
emailBlacklist |
Boolean | No |
To blacklist all the contacts for email Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.