{
"baseUrl": "https://open.spotify.com/track/5BSvMOjhomXGMXXUSDGxvU",
"mediaType": "Music",
"code": "getSchwifty",
"title": "Get Schwifty",
"tags": "demo",
"skipSearch": false,
"skipMetadataSearch": false,
"domainId": "a74ef734-9ada-4635-91a5-54ccc0437c1b"
}
{
"data": {
"url": "https://public-api.lnk.to/getSchwifty",
"tags": ["demo"],
"boardId": "9d4db9f8-f558-49b1-b753-074cf77265ca",
"created": "2017-03-17T08:43:22.4911799Z",
"updated": null,
"status": "NoScanningResults",
"isScanning": true,
"images": null,
"video": null,
"audio": null,
"id": "07d16f00-0db3-47e6-8df5-764c086fe5f7",
"mediaType": "Music",
"subMediaType": null,
"title": "Get Schwifty",
"description": null,
"baseUrl": "https://open.spotify.com/track/5BSvMOjhomXGMXXUSDGxvU",
"isrc": null,
"upc": null
},
"transactionId": "e99f8d9d-086e-4662-b855-e54019ad76d5"
}
If you already know the exact metadata or the end destinations for your campaign, you can skip parts of the Linkfire scanning process using the following flags:
- skipMetadataSearch = Skip metadata lookup and use your own metadata in the linkscanner
- skipSearch = skip the Linkfire linkscanner completely and supply your own end-destinations, artwork, samples etc.
For example, let us say you want to create a Playlist campaign and you already know the end destinations for your playlists. In this case you should set the skipSearch boolean to true.
The API supports manual destinations for multiple locales/regions. To set up your destinations, add a new object to the locales array and specify the region via the isoCode attribute. Using isoCode="all" will apply the destinations and other settings globally.
Putting it all together, the request body for creating a global playlist campaign with Spotify as the only end destination looks as seen in the sidebar example.
The remaining steps for programmatically creating Linkfire Campaigns are outlined in the Build Your First Integration guide.
{
"artist": "Various Artists",
"genre": "Tech House",
"image":"https://imageurlgoeshere.com/img.png",
"playList": "Grooves 'R' us (Deep & Tech)",
"creator": "Søren Fuhr",
"mediaType": "Music",
"subMediaType": "Playlist",
"title": "Grooves 'R' us (Deep & Tech)", //linkfire landing page title
"code": "groovesRUs",
"tags": "awesome",
"domainId": "204bd598-e6d9-4765-8fb3-319cbe77bed5",
"audio": "string", //URL for optional audio sample
"skipSearch": true,
"skipMetadataSearch": true,
"locales": [
{
"mediaServices": [
{
"mediaServiceId": "7a586f9f-9e2d-4383-83cc-b2aa5bd1798d",
"mediaServiceName": "spotify",
"buttonText": "Play",
"sortOrder": 0,
"url": "https://open.spotify.com/user/113200798/playlist/1nampp0AntpU2K9ZGKjrXi",
"status": "manual", //Must be set to manual
"enabled": true
}
],
"isoCode": "all",
"enabled": true,
"subTitle": "Listen now",
"autoRedirect": true, //set to false to disable auto redirect
"enableTracking": true
}
]
}