Remove-PAddress

NAME Remove-PAddress



SYNOPSIS

Deletes an address.





SYNTAX

Remove-PAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> -AddressId <Int32> [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

The current user must have the Staff role or else be deleting an email address on his/her own profile.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AddressId <Int32>

Numeric ID of the address.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns PowerShell object:

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 04/30/2019



-------------------------- EXAMPLE 1 --------------------------



Remove-PAddress -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'

-AddressId 4567834















RELATED LINKS