Skip to content

Rollback Form Route

DELETE
/forms/{form_key}/route

Roll the route back, or cancel a pending one.

A DELETE that takes a BODY, matching the app - because this is not “delete the route”, it is “move it back”, and which version to move to has to travel with the request. The form keeps routing; it routes as it did before.

Authorizations

Parameters

Path Parameters

form_key
required

Form key.

string

Form key.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Roll a route back to an earlier version, or cancel the pending one.

Sent as the body of a DELETE, matching the app: this is not “delete the route”, it is “move it back”, and which version to move to has to travel with the request.

object
cancel_current

Cancel a pending route instead of restoring an old one.

boolean
expected_current_version
Any of:
integer
>= 1
restore_version
Any of:
integer
>= 1
source_id
required
string
>= 1 characters <= 500 characters

Responses

200

Successful Response

object
data
required

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
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string