discovery

One call to a working, routed form

Creates (idempotently, by name within project) the project if missing, the form, a destination for whichever of notify_email/telegram/webhook was given, and a direct route, then returns the form, an embeddable snippet, a browser-equivalent curl command to verify delivery, and next steps. Allowed origins are compared canonically, so paths, trailing slashes, host casing, and default ports do not cause mismatches. Everything it does is also available as individual calls (POST /v1/forms, /v1/destinations, /v1/routes); this is a convenience, not a special path.

post/v1/quickstart

Request

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

Request body

namestring required

projectstring

originstring uri

notify_emailstring email

tagsstring[]

redirect_urlstring uri

Response

created (or returned)

Example response

{
  "form": {
    "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"
  },
  "destinations": [
    {
      "id": "fm_8f3kq2",
      "created_at": "2026-08-21T09:00:00.000Z"
    }
  ],
  "routes": [
    {
      "id": "fm_8f3kq2",
      "destination_id": "fm_8f3kq2",
      "created_at": "2026-08-21T09:00:00.000Z"
    }
  ]
}

Changes

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