Forms
POST
Publish Form
POST /v1/forms/{formId}/publishPublish a form to make it available for public use.
Use Cases:
- Make a draft form live on your website
- Deploy form updates to production
- Roll back to a previous version by publishing an archived version
- Release tested changes to users
- Activate new form configuration
Behavior:
- First Publish: Root form status changes to PUBLISHED
- Subsequent Publishes: Previous published version becomes ARCHIVED
- Rollback: Publish an archived version to revert changes
- Published forms are immutable - cannot be edited
- Form URL remains constant across versions
- Embedded forms automatically use newly published version
- PublishedAt timestamp is set
- Root form's publishedVersionId points to this version
Required Scope: write:forms
Publishing Flow:
- Create form (DRAFT status)
- Configure and test form
- Publish form (becomes PUBLISHED)
- To Update: Create new version → Edit → Publish
- Previous version automatically becomes ARCHIVED
- Form URL stays the same (version transparent to users)
Version Management:
- Only one PUBLISHED version exists at a time
- Publishing archives the current PUBLISHED version
- Can publish any version (DRAFT or ARCHIVED)
- Publishing ARCHIVED version = rollback
- Root form always tracks current PUBLISHED version
Important:
- Cannot publish already PUBLISHED forms (no-op)
- Previous published version auto-archived
- Embedded forms switch instantly to new version
- Test thoroughly before publishing
- Form becomes immutable after publishing
Rollback Scenario:
- Form V1 is PUBLISHED
- Create V2, publish it (V1 → ARCHIVED)
- Issue found in V2
- Publish V1 again (V2 → ARCHIVED, V1 → PUBLISHED)
Note: Publishing is instant and affects all embedded instances immediately.
Path parameters
formIdstringrequiredForm ID to publish
Response
200Form published successfully. Status changed to PUBLISHED, publishedAt timestamp set. Previous published version (if any) is now ARCHIVED. Form is now live and immutable.
objectstringrequiredidstringrequiredUnique form identifier