Get ContactAttribute - tsubotitsch/Brevo GitHub Wiki
Retrieves contact attributes from the Brevo API.
Get-ContactAttribute [[-Name] <String[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
The Get-ContactAttribute function retrieves contact attributes from the Brevo API. It allows filtering by attribute name(s) if specified. The function uses the Invoke-BrevoCall helper function to make the API call.
# Retrieve all contact attributes
Get-ContactAttribute
# Retrieve a specific contact attribute by name
Get-ContactAttribute -Name "FirstName"
# Retrieve multiple contact attributes by names
Get-ContactAttribute -Name @("FirstName", "LastName")
# or
Get-ContactAttribute -Name "FirstName", "LastName"
The name of the contact attribute(s) to filter by. This parameter is case-insensitive and can accept a single string or an array of strings. If not specified, all attributes are returned.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
- This function requires the Invoke-BrevoCall helper function to be defined and accessible.
- The "returnobject" parameter in the API call is set to "attributes" to specify the desired data to be returned.