---
title: "Save Form Mapping"
method: POST
path: "/forms/{form_key}/mapping/save"
tags: ["Forms"]
---

# Save Form Mapping

`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

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

## Path parameters

- `form_key` string, required: The form's `form_key` (the `id` from `GET /forms`).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- FormMappingRequest: How a form's submitted fields become contact fields. Mirrors `PreviewFormToContactMappingRequest`, which the app uses for both the preview and the save.
  - `source_id` string, nullable
  - `expected_route_version` integer, nullable: Optimistic-concurrency guard: the route version you last read. Omit for last-writer-wins.
  - `submissions_page` integer
  - `submissions_per_page` integer
  - `form_to_contact_field_mapping` FormFieldMapping[]: Submitted field -> contact field.
    - `source_field` string, required: Name of the submitted form field.
    - `target_field` string, required: Contact field it is written to.
    - `is_new_column` boolean: Whether `target_field` is a dynamic column created by this mapping.
    - `new_column_name` string, nullable: Display name of that dynamic column.
    - `dynamic_column_id` integer, nullable: Id of that dynamic column.
    - `static_value` string, nullable: Constant written to `target_field` instead of reading a submitted field.
  - `target_list_name` string, required: Name of the list the mapped submissions are saved to.
  - `target_list_id` integer, nullable: Id of that list, when it already exists.

## Response `200`

Successful Response

- ApiResponseFormsAdminPayload
  - `data` FormsAdminPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)