Add-PPhoneNumber

NAME Add-PPhoneNumber



SYNOPSIS

Adds a phone number to a person or organization.





SYNTAX

Add-PPhoneNumber [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-PhoneNumber <String>]

[-PhoneType <String>] [-Primary <Int32>] [-Public <Int32>] [<CommonParameters>]



Add-PPhoneNumber [-PopuliUri] <String> [-PopuliAuthkey] <String> -OrganizationId <Int32> [-PhoneNumber <String>]

[-OrgPhoneType <String>] [-Primary <Int32>] [-Public <Int32>] [<CommonParameters>]





DESCRIPTION

Adds phone number using the given parameters. Returns a Phone id that can then be used

with other cmdlets like Update-PPhoneNumber | Delete-PPhoneNumber. (See Output section.)

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 adding this phone number to his/her own profile.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PersonId <Int32>

Numeric ID of the person to whose profile you are attaching this email address.

This Parameter is not required. (but either person_id OR organization_id MUST be set)



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-OrganizationId <Int32>

Numeric ID of the organization to whose profile you are attaching this email address.

This Parameter is not required. (but either person_id OR organization_id MUST be set)



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

This parameter is required.



Required? true

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



-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



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

<Home|Work|School|Mobile|Fax|Other>PhoneId





NOTES





Author: Matthew Rehm

Creation Date: 04/24/2019



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



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

'7781234' -PhoneNumber '888-555-1212' -PhoneType SCHOOL













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



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

-OrganizationId '2669162' -PhoneNumber '888-555-1212' -OrgPhoneType WORK















RELATED LINKS