form

snug form <COMMAND>

Schema-backed form intake and submissions.

Subcommands

Command	What it does
`register`	Register a form definition from a JSON file
`list`	List form definitions
`get`	Get a form definition by id
`pause`	Pause a form so it stops accepting submissions
`set-status`	Set the status of a form
`update-schema`	Update a form's JSON Schema (bumps the version)
`list-versions`	List the version history of a form
`get-version`	Get a specific version snapshot of a form
`save-draft`	Create or update a draft
`get-draft`	Retrieve a draft
`submit`	Submit JSON form data
`batch-submit`	Submit many entries to a form from a JSON file (array of {data, draft_id?})
`submit-public`	Submit form data anonymously (no auth) to a public form
`submit-multipart`	Submit form data with real file attachments (multipart upload)
`list-submissions`	List submissions for a form
`get-submission`	Get submission detail
`retry`	Retry an execution hook for a submission

Run snug form <command> --help for that command's own options. The global options apply everywhere.

Examples

snug form register --schema form.json
snug form register --schema form.json --policy form-policy.json
snug form list --status active --query support
snug form get --form-id form_support_request
snug form pause --form-id form_support_request
snug form set-status --form-id form_support_request --status active
snug form update-schema --form-id form_support_request --schema new-schema.json --fields fields.json
snug form list-versions --form-id form_support_request
snug form get-version --form-id form_support_request --version 2
snug form save-draft --form-id form_support_request --data partial.json
snug form save-draft --form-id form_support_request --data partial.json --draft-id draft_01JABCDEF
snug form get-draft --form-id form_support_request --draft-id draft_01JABCDEF
snug form submit --form form_support_request --data submission.json
snug form submit --form form_support_request --data submission.json --draft-id draft_01JABCDEF
snug form submit-public --form form_contact --data submission.json
snug form submit-multipart --form form_support_request --data submission.json --file screenshot=shot.png
snug form list-submissions --form form_support_request --status submitted
snug form get-submission --form form_support_request --submission sub_01JABCDEF
snug form retry --form form_support_request --submission sub_01JABCDEF --hook webhook

form guide - what the service does and when to reach for it.
API reference - every endpoint these commands call.
CLI reference - global options, output modes, and exit codes.

Subcommands

Examples

Next

On this page