---
title: "Update Form Capture Settings"
method: PATCH
path: "/visitors/form-capture-settings"
tags: ["Visitors"]
---

# Update Form Capture Settings

`PATCH /visitors/form-capture-settings`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/visitors/form-capture-settings`
- Auth: HTTP bearer

Replace the form-capture filters. Takes effect for the next submission on the site.

PATCH is the app's verb, but the body is a FULL REPLACEMENT - see the
request model.

## Headers

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

## Request body

- FormCaptureSettingsRequest: Which pages form submissions are captured from. A FULL REPLACEMENT: every list is written as sent, so an omitted list is reset to empty and an omitted `track_appointments` goes back to true. Read `GET /visitors/form-capture-settings` first and send the whole object back.
  - `allowed_hosts` string[]: Capture only on these hosts. Empty means every host.
  - `blocked_hosts` string[]: Never capture on these hosts.
  - `blocked_paths` string[]: Never capture on these URL paths.
  - `track_appointments` boolean: Also capture booking-form submissions.

## Response `200`

Successful Response

- ApiResponseSiteConnectionsPayload
  - `data` SiteConnectionsPayload, required: One handler response. Open-shaped - these payloads come from the tracking pipeline.
  - `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)