Link Settings

Endpoints for managing link-level data collection settings in Linkbreakers.

GET
/v1/settings/data-collection
Requires auth

#Get the data collection level

Return the data collection level of the caller's workspace, which applies to every link. Requires the `links:read` scope.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

linkSetting

object

Stores per-link compliance preferences that drive how Linkbreakers collects visitor data before executing the workflow.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object
Required

Wrapped error response.

PUT
/v1/settings/data-collection
Requires auth

#Update the data collection level

Set the data collection level of the caller's workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.

#Parameters

header parameters

Idempotency-Key

string
header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

#Request body

dataCollection

string (enum)

Defines how aggressively Linkbreakers prompts visitors for identifying data before allowing the workflow to continue.

Allowed values
DATA_COLLECTION_UNSPECIFIED

Data collection preference not specified

DATA_COLLECTION_NONE

No visitor data captured; Linkbreakers only logs the scan event.

DATA_COLLECTION_BASIC

Minimal data prompts (e.g., email) enabled to keep friction low while identifying high-signal visitors.

DATA_COLLECTION_ADVANCED

Full lead capture flows, including custom forms and required fields, before continuing the workflow.

#Response

200

Everything worked as expected.

linkSetting

object

Stores per-link compliance preferences that drive how Linkbreakers collects visitor data before executing the workflow.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object
Required

Wrapped error response.