Visitors

Update Form Capture Settings

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

allowed_hostsstring[]

Capture only on these hosts. Empty means every host.

blocked_hostsstring[]

Never capture on these hosts.

blocked_pathsstring[]

Never capture on these URL paths.

track_appointmentsboolean

Also capture booking-form submissions.

Response

Successful Response

dataSiteConnectionsPayload required

One handler response. Open-shaped - these payloads come from the tracking pipeline.

Changes

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