Remove-ITGlueContact
SYNOPSIS
Deletes one or more contacts
SYNTAX
Bulk_Destroy (Default)
Remove-ITGlueContact [-OrganizationID <Int64>] -Data <Object> [-WhatIf] [-Confirm] [<CommonParameters>]
Bulk_Destroy_ByFilter_PSA
Remove-ITGlueContact [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterFirstName <String>]
[-FilterLastName <String>] [-FilterTitle <String>] [-FilterContactTypeID <Int64>] [-FilterImportant]
[-FilterPrimaryEmail <String>] [-FilterOrganizationID <String>] [-FilterPsaID <String>]
-FilterPsaIntegrationType <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Bulk_Destroy_ByFilter
Remove-ITGlueContact [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterFirstName <String>]
[-FilterLastName <String>] [-FilterTitle <String>] [-FilterContactTypeID <Int64>] [-FilterImportant]
[-FilterPrimaryEmail <String>] [-FilterOrganizationID <String>] [-FilterPsaIntegrationType <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-ITGlueContact cmdlet deletes one or more specified contacts
Examples of JSON objects can be found under ITGlues developer documentation https://api.itglue.com/developer
EXAMPLES
EXAMPLE 1
Remove-ITGlueContact -Data $JsonObject
Deletes contacts with the defined in structured JSON object
EXAMPLE 2
Remove-ITGlueContact -FilterID 8675309
Deletes contacts with the defined id
PARAMETERS
-OrganizationID
A valid organization Id in your account
Type: Int64
Parameter Sets: (All)
Aliases: org_id, organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterID
Filter by contact id
Type: Int64
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterFirstName
Filter by contact first name
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_first_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterLastName
Filter by contact last name
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_last_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterTitle
Filter by contact title
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_title
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterContactTypeID
Filter by contact type id
Type: Int64
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_contact_type_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterImportant
Filter by if contact is important
Type: SwitchParameter
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_important
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-FilterPrimaryEmail
Filter by contact primary email address
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_primary_email
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterOrganizationID
Filter by an organization ID
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA, Bulk_Destroy_ByFilter
Aliases: filter_organization_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterPsaID
Filter by a PSA id
This must be accompanied by the filter for FilterPsaIntegrationType
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA
Aliases: filter_psa_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterPsaIntegrationType
Filter by a PSA integration type
Allowed values: ‘manage’, ‘autotask’, ‘tigerpaw’, ‘kaseya-bms’, ‘pulseway-psa’, ‘vorex’
Type: String
Parameter Sets: Bulk_Destroy_ByFilter_PSA
Aliases: filter_psa_integration_type
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: Bulk_Destroy_ByFilter
Aliases: filter_psa_integration_type
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Data
JSON object or array depending on bulk changes or not
Type: Object
Parameter Sets: Bulk_Destroy
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
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
-Confirm
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
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
NOTES
N/A
RELATED LINKS
https://celerium.github.io/ITGlue-PowerShellWrapper/site/Contacts/Remove-ITGlueContact.html