Update-PPhoneNumber

NAME Update-PPhoneNumber



SYNOPSIS

Updates a phone number.





SYNTAX

Update-PPhoneNumber [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PhoneId <Int32>] [-PhoneNumber <String>]

[-PhoneType <String>] [-Primary <Int32>] [-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]



Update-PPhoneNumber [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PhoneId <Int32>] [-PhoneNumber <String>]

[-OrgPhoneType <String>] [-Primary <Int32>] [-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

Updates a phone number 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



-PhoneId <Int32>

Numeric ID of the phone number.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-PhoneNumber <String>

e.g. 1-800-888-8888



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PhoneType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OrgPhoneType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Primary <Int32>

Use if you want to mark the phone number 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 phone number 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 phone number 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/25/2019



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



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



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

-PhoneId '7781234' -PhoneNumber '1-800-888-8888' -PhoneType SCHOOL









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



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



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

-PhoneId '2261234' -PhoneNumber '1-800-888-8888' -PhoneType FAX











RELATED LINKS