Skip to content

Retry Form Delivery

POST
/forms/deliveries/{receipt_id}/retry

Retry ONE failed delivery.

Scoped by receipt rather than by form, so a caller retries the specific submission that failed instead of replaying everything - which is what the backfill endpoints are for, and why they are not on this surface.

NOTE ON ROUTING ORDER: /forms/deliveries/... is a LITERAL first segment that /forms/{form_key}/... would otherwise swallow, reading “deliveries” as a form key. It is declared here, and the shadowing test compares compiled match patterns to keep it that way.

Authorizations

Parameters

Path Parameters

receipt_id
required

Delivery receipt id from the activity feed.

string

Delivery receipt id from the activity feed.

Header Parameters

X-Target-Org-Id
Any of:
string

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