---
title: "Link Settings API Reference"
description: "Endpoints for managing link-level data collection settings in Linkbreakers."
canonical: "https://linkbreakers.com/help/api/link-settings"
---

# Link Settings

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

## Link Settings

## [#](#link-settings-object)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.

id

string

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

updatedAt

string (date-time)

Timestamp when the setting profile was last updated

Example object

```json
{
  "createdAt": "2026-10-25T17:54:24.938Z",
  "dataCollection": "DATA_COLLECTION_BASIC",
  "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "updatedAt": "2026-10-25T17:54:24.938Z"
}
```

GET

`/v1/settings/link-setting/{id}`

Requires auth

## [#](#get-a-link-setting)Get a link setting

Retrieve the current visitor data collection configuration for a link. Requires the \`links:read\` scope.

### [#](#get-a-link-setting-parameters)Parameters

#### path parameters

id

string

Required

path

Identifier of the link setting profile (UUID)

### [#](#get-a-link-setting-response)Response

200

Everything worked as expected.

linkSetting

object

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

### [#](#get-a-link-setting-error)Error response

400-599

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

error

object

Required

Wrapped error response.

Example request (cURL)

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

Typical response

```json
{
  "linkSetting": {
    "createdAt": "2026-10-25T17:54:24.936Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-10-25T17:54:24.936Z"
  }
}
```

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

PUT

`/v1/settings/link-setting/{id}`

Requires auth

## [#](#update-a-link-setting)Update a link setting

Adjust the data collection policy associated with a specific link. Requires the \`links:write\` scope.

### [#](#update-a-link-setting-parameters)Parameters

#### path parameters

id

string

Required

path

The ID of the link setting to update (UUID)

#### header parameters

Idempotency-Key

string

header

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

### [#](#update-a-link-setting-request)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.

### [#](#update-a-link-setting-response)Response

200

Everything worked as expected.

linkSetting

object

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

### [#](#update-a-link-setting-error)Error response

400-599

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

error

object

Required

Wrapped error response.

Example request (cURL)

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

Sample payload (application/json)

```json
{
  "dataCollection": "DATA_COLLECTION_UNSPECIFIED"
}
```

Typical response

```json
{
  "linkSetting": {
    "createdAt": "2026-10-25T17:54:24.936Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-10-25T17:54:24.936Z"
  }
}
```

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

---

Source: https://linkbreakers.com/help/api/link-settings