---
title: "Link Settings API Reference | Linkbreakers"
description: "How much identifying data visitors are asked for: the workspace's data collection level and each link's settings."
canonical: "https://linkbreakers.com/help/api/link-settings"
---

# Link Settings

How much identifying data visitors are asked for: the workspace's data collection level and each link's settings.

5 entries on this page

## The link setting 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` enum

Data collection mode that controls visitor prompts and requirements

Allowed values

* `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 link setting

```json
{
  "createdAt": "2026-03-14T09:30:00Z",
  "dataCollection": "DATA_COLLECTION_BASIC",
  "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "updatedAt": "2026-03-18T16:05:00Z"
}
```

### Response

200

`linkSetting` object

The workspace's link setting, with its data collection level

Fields: [The link setting object](#link-settings-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/settings/data-collection" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "linkSetting": {
    "createdAt": "2026-03-14T09:30:00Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`id` string 

path

Required

Identifier of the link setting profile (UUID)

### Response

200

`linkSetting` object

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

Fields: [The link setting object](#link-settings-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

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

Response 200

```json
{
  "linkSetting": {
    "createdAt": "2026-03-14T09:30:00Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`dataCollection` enum

The new data collection level

Allowed values

* `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

`linkSetting` object

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

Fields: [The link setting object](#link-settings-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PUT "https://api.linkbreakers.com/v1/settings/data-collection" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "dataCollection": "DATA_COLLECTION_BASIC"
}'
```

Response 200

```json
{
  "linkSetting": {
    "createdAt": "2026-03-14T09:30:00Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`id` string 

path

Required

The ID of the link setting to update (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`dataCollection` enum

The new data collection setting Determines how much visitor information is requested during workflow steps

Allowed values

* `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

`linkSetting` object

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

Fields: [The link setting object](#link-settings-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

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

Response 200

```json
{
  "linkSetting": {
    "createdAt": "2026-03-14T09:30:00Z",
    "dataCollection": "DATA_COLLECTION_BASIC",
    "id": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

---

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