Publish or close a form
share_formPublish a form (make the link anyone can fill it in at, which shows nothing else of the document), close it (the link kept, showing its closed message), or delete its link. A form must have questions and somewhere for responses to go; a form not ready is refused with what to fix. Answers its state, link and response count.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | The Form tab, by id or name. Absent: the document’s first Form tab. | |
| action | Yes | publish: make the form link (or open a closed one again, same link). close: stop taking responses, the link kept. delete_link: remove the link; publishing again makes a new one. | |
| documentId | Yes | The document (from find_documents). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Link that opens the document in the livediagram editor. | |
| link | Yes | The form link anyone can fill it in at; null unpublished or for a non-Editor. | |
| made | No | The documents and tabs the call made. | |
| cover | No | The cover band’s colours. | |
| lines | No | What the call did. | |
| state | Yes | accepting: the link takes responses. paused: published, but responses have nowhere to go. | |
| tabId | Yes | The Form tab. | |
| unseen | Yes | Responses the caller has not seen (opening the Form tab sees them). | |
| heading | Yes | The form’s heading, which is its tab’s name. | |
| problems | Yes | What stops it being published, in Share Form’s words; empty when ready. | |
| sections | Yes | The pages of the form, in order. | |
| settings | Yes | closesAt (ISO), limit, and the confirmation and closed messages respondents see. | |
| responses | Yes | Responses so far. | |
| documentId | Yes | The document. | |
| respondsTo | Yes | Where responses go: {to: "board", board, cardType, column}, {to: "sheet", sheet} or {to: "nowhere"}. | |
| description | No | The line under the heading. | |
| closedReason | No | Why a published form is closed: switched_off, closes_at (its time passed) or limit (it is full). | |
| respondsToProblem | No | Why responses cannot land there now. |