Developer API
Delete Page
V2

Delete Page

Move a page to trash and return the soft-deleted page state.

DELETE /v2/pages/:page_id

Delete Page

Use Case

Use this endpoint to move a page to trash. This is a soft delete and keeps the API response in the page object model.

Endpoint

Item Value
Method DELETE
Path /v2/pages/:page_id
Request body None
Returns page
Scope pages.write

Permissions

Requires pages.write and access to the target resource.

Parameters

Parameter Type Required Description
page_id string Yes Page ID.

Response Example

{
  "object": "page",
  "id": "11111111-1111-4111-8111-111111111111",
  "page_type": "page",
  "created_time": "2026-04-09T08:00:00.000Z",
  "last_edited_time": "2026-04-09T09:30:00.000Z",
  "created_by": {
    "object": "user",
    "id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"
  },
  "last_edited_by": {
    "object": "user",
    "id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"
  },
  "parent": {
    "type": "page_id",
    "page_id": "55555555-5555-4555-8555-555555555555"
  },
  "in_trash": true,
  "icon": null,
  "cover": null,
  "properties": {
    "title": {
      "id": "title",
      "type": "title",
      "title": [
        {
          "type": "text",
          "text": {
            "content": "Launch Plan",
            "link": null
          },
          "plain_text": "Launch Plan",
          "href": null
        }
      ]
    }
  },
  "url": "https://buildin.ai/docs/11111111-1111-4111-8111-111111111111"
}

Behavior

  • The endpoint performs a soft delete by moving the target to trash.
  • The response returns the target object or a deletion state with in_trash: true.
  • Use the corresponding update endpoint when you need to explicitly set trash state as part of a larger update.

Errors

  • 401 unauthorized: invalid or expired token.
  • 403 forbidden: missing scope or no access.
  • 404 not_found: target resource does not exist.

Prerequisites

Next Steps

References