Anchor to section titled 'undefined'

pageDelete
mutation

Requires Any of write_content, write_online_store_pages access scopes.

Deletes a page.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID of the page to be deleted.

Was this section helpful?
Anchor to section titled 'PageDeletePayload returns'

PageDeletePayload returns

Anchor to PageDeletePayload.deletedPageId
deletedPageId
ID

The ID of the deleted page.

Anchor to PageDeletePayload.userErrors
userErrors
[PageDeleteUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation pageDelete($id: ID!) {
  pageDelete(id: $id) {
    deletedPageId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100"
}