Pixels

Save an organization pixel

Saves the Conversions API access token and/or default flag for pixelId. The same call creates the pixel or rotates its token, and both return 200:

No Meta pixel yet: the pixel is saved (accessToken required).
pixelId matches a Meta pixel the organization already has: its access token is replaced when accessToken is sent.
A different Meta pixel for the same organization: the new pixel is saved alongside existing ones.
The pixel is configured by another organization: 409 meta_pixel_conflict.
The access token is already used with another pixel: 400 invalid_request.
platform other than meta: 400 invalid_request.
Optional isDefault sets or clears the org default for Meta. At least one of accessToken or isDefault is required.

The response never includes the access token. Use POST /v1/pixels/{pixelId}/test-events to check the pixel and token.

Requires pixels:write. Organizations without custom pixels enabled get 403 custom_pixel_not_enabled. Does not require Idempotency-Key; repeating the same request is safe.

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

PUT

pixels

{pixelId}

Save an organization pixel

curl --request PUT \
  --url https://api.getsoundlink.com/v1/pixels/{pixelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platform": "meta"
}
'

import requests

url = "https://api.getsoundlink.com/v1/pixels/{pixelId}"

payload = { "platform": "meta" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({platform: 'meta'})
};

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

{
  "data": {
    "id": "1234567890123456",
    "platform": "meta",
    "isDefault": true,
    "status": "ok",
    "lastErrorCode": null,
    "errorSince": null
  },
  "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

pixelId

string

required

Pixel id on the ad platform.

Minimum string length: 1

Body

application/json

platform

enum<string>

required

Ad platform for the pixel. Only meta is supported today.

Available options:

meta

accessToken

string

Conversions API access token. Stored and never returned. Required when creating a new pixel; optional when only updating isDefault.

Minimum string length: 1

isDefault

boolean

Sets or clears the organization's default Meta pixel. At least one of accessToken or isDefault must be present.

Response

Pixel saved or token rotated

data

object

required

Show child attributes

meta

object

required

Show child attributes

Save an organization pixel

curl --request PUT \
  --url https://api.getsoundlink.com/v1/pixels/{pixelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platform": "meta"
}
'

import requests

url = "https://api.getsoundlink.com/v1/pixels/{pixelId}"

payload = { "platform": "meta" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({platform: 'meta'})
};

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

{
  "data": {
    "id": "1234567890123456",
    "platform": "meta",
    "isDefault": true,
    "status": "ok",
    "lastErrorCode": null,
    "errorSince": null
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Wallet

Campaigns

Soundlinks

Videos

Pixels

Save an organization pixel

Authorizations

Path Parameters

Body

Response