You are viewing an old version of the API
Delete page
V1

Deprecated

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

Deletes an existing Favorites page and all of its cells



DeletePage returns nothing on success but Connect SDKs map the empty response to an empty V1DeletePageRequest object.

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

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

Share Feedback

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