brevo · Schema

ImportContacts

Properties

Name	Type	Description
fileUrl	string	URL of the file to import contacts from.
fileBody	string	Inline CSV data for contact import.
listIds	array	IDs of lists to add imported contacts to.
notifyUrl	string	URL to receive notification when the import completes.
newList	object	Create a new list and add imported contacts to it.
emailBlacklist	boolean	Whether to blacklist imported contacts' email addresses.
smsBlacklist	boolean	Whether to blacklist imported contacts' phone numbers.
updateExistingContacts	boolean	Whether to update existing contacts during import.
emptyContactsAttributes	boolean	Whether to empty existing attributes not in the import file.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ImportContacts",
  "title": "ImportContacts",
  "type": "object",
  "properties": {
    "fileUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the file to import contacts from."
    },
    "fileBody": {
      "type": "string",
      "description": "Inline CSV data for contact import."
    },
    "listIds": {
      "type": "array",
      "description": "IDs of lists to add imported contacts to.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "notifyUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL to receive notification when the import completes."
    },
    "newList": {
      "type": "object",
      "description": "Create a new list and add imported contacts to it.",
      "properties": {
        "listName": {
          "type": "string",
          "description": "Name of the new list."
        },
        "folderId": {
          "type": "integer",
          "format": "int64",
          "description": "Folder ID for the new list."
        }
      }
    },
    "emailBlacklist": {
      "type": "boolean",
      "description": "Whether to blacklist imported contacts' email addresses."
    },
    "smsBlacklist": {
      "type": "boolean",
      "description": "Whether to blacklist imported contacts' phone numbers."
    },
    "updateExistingContacts": {
      "type": "boolean",
      "description": "Whether to update existing contacts during import."
    },
    "emptyContactsAttributes": {
      "type": "boolean",
      "description": "Whether to empty existing attributes not in the import file."
    }
  }
}