Formulare
Anmeldeformulare, die Personen, die sie ausfüllen, und ihre Zahlen.
Formular-Tools
| Tool | Was es tut |
|---|---|
| listForms | Die Anmeldeformulare des Workspace, zuletzt geänderte zuerst, mit ihrem Status, ihren Anmeldungen und Aufrufen. |
| getForm | Ein Formular vollständig: seine Felder, Texte, Audiences, Double-Opt-in und Benachrichtigungen. Bei einem veröffentlichten Formular kommen sein Link, sein Einbettungscode und die Adresse hinzu, an die ein reines HTML-Formular sendet, und includeDesign gibt den Entwurf als JSON zurück. |
| listFormStarters | Die Ausgangspunkte, von denen ein neues Formular ausgehen kann, jeweils mit den Feldern, die sie abfragen. |
| createForm | Ein Formular aus einem Ausgangspunkt, aus einem als document geschriebenen Design oder aus einem Ausgangspunkt mit Änderungen obendrauf erstellen, mit beliebigen Einstellungen. Es bleibt ein Entwurf, sofern publish nicht true ist. |
| updateForm | Den Namen und die Einstellungen eines Formulars ändern, die sofort gelten, oder über document das Design seines Entwurfs. Texte und Stil werden Schlüssel für Schlüssel zusammengeführt, und fields ersetzt die ganze Liste. |
| publishForm | Den aktuellen Entwurf zu dem machen, was Besucher sehen, damit das Formular Anmeldungen annimmt. |
| setFormStatus | Ein veröffentlichtes Formular pausieren oder wieder öffnen. |
| duplicateForm | Ein Formular in einen neuen Entwurf kopieren, ohne seine Anmeldungen. |
| deleteForm | Ein Formular und seine Anmeldungen endgültig löschen. Sein Link und seine Einbettungen funktionieren nicht mehr, und die Personen, die es hinzugefügt hat, bleiben in Ihren Kontakten. |
| getFormAnalytics | Aufrufe, Anmeldungen, hinzugefügte und noch wartende Personen sowie die Konversionsrate über einen Zeitraum, insgesamt und pro Minute, Stunde oder Tag. Aufrufe werden pro Stunde gespeichert. |
| listFormSubmissions | Die Personen, die ein Formular ausgefüllt haben, neueste zuerst, mit ihren Antworten und ihrem Status, Seite für Seite. Nach E-Mail-Adresse durchsuchbar und nach Status filterbar. |
| getFormSubmission | Eine Anmeldung vollständig: jede Antwort, ihr Status, wann sie einging und wann die Person hinzugefügt wurde, die Seite, von der sie kam, und ihre Audiences. |
| approveFormSubmission | Eine Anmeldung, die auf ihre Bestätigung wartet, ohne die E-Mail hinzufügen. Erfordert zusätzlich contacts:write. |
| resendFormConfirmation | Einer noch wartenden Anmeldung per E-Mail einen neuen Bestätigungslink senden. Es wird nichts gesendet, wenn dieses Formular dieser Adresse in den letzten zehn Minuten geschrieben hat oder die Adresse innerhalb des letzten Tages schon fünf E-Mails aus diesem Workspace erhalten hat. Erfordert außerdem emails:send. |
| removeFormSubmissions | Bis zu 200 Anmeldungen eines Formulars anhand ihrer ID löschen. Kontakte und Audiences bleiben, wie sie sind. |
Lesen erfordert forms:read und jede Änderung forms:write. Alles, wodurch ein Formular E-Mails sendet, erfordert außerdem emails:send: Double-Opt-in einschalten, den Absender oder die Bestätigungs-E-Mail festlegen, ein Formular mit Double-Opt-in veröffentlichen oder wieder öffnen und eine Bestätigung erneut senden. Ein Client, der für ein Mitglied handelt, sieht nur die Formulare, die dieses Mitglied erstellt hat, und ein auf einige Adressen beschränkter Client darf Bestätigungen nur von Adressen senden, die er erreichen kann, und nur solche Adressen benachrichtigen.
Ein Formular aus einem schriftlichen Briefing zu entwerfen, geschieht im Chat der App. Über MCP ist der Client der Designer: Übergeben Sie die Felder, Texte und den Stil als document an createForm oder updateForm, und die Tools räumen das Design auf und sagen, was sie geändert haben.
Sieben Tools auf diesem Server nehmen eine Änderung vor, die die REST API mit einem Bestätigungscode schützt, und fragen nach demselben Code: createRule, setRuleEnabled, removeDomain, removeDomainAddress, removeAppHost, deleteForm und deleteAudience für eine Audience, die Sie angelegt haben. Solange der Client in den letzten 60 Minuten keinen Code bestätigt hat und die Person für ihn unter Konto → Verbundene Apps nicht Änderungen für 60 Minuten erlauben gewählt hat, antwortet ein solches Tool mit einem Ergebnis, das mit Refused (step_up_required): beginnt, und ändert nichts. emptyAudience fragt nie nach einem Code. Die Seite Authentifizierung der API zeigt, wie man einen Code anfordert und bestätigt.
Die Tools wenden dieselben Regeln und Ablehnungen an wie die REST-API, und die /forms-Seiten der API-Referenz beschreiben jedes Feld. listForms sortiert nach der letzten Änderung, und createForm und updateForm räumen ein partielles document auf, während die API es als Ganzes annimmt.
