Tally.so

Interact with Tally.so forms and submissions

Actions10

Form → Update Field

AI-generated

Overview

This node operation updates a specific field within a Tally.so form. It allows users to modify the payload or label of a field identified either by its UUID or label. The update can be done by merging new data with the existing payload or by replacing it entirely. It supports dry-run mode to preview changes without applying them and includes options for optimistic concurrency control to prevent overwriting changes made by others. This operation is useful for dynamically adjusting form fields in workflows, such as updating question options or changing field properties based on external data.

Use Case Examples

  1. Updating the options of a dropdown field in a form by merging new options with existing ones.
  2. Replacing the entire payload of a field to change its label and validation rules.
  3. Previewing changes to a form field before applying them to ensure correctness.
  4. Using optimistic concurrency to avoid conflicts when multiple users or processes might update the form simultaneously.

Properties

Name Meaning
Form The target form to update, selected from available forms.
Select By Method to select the target field, either by UUID or by label.
Field UUID The UUID of the field to update, used when selecting by UUID.
Field Label The exact label of the field to update, used when selecting by label.
Merge Strategy Determines how the payload patch is applied: merged with existing payload or replaces it entirely.
Payload Patch (JSON) The JSON patch data to apply to the field's payload.
Dry-Run / Preview If enabled, the node does not apply changes but outputs the proposed blocks and a diff for review.
Backup Previous Form If enabled, includes the pre-patch form JSON in the output to allow rollback.
Optimistic Concurrency If enabled, the node checks the form's updatedAt timestamp before patching and aborts if it has changed to prevent overwrites.

Output

JSON

  • updated - Boolean indicating if the form was successfully updated.
  • form - The updated form object after applying the field update.
  • backup - The form JSON before the update, included if backup is enabled, to support rollback.
  • preview - Boolean indicating if the output is a preview (dry-run) of the proposed changes.
  • formId - The ID of the form being updated.
  • proposedBlocks - The proposed blocks structure of the form after applying the patch, shown in dry-run mode.
  • diff - A diff between the original and proposed blocks, useful for previewing changes.

Dependencies

  • Requires an API key credential for Tally.so API access.

Troubleshooting

Error 'Field with label "" not found' indicates the specified label does not match any field in the form. Verify the label spelling and case.Error 'Field with UUID not found' means the UUID does not correspond to any field in the form. Check the UUID value.

  • If optimistic concurrency is enabled and the form has changed since it was read, the operation aborts to prevent overwriting. Retry the operation to get the latest form state.
  • Invalid JSON in the Payload Patch will cause parsing errors. Ensure the JSON is well-formed.
  • Dry-run mode outputs proposed changes without applying them; no updates will be made to the form.

Links

Discussion