Remove BrevoContactFolder - tsubotitsch/Brevo GitHub Wiki
Removes a contact folder by its ID.
Remove-BrevoContactFolder [-folderId] <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
The Remove-BrevoContactFolder function deletes a contact folder identified by its ID. It uses the DELETE HTTP method to send a request to the specified URI.
Remove-BrevoContactFolder -folderId "12345"
This command removes the contact folder with the ID "12345".
"12345" | Remove-BrevoContactFolder
This command removes the contact folder with the ID "12345" by passing the ID through the pipeline.
Get-BrevoContactFolder -folderId "12345" | Remove-BrevoContactFolder
This command retrieves the contact folder with the ID "12345" and then removes it.
The unique identifier of the folder to be removed. This parameter is mandatory and accepts a string value. It can also be provided via pipeline by property name.
Type: String
Parameter Sets: (All)
Aliases: Id
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
{{ 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
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
- This function supports ShouldProcess for safety, allowing you to confirm the action before it is executed.
- ConfirmImpact is set to 'High', so you may be prompted for confirmation depending on your PowerShell settings.