Skip to content

Update Lead Qualification Settings

PUT
/org/settings/lead-qualification

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.

Authorizations

Parameters

Query Parameters

backfill

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.

boolean

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.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UpdateLeadQualificationSettingsRequest. Partial update.

object
custom_page_patterns
Any of:
Array<string>
event_groups
Any of:
object
key
additional properties
object
key
additional properties
boolean
page_patterns
Any of:
object
key
additional properties
Array<string>
qualification_enabled
Any of:
boolean

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string