Link Settings API Reference

#The LinkSetting object

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

createdAt

string (date-time)

Timestamp when the setting profile was created

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.

string

Unique identifier for the link-level setting profile (UUID)

updatedAt

string (date-time)

Timestamp when the setting profile was last updated

GET/v1/settings/link-setting/{id}Requires auth

#Get a link setting

Retrieve the current visitor data collection configuration for a link.

#Parameters

path parameters

stringRequiredpath

Identifier of the link setting profile (UUID)

#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

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/settings/link-setting/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "linkSetting": {
    "createdAt": "2025-10-29T07:58:52.281Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2025-10-29T07:58:52.281Z"
  }
}

Base URL: https://api.linkbreakers.com

PUT/v1/settings/link-setting/{id}Requires auth

#Update a link setting

Adjust the data collection policy associated with a specific link.

#Parameters

path parameters

stringRequiredpath

The ID of the link setting to update (UUID)

#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

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PUT "https://api.linkbreakers.com/v1/settings/link-setting/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"dataCollection":"DATA_COLLECTION_UNSPECIFIED"}'

Sample payload (application/json)

{
  "dataCollection": "DATA_COLLECTION_UNSPECIFIED"
}

Typical response

{
  "linkSetting": {
    "createdAt": "2025-10-29T07:58:52.281Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2025-10-29T07:58:52.281Z"
  }
}

Base URL: https://api.linkbreakers.com