View as Markdown
Form.io icon

Form.io ACTION

Update Submission

Update a submission for a Form.io form. Only the fields you provide are changed; omitted fields keep their current values. Use List Submissions to find the submission ID. The data prop is a JSON-string object of field key-value pairs. 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 Submission 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-submission",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form ID",
    submissionId: "Submission ID",
  },
})

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 Submission inputs
Property Type Description
formId Form ID string
The _id of the form. Run List Forms first to obtain valid form IDs.
Required
submissionId Submission ID string
The _id of the submission. Run List Submissions first to obtain valid submission IDs.
Required
data Data string
JSON-string object of the submission's data payload. Example: {"name":"Jane Doe","email":"jane@example.com"}. Parsed with JSON.parse() before sending.
Required
state State string
Submission state. One of submitted or draft.
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-submission
Version
0.0.1
App
Form.io
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes