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

Deprecated

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

Deletes an existing item modifier list and all modifier options associated with it



DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteModifierListRequest object as documented below.

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 delete.

Response Fields

Name Description
id
string

The modifier list's unique ID.

modifier_options
V1​Modifier​Option [ ]

The options included in the modifier list.

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.

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
DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/modifier-lists/{modifier_list_id} \
  -X DELETE \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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