Soundlinks

Send a test conversion event for a soundlink

Sends the same test conversion event as the in-app “send test event” action. Pixels and tokens are read from the soundlink. This request has no body.

When the soundlink has a Meta pixel, a live Meta Conversions API event named Soundlink Stream is sent to that pixel. When it has a TikTok pixel, a live TikTok ViewContent event is sent as well. These are not sandbox events: they appear in the ad platform’s events manager.

Requires soundlinks:write. Unknown ids, another organization’s soundlink, and campaign-linked soundlinks return 404. Archived self-serve soundlinks are allowed. A soundlink with neither pixel returns 400. Does not require Idempotency-Key; each call sends a new event.

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

POST

soundlinks

{soundlinkId}

test-events

Send a test conversion event for a soundlink

curl --request POST \
  --url https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "soundlinkId": "V1StGXR8_Z5jdHi6B-myT",
    "status": "sent"
  },
  "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.

Path Parameters

soundlinkId

string

required

Soundlink identifier (URL-safe string, same ID used in the public sndl.ink URL)

Response

Test event sent

data

object

required

Show child attributes

meta

object

required

Show child attributes

Send a test conversion event for a soundlink

curl --request POST \
  --url https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/test-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "soundlinkId": "V1StGXR8_Z5jdHi6B-myT",
    "status": "sent"
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Campaigns

Soundlinks

Videos

Send a test conversion event for a soundlink

Authorizations

Path Parameters

Response