Update ClickFlare settings

Changes the ClickFlare workspaces Koast reads and overrides the tracking fields that carry the ad platform campaign, ad set and ad ids. Only the fields sent change. A tracking field set here is marked manual and is never replaced by detection; null clears it. Requires an organization owner or admin.

PATCH

/v1/brands/{brandId}/integrations/clickflare/settings

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

Request Body

application/json

body

workspaceIds?array<>

ClickFlare workspace ids to read. An empty list reads every workspace of the account.

Itemsitems <= 200

trackingFields?

Overrides the detected tracking fields. A role set here is marked manual; null clears it.

Response Body

Update ClickFlare settings

application/json

response

brandId*number

connected*boolean

Whether a ClickFlare API key is connected to the brand.

maskedApiKey*string|null

timezone*|

The ClickFlare account timezone used for reports. Null means UTC is used.

currency*string|null

workspaceIds*array<string>

trackingFields*

trackingFieldsSource*

How each tracking field was chosen: data (matched Koast ids in ClickFlare traffic), traffic_source (the traffic source template), or manual.

lastPullAt*string|null

lastPullError*string|null

lastPullRows*number|null

curl -X PATCH "https://example.com/v1/brands/0/integrations/clickflare/settings" \  -H "Authorization: Bearer koast_sk_..." \  -H "Content-Type: application/json" \  -d '{}'

{  "brandId": 0,  "connected": true,  "maskedApiKey": "string",  "timezone": "string",  "currency": "string",  "workspaceIds": [    "string"  ],  "trackingFields": {    "campaign": "string",    "adset": "string",    "ad": "string"  },  "trackingFieldsSource": {    "campaign": "data",    "adset": "data",    "ad": "data"  },  "lastPullAt": "string",  "lastPullError": "string",  "lastPullRows": 0}

Required scope: write. CLI: koast update-clickflare-settings, see Integrations commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.