Update-PAddress

NAME Update-PAddress



SYNOPSIS

Updates an address.





SYNTAX

Update-PAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> [-AddressId <Int32>] [-Street <String>] [-City

<String>] [-State <String>] [-Postal <String>] [-Country <String>] [-AddressType <String>] [-Primary <Int32>]

[-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]



Update-PAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> [-AddressId <Int32>] [-Street <String>] [-City

<String>] [-State <String>] [-Postal <String>] [-Country <String>] [-OrgAddressType <String>] [-Primary <Int32>]

[-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Updates an address using the given parameters. Review the parameters for specific requirements

and settings.





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.

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

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. Required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Street <String>

e.g. 777 Magnolia Ln



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-City <String>

e.g. Moscow



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-State <String>

e.g. ID



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Postal <String>

e.g. 83843



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Country <String>

e.g. USA



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AddressType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OrgAddressType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Primary <Int32>

Use if you want to mark the email address as primary or not primary. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Old <Int32>

Use if you want to mark the email address as old or not old. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Public <Int32>

Use if you want to mark the email address as public or not public. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

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 --------------------------



PS C:\\>#Update address with a person address id.



Update-PAddress -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -AddressId

'7781234' -Address '123 Main St.' -AddressType BILLING









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Update address with an organizational address id.



Update-PAddress -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -AddressId

'2265253' -OrgAddressType BILLING











RELATED LINKS