You are viewing an old version of the API
Update modifier list
V1

Deprecated

Note We recommend using the Square API (V2) for all new development when possible.

Modifies the details of an existing item modifier list.



Required permissions ITEMS_WRITE

Path Parameters

Name Description
location_id
string

Required

The ID of the item's associated location.

modifier_list_id
string

Required

The ID of the modifier list to edit.

Request Body

Name Description
name
string

The modifier list's name.

selection_type
string

Indicates whether multiple options from the modifier list can be applied to a single item. See V1UpdateModifierListRequestSelectionType for possible values

Response Fields

Name Description
id
string

The modifier list's unique ID.

name
string

The modifier list's name.

selection_type
string

Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See V1ModifierListSelectionType for possible values

modifier_options
ModifierOption [ ]

The options included in the modifier list.

v2_id
string

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Examples

You are viewing an old version of the API
PUT /v1/{location_id}/modifier-lists/{modifier_list_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/modifier-lists/{modifier_list_id} \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?