Update form with the Tally API

Changes the name, status, settings or blocks of a form. Sending blocks replaces all of them, so read the form with Get form first; name, status and settings can go alone.

Identifier
tally_update_form

The request

POST https://connect.reportei.com/api/tools/tally_update_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "form_id": "<form_id>"
  }
}

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
form_idstringYesId of the form, from List forms or from the form URL: wA0Bc1 in https://tally.so/r/wA0Bc1.
namestringNoNew name of the form.
statusstringNoPUBLISHED puts the form live, DRAFT keeps the changes unpublished. Deleting is not done here.Values: BLANK, DRAFT, PUBLISHED
blocksarrayNoEvery block of the form, in order: this list replaces the current blocks, so send all of them, the existing ones with the uuid and groupUuid from Get form, and a block left out is removed. 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.
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_update_form. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

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