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

You are viewing an old version of the API
Update page
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 a Favorites page in Square Point of Sale.

Required permissions: ITEMS_WRITE

Deprecation date

2019-11-20

Retirement date

2020-11-18
Migration guide

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 to modify.

Request Body

Name Description
id
string

The page's unique identifier.

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
cells
PageCell [ ]

The cells included on the page.

Response Fields

Name Description
id
string

The page's unique identifier.

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
cells
PageCell [ ]

The cells included on the page.

Examples

You are viewing an old version of the API
PUT /v1/{location_id}/pages/{page_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/pages/page_id1 \
  -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?