Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass your Soundlink sk_* API key as a Bearer token: Authorization: Bearer sk_<prefix>_<token> (not an OAuth token; see oauthBearer for that). Accepted on all Public API operations. Send only one Authorization header per request.

Headers

Idempotency-Key
string
required

A unique string identifying this request, used to safely retry write operations (campaign create/stop/budget, soundlink create) 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