Save Form Route
PUT /forms/{form_key}/route
Set where this form’s submissions go, and how its fields map.
SEND THE expected_* PRECONDITIONS. They are optimistic-concurrency
guards, not settings: without them the save is last-writer-wins and can
silently overwrite a colleague’s route on a live form.
workflow_policy defaults to disabled. simulate records what WOULD
have run without running it, which is the safe way to turn automation on
for a form that is already receiving real submissions.
Authorizations
Parameters
Path Parameters
Form key.
Form key.
Header Parameters
Request Body required
Save a form’s route: where its submissions land, and how they map.
extra="forbid" mirrors the app. An unknown key here is a typo in a
caller’s mapping, and silently dropping it would send submissions to the
right list with the wrong fields.
object
Values applied to every submission.
object
Form field -> graph8 field.
object
Save anyway when the schema HAS drifted. Deliberate override.
Audience list submissions land in.
Whether routed submissions trigger workflows. simulate records what WOULD have run without running it - the safe way to turn automation on for a live form. Defaults to disabled.
Responses
200
Successful Response
object
An open envelope for a form operational view.
overview, fields, placements, activity, a route save result and a
submission trace each return a different shape assembled from several
upstreams. Pinning any of them would drop a field the moment one is added,
and on a delivery-diagnostics surface a missing field reads as a missing
delivery.
object
422
Validation Error