API referenceLaunches

Update settings

Applies settings (dot-notation paths) to every node in nodeIds, all of the same nodeType. The request is atomic: every path lands or none does, and a rejection names each path and the reason. budget.dailyAmount and budget.lifetimeAmount are in cents; bid amounts and ad set spend limits are in dollars. Change campaign budget optimization with budgetStrategy (CBO or ABO). Concurrent writes to the same launch return 409.

PATCH
/v1/brands/{brandId}/launches/{launchId}/settings
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.

brandId*integer

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

launchId*string

The campaign launch (batch) id.

application/json
  1. body
nodeIds*array<>

IDs of the nodes to update (one or more)

Items1 <= items
nodeType*string

Type of the nodes (all nodeIds must share this level)

Value in"campaign""adset""ad"
settings?

Key-value pairs where keys are dot-notation setting paths and values are the new values. budget.dailyAmount and budget.lifetimeAmount are CENTS (e.g., 5000 = $50.00). optimization.bidAmount, budget.adSetMinimumSpend, budget.adSetMaximumSpend are DOLLARS. Array-typed paths (targeting.ageRange, targeting.interests, targeting.locations, targeting.excludedLocations, targeting.locales, placements.devices) MUST be native JSON arrays, not strings. isCBO is NOT allowed here, use budgetStrategy.

budgetStrategy?string

The ONLY way to change Campaign Budget Optimization. Set "CBO" (campaign-level budget) or "ABO" (ad-set-level budget) ONLY when the user explicitly asked to switch budget optimization. Omit to leave it unchanged. Never put isCBO inside settings.

Value in"CBO""ABO"

Response Body

Update settings

application/json
  1. response
[key: string]?unknown
curl -X PATCH "https://example.com/v1/brands/0/launches/string/settings" \  -H "Authorization: Bearer koast_sk_..." \  -H "Content-Type: application/json" \  -d '{    "nodeIds": [      "string"    ],    "nodeType": "campaign"  }'
{  "property1": null,  "property2": null}

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