`authorModifierGroup`

Author Modifier Group

Author a reusable modifier GROUP and its full choice set in one call: the structured model behind "pick one color", "choose accessories", and "add gift wrap".

write

Arguments

appIdstringrequiredThe Studio app ID whose catalog to edit.
choicesobject[]requiredThe group's choices.
descriptionstringoptionalShort explainer for the group.
displayOrderintegeroptionalOrder among the product's groups. Defaults 0.
freeTextobjectoptionalFree-text contract for the group, e.g. 'Write color in notes'.
groupIdstringoptionalExisting group ID to re-author. Omit to create a new group.
maxSelectionsintegeroptionalMaximum choices a shopper may pick.
minSelectionsintegeroptionalMinimum choices a shopper must pick.
namestringrequiredOwner-authored group name, e.g. 'Material'.
perChoiceQuantityLimitintegeroptionalMax quantity of any ONE choice. Defaults 1.
requiredbooleanoptionaltrue forces a selection from this group. Defaults false.
selectionTypestringrequiredsingle = pick exactly one; multiple = pick any number.

Returns

The registry does not declare a return shape.

Declared limits

choices: minimum items 1
displayOrder: minimum -9007199254740991
displayOrder: maximum 9007199254740991
maxSelections: minimum 0
maxSelections: maximum 9007199254740991
minSelections: minimum 0
minSelections: maximum 9007199254740991
perChoiceQuantityLimit: greater than 0
perChoiceQuantityLimit: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

this shirt comes in blue, black, or white
add a personalization section
set up the accessories list

Pair it with

The verbs that finish the job.