API reference
Forms operations
Forms, drafts, publishing, placements, triggers, short links and responses. Operations, access levels and variables.
| Operation | Access | Summary |
|---|---|---|
| AddFormPlacement | Write | Place a form on a connection surface (storefront, email or QR). |
| CreateForm | Write | Create a form; body carries title, surfaces and view type. Invalid input returns userErrors. |
| DeleteForm | Write | Delete a form and its placements. Irreversible. |
| FormBuilder | Read | Get one form by slug with its placements, draft snapshot and settings. |
| FormChannels | Read | List the surfaces a form can be placed on (storefront, email, QR) per integration. |
| FormIncentives | Read | List the incentives attached to the given forms. |
| FormInsightRead | Read | Insight facts, answers and reasons mined from form responses, with filters. |
| FormInstall | Read | Install state for one form: its placements and verified storefront domains. |
| FormResponseDetail | Read | Get one form response with every answer, the verdict that scored it and the order it earned. |
| FormResponsesSurface | Read | Responses for one form in a window: the list, counts by placement and the funnel. |
| FormShortLinks | Read | List the short links and QR targets for forms. |
| FormsList | Read | List forms with a filter: slug, title, status, surfaces, tags and A/B share. |
| FormTriggers | Read | List the triggers (when to show) for the given forms. |
| PromotionRotation | Read | Which forms rotate on the published surface, and their A/B shares. |
| PublishForm | Write | Publish a form's draft as its live version. |
| RemoveFormPlacement | Write | Remove a form placement. Irreversible. |
| ReplaceFormTriggers | Write | Replace a form's triggers; the old ones are not kept. Irreversible. |
| RotateFormPublicKey | Write | Rotate a form placement's public key; embeds using the old key stop working. Irreversible. |
| SaveFormDraft | Write | Save a form's draft content. |
| SetFormPlacementCopy | Write | Set a form placement's copy. |
| SetFormPlacementPublished | Write | Publish or unpublish a form placement. |
| SetFormPlacementQrStyle | Write | Set a form placement's QR code style. |
| SetFormPromotion | Write | Set which forms rotate on the published surface and their shares. |
| SetShortLinkDisabled | Write | Enable or disable a short link. |
| UpdateForm | Write | Update a form's title, surfaces, priority, status or schedule. |
| VerifyFormPlacement | Write | Check that a form placement is installed on the storefront. |