Forms

Update a form

Updates a form.

patch/forms/{formId}

Request

  • Base URL: https://api.clipform.io/v1
  • URL: https://api.clipform.io/v1/forms/{formId}
  • Auth: HTTP bearer

Path parameters

formIdstring uuid required

Request body

titlestring

The form's own name (form table).

meta_titlestring nullable

SEO/social title for search results and link previews (form_metadata.title, surfaced to the viewer as meta_title). Distinct from the form name title.

is_liveboolean
show_step_counterboolean

Show step counter (e.g. '1/5')

disable_back_navigationboolean

Prevent respondents from going back

total_stepsinteger nullable

Override total step count (null = auto-calculate)

show_brandingboolean nullable

Per-form override for "Powered by Clipform" badge. null = inherit from workspace, true = show, false = hide. Free plans always show branding regardless.

moderate_responsesboolean nullable

Per-form override for moderating open-ended answers on ingest. null = inherit from workspace, true = moderate, false = do not moderate.

primary_colorstring

Primary/brand color (hex or CSS color)

background_colorstring

Background color (hex, rgba, or CSS color)

font_familystring

Font family name

brand_namestring nullable

Brand name shown alongside the logo in the viewer

logo_urlstring nullable

URL to a logo image shown in the viewer header

descriptionstring nullable

SEO description (meta description, og:description)

authorstring nullable

Author/brand name shown to respondents

allow_resumeboolean

Let returning respondents resume an unfinished session instead of restarting.

session_expiry_hoursinteger

Hours before a saved resume session expires (clamped 1-720). Default 168 (7 days).

results_publicboolean

Enable the public results portal. The first enable mints a results_share_id server-side; toggling off and back on keeps the same token.

Response

Form updated

form_idstring uuid
results_share_idstring nullable

Public results portal token, present only when results_public was just enabled for the first time.

Changes

No recorded changes to this operation across all 1 revision of this API.