Publish or unpublish a page
publish_pagePut a page on the open web and get a link the user can send to someone, or take it back down by passing publish: false. With access: "passcode" the link opens only for somebody who also types the passcode this returns - use it whenever the user wants the page shared but not open to anyone who finds the link. A connected app can only do this for pages it wrote itself; a page the user made in the app has to be published by them. Published pages are not indexed by search engines unless their owner separately allows it in the app, and taking a page down clears that consent rather than remembering it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| access | No | Optional. "passcode" puts the page on the web behind a six-character passcode, returned in the result, which the user sends along with the link. "anyone" opens it to anyone with the link. Omit to keep the page at the level it has - a page behind a passcode is never opened up unless you send "anyone", and only do that when the user asks. | |
| 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. | |
| publish | Yes | True puts it on the web, false takes it down. | |
| documentId | No | The page to publish or unpublish. | |
| externalId | No | The key the page was filed under, if you do not have its id. | |
| newPasscode | No | Optional. True replaces the passcode with a new one, so the old one stops working everywhere. Only for a page behind a passcode. |
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 |