Skip to content

pacx customapi add param

github-actions[bot] edited this page Jun 16, 2026 · 1 revision

Adds a request parameter to an existing Dataverse Custom API.

Usage

Add a required Integer parameter to an existing Custom API:

pacx customapi add-param -a nn_GregSum -p Addend1:Integer

Add an optional String parameter with a custom display name:

pacx customapi add-param -a nn_GregSum -p Comment?:String -d "Optional Comment"

Supported types: Boolean, DateTime, Decimal, Entity, EntityCollection, EntityReference, Float, Integer, Money, Picklist, String, StringArray, Guid.

Arguments

Long Name Short Name Required? Description Default value Valid values
api a Y Unique name of the target Custom API (e.g. nn_GregSum). - String
param p Y Parameter spec as Name:Type (required) or Name?:Type (optional). Name must not include publisher prefix — the name is built as {api}-in-{name}. - String
display-name d N Display name. Defaults to the parameter name without prefix, split on camel-case. - String
description desc N Description of the parameter. String

Command list

Clone this wiki locally