Skip to main content
POST

Authorizations

x-api-key
string
header
required

Pass your Soundlink sk_* API key in the x-api-key header. Keys can carry explicit scopes (for example campaigns:read, metrics:read, videos:write) enforced by the backend.

Deprecated, retiring 2026-08-17 — migrate to Authorization: Bearer sk_... (see apiKeyBearerAuth) before then.

Headers

Idempotency-Key
string
required

A unique string identifying this request, used to safely retry write operations (create, stop, budget increase/decrease) without repeating side effects. Required on every request that references this parameter. Reusing this key with an unchanged request body replays the original response; reusing it with a different body returns 409 idempotency_key_conflict. Keys are honored for 24 hours.

Required string length: 1 - 255

Path Parameters

campaignId
string
required

Campaign identifier (UUID)

Body

application/json
amount
number
required

Wallet debit / top-up amount in USD. Must be positive, except mode: next_renewal with targetDailyBudget where amount may be 0.

mode
enum<string>

Defaults to current_and_renewals when omitted on increase requests.

Available options:
current_cycle,
next_renewal,
current_and_renewals
targetDailyBudget
number

Optional absolute next-cycle daily budget (USD). Most useful with mode: next_renewal.

Required range: x > 0

Response

Budget increase accepted

data
object
required
meta
object
required