update_tally_form
Modify an existing Tally form by updating its name, status, blocks, and settings, including language, submission limits, notifications, and styling, to customize functionality and presentation.
Instructions
Update an existing Tally form with comprehensive options including name, status, blocks, and settings
Input Schema
Name | Required | Description | Default |
---|---|---|---|
blocks | No | Array of form blocks/questions. Each block represents a form element like text input, multiple choice, etc. Use get_tally_block_types tool to see all available block types and their structures. | |
formId | Yes | The ID of the form to update | |
name | No | The name/title of the form | |
settings | No | Form settings object | |
status | No | The status of the form |
Input Schema (JSON Schema)
{
"properties": {
"blocks": {
"description": "Array of form blocks/questions. Each block represents a form element like text input, multiple choice, etc. Use get_tally_block_types tool to see all available block types and their structures.",
"items": {
"properties": {
"groupType": {
"description": "Type of group this block belongs to",
"type": "string"
},
"groupUuid": {
"description": "UUID of the group this block belongs to (for grouped blocks)",
"type": "string"
},
"payload": {
"description": "Block-specific configuration and properties. Structure varies by block type - use get_tally_block_types for detailed schemas.",
"type": "object"
},
"type": {
"description": "Type of block (e.g., \"INPUT_TEXT\", \"INPUT_EMAIL\", \"INPUT_MULTIPLE_CHOICE\", \"INPUT_CHECKBOXES\", \"INPUT_DROPDOWN\", \"INPUT_PHONE\", \"INPUT_DATE\", \"INPUT_FILE_UPLOAD\", \"INPUT_RATING\", \"INPUT_RANKING\", \"INPUT_SIGNATURE\", \"INPUT_PAYMENT\", \"LAYOUT_QUESTION_GROUP\", \"LAYOUT_STATEMENT\", \"LAYOUT_DIVIDER\", \"LAYOUT_IMAGE\", \"LAYOUT_VIDEO\", \"LAYOUT_EMBED\", \"LOGIC_JUMP\", \"LOGIC_CALCULATOR\", \"HIDDEN_FIELD\")",
"type": "string"
},
"uuid": {
"description": "Unique identifier for the block",
"type": "string"
}
},
"required": [
"uuid",
"type"
],
"type": "object"
},
"type": "array"
},
"formId": {
"description": "The ID of the form to update",
"type": "string"
},
"name": {
"description": "The name/title of the form",
"type": "string"
},
"settings": {
"description": "Form settings object",
"properties": {
"closeDate": {
"description": "Date when form closes",
"type": "string"
},
"closeMessageDescription": {
"description": "Description shown when form is closed",
"type": "string"
},
"closeMessageTitle": {
"description": "Title shown when form is closed",
"type": "string"
},
"closeTime": {
"description": "Time when form closes",
"type": "string"
},
"closeTimezone": {
"description": "Timezone for form closing",
"type": "string"
},
"hasPartialSubmissions": {
"description": "Allow partial submissions",
"type": "boolean"
},
"hasProgressBar": {
"description": "Show progress bar in form",
"type": "boolean"
},
"hasRespondentEmailNotifications": {
"description": "Enable email notifications to respondents",
"type": "boolean"
},
"hasSelfEmailNotifications": {
"description": "Enable email notifications to form owner",
"type": "boolean"
},
"isClosed": {
"description": "Whether the form is closed",
"type": "boolean"
},
"language": {
"description": "Form language",
"type": "string"
},
"pageAutoJump": {
"description": "Auto-advance form pages",
"type": "boolean"
},
"password": {
"description": "Password protection for the form",
"type": "string"
},
"redirectOnCompletion": {
"description": "URL to redirect to after form completion",
"type": "string"
},
"respondentEmailBody": {
"description": "Email body template for respondent notifications",
"type": "string"
},
"respondentEmailFromName": {
"description": "From name for respondent notifications",
"type": "string"
},
"respondentEmailReplyTo": {
"description": "Reply-to email for respondent notifications",
"type": "string"
},
"respondentEmailSubject": {
"description": "Subject line for respondent notifications",
"type": "string"
},
"respondentEmailTo": {
"description": "Email field to send respondent notifications to",
"type": "string"
},
"saveForLater": {
"description": "Allow saving form for later",
"type": "boolean"
},
"selfEmailBody": {
"description": "Email body template for owner notifications",
"type": "string"
},
"selfEmailFromName": {
"description": "From name for owner notifications",
"type": "string"
},
"selfEmailReplyTo": {
"description": "Reply-to email for owner notifications",
"type": "string"
},
"selfEmailSubject": {
"description": "Subject line for owner notifications",
"type": "string"
},
"selfEmailTo": {
"description": "Email address for form owner notifications",
"type": "string"
},
"styles": {
"description": "Custom CSS styles for the form",
"type": "string"
},
"submissionsDataRetentionDuration": {
"description": "Data retention duration for submissions",
"type": "number"
},
"submissionsDataRetentionUnit": {
"description": "Data retention unit (days, months, years)",
"type": "string"
},
"submissionsLimit": {
"description": "Maximum number of submissions allowed",
"type": "number"
},
"uniqueSubmissionKey": {
"description": "Unique key for submissions",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "The status of the form",
"enum": [
"BLANK",
"PUBLISHED",
"DRAFT"
],
"type": "string"
}
},
"required": [
"formId"
],
"type": "object"
}