Campaigns

Stop a wallet campaign and refund unspent budget

Stops delivery for a wallet-funded campaign and refunds unspent budget to the organization wallet. Requires the campaigns:write scope.

Wallet campaigns only (generation: 3).

Statuses that accept stop and return stopped: active, inactive, restarting, restart_failed, renew_failed, and renew_awaiting_charge.

Already terminal: stopped and ended succeed without changing status. The response status stays stopped or ended. A second stop does not double-refund.

Retry later (400 invalid_request): creating and renewing.

The Idempotency-Key header is required so retries of the same request replay the original response without repeating side effects.

Auth: Accepts API key or OAuth Bearer (campaigns:write).

POST

campaigns

{campaignId}

stop

Stop a wallet campaign and refund unspent budget

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

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

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};

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

{
  "data": {
    "campaignId": "campaign-uuid",
    "status": "stopped"
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

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)

Response

Campaign stopped (or already stopped)

data

object

required

Show child attributes

meta

object

required

Show child attributes

Stop a wallet campaign and refund unspent budget

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

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

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};

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

{
  "data": {
    "campaignId": "campaign-uuid",
    "status": "stopped"
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Wallet

Campaigns

Soundlinks

Videos

Pixels

Stop a wallet campaign and refund unspent budget

Authorizations

Headers

Path Parameters

Response