Removes a contact from the system using the specified identifier.

Remove-Contact [-Identifier] <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

The Remove-Contact function deletes a contact from the system based on the provided identifier. The identifier can be an email_id (for EMAIL), phone_id (for SMS), or contact_id (for the ID of the contact).

Remove-Contact -Identifier "contact_id_12345"
This command removes the contact with the ID "contact_id_12345".

Remove-Contact -Identifier "[email protected]"
This command removes the contact with the email "[email protected]".

The identifier of the contact to be removed. This can be an email_id, phone_id, or contact_id.

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, and has a high confirm impact.