• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update modifier option
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Modifies the details of an existing item modifier option.

Required permissions: ITEMS_WRITE

Deprecation date

2019-11-20

Retirement date

2020-11-18

Replaced by

UpsertCatalogObject
Migration guide

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.

modifier_option_id
string

Required

The ID of the modifier list to edit.

Request Body

Name Description
id
string

The modifier option's unique ID.

name
string

The modifier option's name.

price_money
Money

The modifier option's price.

on_by_default
boolean

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal
integer

Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

modifier_list_id
string

The ID of the modifier list the option belongs to.

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.

Response Fields

Name Description
id
string

The modifier option's unique ID.

name
string

The modifier option's name.

price_money
Money

The modifier option's price.

on_by_default
boolean

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal
integer

Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

modifier_list_id
string

The ID of the modifier list the option belongs to.

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}/modifier-options/{modifier_option_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/modifier-lists/modifier_list_id1/modifier-options/modifier_option_id2 \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

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