Docs

Forms

PUT

Update Form

PUT /v1/forms/{formId}

Update an existing form's configuration (DRAFT forms only).

Use Cases:

  • Modify form fields and layout
  • Update form title or description
  • Change redirect URL after submission
  • Customize submit button text
  • Refine form builder configuration

Behavior:

  • Only DRAFT forms can be updated
  • PUBLISHED and ARCHIVED forms are immutable
  • To update published forms, create a new version first
  • All fields are optional (partial updates supported)
  • UpdatedAt timestamp is automatically refreshed
  • Returns the complete updated form object

Required Scope: write:forms

Updatable Fields (DRAFT only):

  • name (internal identifier)
  • title (displayed to users)
  • description (form instructions)
  • fields (form builder configuration)
  • redirectUrl (post-submission redirect)
  • submitText (button text)

Update Workflow for Published Forms:

  1. Create new version: POST /v1/forms/{formId}/versions
  2. Update the new DRAFT version: PUT /v1/forms/{newVersionId}
  3. Publish the updated version: POST /v1/forms/{newVersionId}/publish
  4. Previous published version automatically becomes ARCHIVED

Important:

  • Cannot update PUBLISHED or ARCHIVED forms
  • Changes to DRAFT don't affect live form until published
  • Test changes before publishing
  • Form builder configuration must be valid JSON

Note: For published forms, create a new version instead of updating directly.

Path parameters

formIdstringrequired

Form ID

Bodyrequired

namestring
Min length: 1Max length: 200
descriptionany
type"SIGN_UP" | "SURVEY"
display"POPUP" | "INLINE_EMBED"
fieldsobject
settingsany
doubleOptInEmailIdany
seoTitleany
seoDescriptionany
seoImageUrlany
seoFaviconUrlany
slugany

Response

200Form updated successfully with refreshed updatedAt timestamp. Form remains in DRAFT status.
objectstringrequired
idstringrequired

Unique form identifier

Copyright © 2026 Kibamail.·Privacy Policy