Integrations commands

Every command is one API operation, named by its operationId. Global flags such as --output and --api-url work on all of them, see CLI commands.

connect-clickflare

Connect ClickFlare. POST /v1/brands/{brandId}/integrations/clickflare, API reference.

koast connect-clickflare --brand <brand> --api-key <api-key> [--json <file|->] [flags]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--api-key`	string	Yes	A ClickFlare API key (ClickFlare → Settings → API keys). At most 512 characters.
`--workspace-ids`	string, repeatable	No	ClickFlare workspace ids to read. An empty list reads every workspace of the account. At most 200 items.

Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast connect-clickflare --brand 123 --api-key API_KEY

disconnect-clickflare

Disconnect ClickFlare. DELETE /v1/brands/{brandId}/integrations/clickflare, API reference.

koast disconnect-clickflare --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: write.

Example:

koast disconnect-clickflare --brand 123

get-clickflare-cost-push

Get ClickFlare spend push. GET /v1/brands/{brandId}/integrations/clickflare/push, API reference.

koast get-clickflare-cost-push --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: read.

Example:

koast get-clickflare-cost-push --brand 123

get-clickflare-settings

Get ClickFlare settings. GET /v1/brands/{brandId}/integrations/clickflare/settings, API reference.

koast get-clickflare-settings --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: read.

Example:

koast get-clickflare-settings --brand 123

get-redtrack-cost-push

Get RedTrack spend push. GET /v1/brands/{brandId}/integrations/redtrack/push, API reference.

koast get-redtrack-cost-push --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: read.

Example:

koast get-redtrack-cost-push --brand 123

list-clickflare-campaign-mappings

List ClickFlare campaign mappings. GET /v1/brands/{brandId}/integrations/clickflare/mappings, API reference.

koast list-clickflare-campaign-mappings --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: read.

Example:

koast list-clickflare-campaign-mappings --brand 123

list-redtrack-campaign-mappings

List RedTrack campaign mappings. GET /v1/brands/{brandId}/integrations/redtrack/mappings, API reference.

koast list-redtrack-campaign-mappings --brand <brand>

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.

Required scope: read.

Example:

koast list-redtrack-campaign-mappings --brand 123

update-clickflare-campaign-mapping

Update ClickFlare campaign mapping. PUT /v1/brands/{brandId}/integrations/clickflare/mappings/{providerCampaignId}, API reference.

koast update-clickflare-campaign-mapping --brand <brand> --provider-campaign-id <provider-campaign-id> --cf-campaign-id <cf-campaign-id> [--json <file|->]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--provider-campaign-id`	string	Yes	The ad platform campaign id (a Meta campaign id, or a Whop `adcamp_…` id). At most 191 characters.
`--cf-campaign-id`	string	Yes	The ClickFlare campaign id to push this campaign's spend into. Null removes the manual mapping and falls back to the automatic one, if any. At most 64 characters.

Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast update-clickflare-campaign-mapping --brand 123 --provider-campaign-id PROVIDER_CAMPAIGN_ID --cf-campaign-id CF_CAMPAIGN_ID

update-clickflare-cost-push

Update ClickFlare spend push. PUT /v1/brands/{brandId}/integrations/clickflare/push, API reference.

koast update-clickflare-cost-push --brand <brand> --enabled <enabled> [--json <file|->]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--enabled`	boolean	Yes	Turn the hourly spend push into ClickFlare on or off for this brand.

Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast update-clickflare-cost-push --brand 123 --enabled

update-clickflare-settings

Update ClickFlare settings. PATCH /v1/brands/{brandId}/integrations/clickflare/settings, API reference.

koast update-clickflare-settings --brand <brand> [--json <file|->] [flags]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--workspace-ids`	string, repeatable	No	ClickFlare workspace ids to read. An empty list reads every workspace of the account. At most 200 items.
`--tracking-fields`	JSON object	No	Overrides the detected tracking fields. A role set here is marked `manual`; null clears it.

Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast update-clickflare-settings --brand 123

update-redtrack-campaign-mapping

Update RedTrack campaign mapping. PUT /v1/brands/{brandId}/integrations/redtrack/mappings/{providerCampaignId}, API reference.

koast update-redtrack-campaign-mapping --brand <brand> --provider-campaign-id <provider-campaign-id> --rt-campaign-id <rt-campaign-id> [--json <file|->]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--provider-campaign-id`	string	Yes	The ad platform campaign id (a Meta campaign id, or a Whop `adcamp_…` id). At most 191 characters.
`--rt-campaign-id`	string	Yes	The RedTrack campaign id to push this campaign's spend into. Null removes the manual mapping and falls back to the automatic one, if any. At most 64 characters.

Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast update-redtrack-campaign-mapping --brand 123 --provider-campaign-id PROVIDER_CAMPAIGN_ID --rt-campaign-id RT_CAMPAIGN_ID

update-redtrack-cost-push

Update RedTrack spend push. PUT /v1/brands/{brandId}/integrations/redtrack/push, API reference.

koast update-redtrack-cost-push --brand <brand> --enabled <enabled> [--json <file|->]

Flag	Type	Required	Description
`--brand`	integer	Yes	The brand the request acts on. Every brand-scoped resource lives under its brand.
`--enabled`	boolean	Yes	Turn the hourly spend push into RedTrack on or off for this brand.

Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.

Example:

koast update-redtrack-cost-push --brand 123 --enabled

Integrations commands

On this page