Edit part of a page
edit_pageChange part of a page without sending the whole thing back. Append or prepend Markdown, or replace an exact piece of text with find and replace. Read the page first when using find: what you match against is the Markdown read_page returns. The text you match must appear exactly once, so include enough of the surrounding lines to make it unique. The previous version is kept for 14 days and the owner can restore it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| find | No | Exact text to replace, as it appears in the page's Markdown. Must occur exactly once. | |
| icon | No | Optional. Set the page's icon: one emoji. | |
| cover | No | Optional. Set the page's cover, the banner across its top. One of: brush (one ink brush stroke on paper), blue-hour (blue mountains under a moon), contours (a contour map on paper), flow (dark flowing lines with amber threads), mist (grey ridges in mist), sundown (amber ridges at sunset), garden (a raked sand garden with stones), stars (constellations on a night sky), enso (an ink circle on paper), ridges (white ridgelines on black), doodles (small doodles on paper), doodles-night (the same doodles on black), boxes (white cubes, a few in black and amber), stitch (indigo cloth with white stitching), dawn (a soft gradient, sky blue to peach), dusk (a deep gradient, blue to violet and red). Or "none" for no cover. A picture the owner uploaded is never replaced. | |
| title | No | Optional. Rename the page. | |
| append | No | Markdown to add at the end of the page. | |
| prepend | No | Markdown to add at the start of the page. | |
| project | No | The repository or project this artifact belongs to, such as the repository's name. Send the same one every time. A key is unique within its project, and a new page is filed in the project's own folder. Leave it out only for work that belongs to no project. | |
| replace | No | What to put in its place. An empty string deletes the matched text. | |
| documentId | No | The page to change. | |
| externalId | No | The key the page was filed under, instead of its id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Where the owner reads it, signed in. | |
| icon | No | The emoji beside the title. | |
| cover | No | The banner across the top of the page, by name. "uploaded" when it is a picture the owner put there. | |
| title | Yes | ||
| access | No | Who can open the shareable link: anyone who has it, or only somebody who also has the passcode. | |
| created | No | ||
| passcode | No | The passcode the link needs, when access is passcode. Give it to the user exactly as written, alongside the link. | |
| warnings | No | ||
| publicUrl | No | The shareable link, when the page is published. | |
| documentId | Yes | ||
| isPublished | Yes |