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).
Stopping is idempotent at the campaign level: a second stop on an
already-stopped campaign succeeds without double-refunding. The
Idempotency-Key header is also required so retries of the same
request replay the original response without repeating side effects.
Authorizations
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
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.
1 - 255Path Parameters
Campaign identifier (UUID)