forms

Create a form

Pass from_template (a stream id) to attach the new form to that stream with a schema copied 1:1 from it, so the mapping is trivially complete. Pass if_exists: "return" to make this call safe to re-run.

post/v1/forms

Request

  • Base URL: https://postbag.dev
  • URL: https://postbag.dev/v1/forms
  • Auth: HTTP bearer

Request body

namestring
slugstring
projectstring
tagsstring[]
status'active' | 'paused'
schema_mode'observe' | 'enforce' | 'managed'
from_templatestring
if_exists'error' | 'return'

Response

created

idstring required
project_idstring required
slugstring required
namestring required
tagsstring[] required
status'active' | 'paused' required
schema_mode'observe' | 'enforce' | 'managed' required
current_schema_versioninteger nullable required
settingsobject required
submit_urlstring required
created_atstring required

Example response

{
  "id": "fm_8f3kq2",
  "project_id": "fm_8f3kq2",
  "streams": [
    {
      "id": "fm_8f3kq2"
    }
  ],
  "counts": {
    "last_submission_at": "2026-08-21T09:00:00.000Z"
  },
  "created_at": "2026-08-21T09:00:00.000Z"
}

Changes

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