List item

Add-ClientListItem

Synopsis

Add items to a list.

Syntax

Add-ClientListItem -Name <String> -Items <Object[]> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-ClientListItem -Name <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-ClientListItem -ListID <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-ClientListItem -ListID <String> -Items <Object[]> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds items to a client list in two ways: either as individual items within the -Items parameter (an array of strings or a comma-separated string are accepted) or from a CSV file using the -File parameter.

Your CSV file needs to include the following four columns: value, description, tags, and expirationDate.

When making a request, you can specify the client list by either its name or ID.

The -Version parameter is an integer or the word latest.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑Body
Conditionally required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Items
Conditionally required

The entry values to import into a client list. Can be an array or a comma-separated string.

‑ListID
Conditionally required

Your client list's ID.

‑Name
Conditionally required

Your client list's name.

‑Operation

Whether to append or delete the provided list items to or from those that exist, or update the existing items.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links


Did this page help you?