Campaigns

Decrease wallet campaign daily budget

Lowers the daily budget for a wallet-funded campaign to targetDailyBudget. Requires the campaigns:write scope and an Idempotency-Key header.

Wallet campaigns only (generation: 3).

Modes (default current_and_renewals):

current_cycle — lowers current-cycle spend only
current_and_renewals — also sets the next-cycle daily budget

next_renewal is not supported for decreases. Refund of unused budget is applied asynchronously after acceptance (accepted: true).

Domain rules (also returned as invalid_request when violated):

targetDailyBudget must be at least $10/day and lower than the current daily budget
more than 3 days must remain in the current cycle

POST

campaigns

{campaignId}

budget

decrease

Decrease wallet campaign daily budget

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "targetDailyBudget": 60
}
'

import requests

url = "https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease"

payload = { "targetDailyBudget": 60 }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({targetDailyBudget: 60})
};

fetch('https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "campaignId": "campaign-uuid",
    "mode": "current_and_renewals",
    "targetDailyBudget": 60,
    "accepted": true,
    "walletNextCycleDailyBudget": 60
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

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

targetDailyBudget

number

required

New daily budget in USD (gross). Must be at least $10/day and lower than the campaign's current daily budget.

Required range: x >= 10

mode

enum<string>

Defaults to current_and_renewals when omitted on decrease requests. next_renewal is not supported for decreases.

Available options:

current_cycle,

current_and_renewals

Response

Budget decrease accepted (refund may complete asynchronously)

data

object

required

Show child attributes

meta

object

required

Show child attributes

Decrease wallet campaign daily budget

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "targetDailyBudget": 60
}
'

import requests

url = "https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease"

payload = { "targetDailyBudget": 60 }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({targetDailyBudget: 60})
};

fetch('https://api.getsoundlink.com/v1/campaigns/{campaignId}/budget/decrease', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "campaignId": "campaign-uuid",
    "mode": "current_and_renewals",
    "targetDailyBudget": 60,
    "accepted": true,
    "walletNextCycleDailyBudget": 60
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Campaigns

Metrics

Videos

Decrease wallet campaign daily budget

Authorizations

Headers

Path Parameters

Body

Response