View as Markdown
Form.io icon

Form.io ACTION

Update Form

Update a form or resource in Form.io. Only the fields you provide are changed; omitted fields keep their current values. Use List Forms to find the form ID. The components prop is a JSON-string array of Form.io component schema objects. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Form.io account once, then configure and run Update Form from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "form_io-update-form",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form ID",
    title: "Title",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Form inputs
Property Type Description
formId Form ID string
The _id of the form. Run List Forms first to obtain valid form IDs.
Required
title Title string
Updated title of the form.
Optional
name Name string
Updated machine name of the form.
Optional
path Path string
Updated URL path for the form.
Optional
type Type string
The form type. One of form or resource.
Optional
components Components string
JSON-string array of Form.io component schema objects. Example: [{"type":"textfield","key":"name","label":"Full Name","input":true}]. Parsed from a JSON string before sending.
Optional
display Display string
How the form is displayed (e.g. form, wizard, pdf).
Optional
tags Tags string[]
Tags to associate with the form.
Optional
settings Settings string
JSON-string object of form settings. Example: {"theme":"default"}.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
form_io-update-form
Version
0.0.1
App
Form.io
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes