Import BrevoContact - tsubotitsch/Brevo GitHub Wiki

Import-BrevoContact

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

Uri

Import-BrevoContact -fileUrl <String> -ListIds <Int32[]> [-notifyUrl <Object>] [-newList <Object>]
 [-emailBlacklist <Boolean>] [-smsBlacklist <Boolean>] [-updateExistingContacts <Boolean>]
 [-emptyContactsAttributes <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

File

Import-BrevoContact -fileBody <String> -ListIds <Int32[]> [-notifyUrl <Object>] [-newList <Object>]
 [-emailBlacklist <Boolean>] [-smsBlacklist <Boolean>] [-updateExistingContacts <Boolean>]
 [-emptyContactsAttributes <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Json

Import-BrevoContact -jsonBody <Object> -ListIds <Int32[]> [-notifyUrl <Object>] [-newList <Object>]
 [-emailBlacklist <Boolean>] [-smsBlacklist <Boolean>] [-updateExistingContacts <Boolean>]
 [-emptyContactsAttributes <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-emailBlacklist

To blacklist all the contacts for email, set this field to true.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-emptyContactsAttributes

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 )

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-fileBody

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.

Type: String
Parameter Sets: File
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-fileUrl

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

Type: String
Parameter Sets: Uri
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-jsonBody

Mandatory if fileUrl and fileBody is not defined. JSON content to be imported. 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.

Type: Object
Parameter Sets: Json
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ListIds

The IDs of the lists to which the contacts are added

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-newList

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

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-notifyUrl

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

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-smsBlacklist

To blacklist all the contacts for SMS, set this field to true.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-updateExistingContacts

To facilitate the choice to update the existing contacts, set this field to true.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️