You are viewing an old version of the API
Update page cell
V1

Deprecated

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

Modifies a cell of a Favorites page in Square Point of Sale



Required permissions ITEMS_WRITE

Path Parameters

Name Description
location_id
string

Required

The ID of the Favorites page's associated location.

page_id
string

Required

The ID of the page the cell belongs to.

Request Body

Name Description
column
integer

The column of the cell. Always an integer between 0 and 4, inclusive.

object_id
string

The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER.

object_type
string

The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER).

page_id
string

The unique identifier of the page the cell is included on.

placeholder_type
string

For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior.

row
integer

The row of the cell. Always an integer between 0 and 4, inclusive.

Response Fields

Name Description
id
string

The page's unique identifier.

cells
V1​Page​Cell [ ]

The cells included on the page.

name
string

The page's name, if any.

page_index
integer

The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive.

Max 6

Examples

You are viewing an old version of the API
PUT /v1/{location_id}/pages/{page_id}/cells
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/pages/{page_id}/cells \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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