Créer un formulaire avec l'API Tally
Crée un formulaire à partir de ses blocs et renvoie id, name, workspace et status. Le formulaire va dans le workspace par défaut sauf si workspaceId est envoyé.
- Identifiant
- tally_create_form
L'appel
POST https://connect.reportei.com/api/tools/tally_create_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"status": "BLANK",
"blocks": []
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| status | string | Oui | PUBLISHED puts the form live, DRAFT keeps the changes unpublished. Deleting is not done here.Valeurs : BLANK, DRAFT, PUBLISHED |
| blocks | array | Oui | Blocks of the form, in order. A question is a TITLE block with groupType QUESTION and the question in payload.html, followed by its input block, like INPUT_TEXT, INPUT_EMAIL or TEXTAREA, whose groupType repeats the type. The form title is a FORM_TITLE block with groupType TEXT and the title in payload.html. |
| workspaceId | string | Non | Workspace of the form: an id from List workspaces. |
| folderId | string | Non | Folder of the form, inside that workspace: a folder id from List workspaces. Folders need the Pro plan. |
| settings | object | Non | Form settings. Other Tally settings, like the respondent email and the data retention, also go here. |
Connexions possibles
Votre client connecte son compte Tally une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/tally_create_form. Il devient la définition de tool de votre agent sans conversion.
Autres tools Tally
- Lister les workspacesGETListe les workspaces de l'organisation avec id, name, membres, invitations en attente et dossiers, chacun avec id et name. Paginez avec page tant que hasMore vaut true.
- Lister les formulairesGETListe les formulaires avec id, name, workspaceId, status, numberOfSubmissions, isClosed et dates. Paginez avec page tant que hasMore vaut true.
- Obtenir un formulaireGETRenvoie un formulaire avec ses réglages et tous ses blocs, chacun avec uuid, type, groupUuid, groupType et payload. Modifier un formulaire reprend les blocs dans ce format.
- Modifier un formulairePATCHModifie le nom, le statut, les réglages ou les blocs d'un formulaire. Envoyer blocks les remplace tous, lisez donc d'abord le formulaire avec Obtenir un formulaire ; name, status et settings peuvent être envoyés seuls.
- Lister les réponses d'un formulaireGETListe les réponses d'un formulaire, chacune avec id, isCompleted, submittedAt, les liens d'aperçu et PDF et ses responses, plus les questions du formulaire, de sorte que chaque réponse se rattache à une question par questionId. Paginez avec page tant que hasMore vaut true.
- Obtenir une réponse de formulaireGETRenvoie une réponse avec tous ses responses et les questions du formulaire.
- Obtenir les métriques d'un formulaireGETRenvoie les totaux d'un formulaire sur la période : visites, vues totales, débuts, réponses, complétions, répondants uniques, taux de complétion et durées moyennes de visite et de complétion.
- Obtenir les visites d'un formulaireGETRenvoie les visites d'un formulaire sur la période, sous forme de comptes par intervalle.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
