Batch update form - Automate.ax

batchUpdateForm is the escape hatch for Forms features that do not yet have a code-first action. Prefer the high-level item, metadata, settings, and publishing actions for common operations.

Example

import { automation, onHttpRequest } from "automate.ax"
import { batchUpdateForm } from "automate.ax/google-forms"

export default automation("Create a provider-native item", () => {
  onHttpRequest({ scope: "automation" })

  batchUpdateForm({
    form: "form-id",
    includeForm: true,
    requests: [
      {
        createItem: {
          item: { title: "Introduction", textItem: {} },
          location: { index: 0 },
        },
      },
    ],
  })
})

Inputs

form and a non-empty requests array of Google Forms API Request objects are required. includeForm controls whether Google returns the updated form. Use either requiredRevisionId for a strict optimistic write or targetRevisionId to merge against a recent revision, never both. account selects the Google account.

Output

interface FormBatchUpdateResult {
  form?: Form
  revisionId?: string
  replies: Array<{
    createdItemId?: string
    createdQuestionIds: string[]
  }>
}

Replies correspond one-to-one with requests. Provider-native request shapes follow the Google Forms API and can change independently of Automate.ax’s high-level types.

⌘I