Skip to content

update_form

Apply a partial update to a form.

See https://docs.merofoundry.app/recipes/tool-update-form for the accepted keys, including the required settings.access value.

{
"additionalProperties": false,
"properties": {
"application_id": {
"title": "Application Id",
"type": "string"
},
"body": {
"additionalProperties": true,
"title": "Body",
"type": "object"
},
"clear_description": {
"default": false,
"title": "Clear Description",
"type": "boolean"
},
"clear_style_id": {
"default": false,
"title": "Clear Style Id",
"type": "boolean"
},
"form_id": {
"title": "Form Id",
"type": "string"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
}
},
"required": [
"application_id",
"form_id",
"body",
"idempotency_key"
],
"title": "update_formArguments",
"type": "object"
}
{
"properties": {
"application_id": {
"format": "uuid",
"title": "Application Id",
"type": "string"
},
"created_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Created At"
},
"created_by": {
"format": "uuid",
"title": "Created By",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"is_default": {
"title": "Is Default",
"type": "boolean"
},
"layout": {
"additionalProperties": true,
"title": "Layout",
"type": "object"
},
"mode": {
"enum": [
"simple",
"advanced"
],
"title": "Mode",
"type": "string"
},
"model_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
},
"name": {
"title": "Name",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
},
"style_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"type": {
"title": "Type",
"type": "string"
},
"updated_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Updated At"
}
},
"required": [
"id",
"name",
"description",
"type",
"layout",
"style_id",
"is_default",
"settings",
"position",
"model_id",
"mode",
"application_id",
"created_by",
"created_at",
"updated_at"
],
"title": "FormResponse",
"type": "object"
}