< Back
Get-PLeadSources
Post
NAME Get-PLeadSources
SYNOPSIS
Returns all the lead sources you've set up in the Admissions module.
SYNTAX
Get-PLeadSources [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]
DESCRIPTION
You must have the Admissions role to call this task.
Useful for looking up numeric IDs for passing into setLeadInfo.
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. (See Description.)
This parameter is required.
Required? true
Position? 2
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 objects:
LeadId
Name
Type
NOTES
Author: Matthew Rehm
Creation Date: 11/06/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PLeadSources -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
RELATED LINKS
SYNOPSIS
Returns all the lead sources you've set up in the Admissions module.
SYNTAX
Get-PLeadSources [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]
DESCRIPTION
You must have the Admissions role to call this task.
Useful for looking up numeric IDs for passing into setLeadInfo.
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. (See Description.)
This parameter is required.
Required? true
Position? 2
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 objects:
LeadId
Name
Type
NOTES
Author: Matthew Rehm
Creation Date: 11/06/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PLeadSources -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
RELATED LINKS