Forms

Get Form Route Recommendations

Suggested field mappings for this form.

get/forms/{form_key}/route/recommendations

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/forms/{form_key}/route/recommendations
  • Auth: HTTP bearer

Path parameters

form_keystring required

Form key.

Query parameters

source_idstring required

Which INSTALLED SOURCE of this form. Required: a form key can be present on more than one source, and every operation here is scoped to one.

target_list_idinteger nullable

Destination list to tailor the mapping suggestions to. OPTIONAL on purpose: a caller asks for recommendations BEFORE choosing a destination, and making it required 422s every such request.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataFormPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.