Forms

Save Form Mapping

Save how a form's submitted fields become contact fields.

A FULL REPLACEMENT of the mapping. Everything captured from now on lands according to it, so preview first. expected_route_version makes it a conditional write (409 when someone else saved in between).

post/forms/{form_key}/mapping/save

Request

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

Path parameters

form_keystring required

The form's form_key (the id from GET /forms).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

source_idstring nullable
expected_route_versioninteger nullable

Optimistic-concurrency guard: the route version you last read. Omit for last-writer-wins.

submissions_pageinteger
submissions_per_pageinteger
target_list_namestring required

Name of the list the mapped submissions are saved to.

target_list_idinteger nullable

Id of that list, when it already exists.

Response

Successful Response

dataFormsAdminPayload required

One forms object, or one handler response.

Open-shaped: the submission, mapping, group and audit payloads grow with the product, and a closed model here would silently drop what it does not name.

Changes

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