Add BrevoContactListMember - tsubotitsch/Brevo GitHub Wiki

Add-BrevoContactListMember

SYNOPSIS

Adds members to a specified contact list in Brevo.

SYNTAX

AddContactToListByEmails

Add-BrevoContactListMember -listId <Int32> -emails <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

AddContactToListByIds

Add-BrevoContactListMember -listId <Int32> [-ids <Int32[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

AddContactToListByExtIds

Add-BrevoContactListMember -listId <Int32> [-extids <Int32[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The Add-BrevoContactListMember function allows you to add contacts to a specific contact list in Brevo. You can add contacts using their email addresses, IDs, or external IDs (EXTID attributes). The function supports adding up to 150 contacts in a single request.

EXAMPLES

EXAMPLE 1

Add-BrevoContactListMember -listId 123 -emails @("[email protected]", "[email protected]")

Add contacts to a list using email addresses

EXAMPLE 2

Add-BrevoContactListMember -listId 123 -ids @(101, 102, 103)

Add contacts to a list using contact IDs

EXAMPLE 3

Add-BrevoContactListMember -listId 123 -extids @(201, 202, 203)

Add contacts to a list using external IDs

PARAMETERS

-emails

An array of email addresses to add to the contact list. This parameter is mandatory when using the "AddContactToListByEmails" parameter set. You can pass a maximum of 150 email addresses in one request.

Type: String[]
Parameter Sets: AddContactToListByEmails
Aliases:

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

-extids

An array of external IDs (EXTID attributes) to add to the contact list. This parameter is optional and used with the "AddContactToListByExtIds" parameter set. You can pass a maximum of 150 EXTID attributes in one request.

Type: Int32[]
Parameter Sets: AddContactToListByExtIds
Aliases:

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

-ids

An array of contact IDs to add to the contact list. This parameter is optional and used with the "AddContactToListByIds" parameter set. You can pass a maximum of 150 IDs in one request.

Type: Int32[]
Parameter Sets: AddContactToListByIds
Aliases:

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

-listId

The ID of the contact list to update. This parameter is mandatory.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: 0
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

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

OUTPUTS

Object

Returns the updated (success/failure) contact list object.

NOTES

  • Ensure that you provide at least one of the parameters: emails, ids, or extids.

RELATED LINKS

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