Create form with the Tally API

Creates a form from its blocks and returns its id, name, workspace and status. The form goes to the default workspace unless workspaceId is sent.

Identifier
tally_create_form

The request

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": []
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
statusstringYesPUBLISHED puts the form live, DRAFT keeps the changes unpublished. Deleting is not done here.Values: BLANK, DRAFT, PUBLISHED
blocksarrayYesBlocks 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.
workspaceIdstringNoWorkspace of the form: an id from List workspaces.
folderIdstringNoFolder of the form, inside that workspace: a folder id from List workspaces. Folders need the Pro plan.
settingsobjectNoForm settings. Other Tally settings, like the respondent email and the data retention, also go here.

Supported connections

Your customer connects their Tally account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/tally_create_form. It becomes your agent's tool definition with no conversion.

Other Tally tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.