Organization Settings

Update Lead Qualification Settings

Update lead qualification. Partial - omitted fields are left alone.

backfill=true is the dangerous half: it walks the last 30 days of traffic and creates leads from every event you just switched on. Do it deliberately, or leave it false and use POST .../lead-qualification/backfill once you are happy with the settings.

put/org/settings/lead-qualification

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/org/settings/lead-qualification
  • Auth: HTTP bearer

Query parameters

backfillboolean

Also create leads from newly-enabled events in the last 30 days. This CREATES RECORDS for traffic that already happened - it is not a dry run, and there is no undo.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

qualification_enabledboolean nullable

Master switch for turning visitor events into qualified leads.

event_groupsobject nullable

Signal group -> event name -> enabled.

custom_page_patternsstring[] nullable

Extra URL patterns that count as a high-intent page view.

page_patternsobject nullable

Signal group -> URL patterns.

Response

Successful Response

dataStudioPayload required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting".

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

Changes

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