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

Body

application/json
name
string
required

Human-readable soundlink name.

Minimum string length: 1
spotifyUrl
string<uri>
required

HTTPS Spotify track or playlist URL. Album, artist, and URI (spotify:track:...) forms are rejected. An optional intl-xx path segment is accepted. Query strings are stripped before lookup. The resource must currently exist on Spotify.

Example:

"https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl"

autoFollow
boolean
default:false

When true, fans who connect Spotify from the landing page are asked to follow the track artist (artistIdFollow, or the track's primary artist when omitted), or the playlist itself when spotifyUrl is a playlist. Defaults to false.

artistIdFollow
string

Spotify artist ID used for auto-follow on track links. Optional. Persisted even when autoFollow is false. For multi-artist tracks, pass the artist that should be followed. Ignored when spotifyUrl is a playlist.

metaPixelId
string

Meta pixel ID. Must be sent together with metaConversionAccessToken. Omit both to skip Meta tracking.

metaConversionAccessToken
string
write-only

Meta Conversions API access token. Write-only: accepted on create, never returned on GET. Must be sent together with metaPixelId.

Response

Soundlink created

data
object
required
meta
object
required