API Reference

/links/{linkID}

put
https://www.toneden.io/api/v1/links/

Update a link.

Path Params
integer
required

Numeric ID of the link to update.

Body Params
number
string

The internal title of the link– not fan-facing.

number

The ID of the user account that owns the link.

string
enum

Determines what type of link landing page to render.

string

The destination URL for fanlink types which only have one destination (e.g. the URL of the event for EventLinks).

string

The root domain that the link will live on. Built-in domains are biglink.to, tourlink.to, eventlink.to, podlink.to, helpgive.to, and streamlink.to. Users may also add custom domains by contacting support. If null, the link's domain will be fanlink.to.

string

The subdomain of the link URL. Only available for built-in domains.

string

The path of the link URL. If left blank, this will be auto-generated.

string

An ISRC code entered by the user to generate a music link. This code will be used to auto-populate music services when the track or album is released.

string

A UPC code entered by the user to generate a music link. This code will be used to auto-populate music services when the track or album is released.

integer

The number of times this link has been visited.

integer

The number of times a user visited the link's landing page and then clicked through to view the link's target content.

boolean

Whether to display links to the owner's social media profiles on the link landing page.

boolean

Whether to never show the link's landing page, and instead immediatly send the user to the target URL when the link is visited.

boolean

If set to true, then the available music services will be sorted by clickthrough count in descending order on the landing page.

boolean

The first time a fan clicks on a music service on any fanlink, that service will be stored in a cookie on the fan's device. If they then visit a music fanlink with use_saved_service set to true, instead of viewing the landing page they will be directed to their saved service to view the track.

affiliate_codes
object
pixels
array of objects
pixels
services
array

A list of clickable links to display on the landing page. These represent individual music services for music fanlinks, livestreaming platforms for streamlinks, tour dates for tour fanlinks, URLs for biglinks, and podcast platforms for podlinks.

services
social_settings
array of objects

A list of links to social media profiles that will be displayed on the link landing page.

social_settings
string

The title text to be displayed on the link landing page.

string

The title of the fanlink that will appear when it is shared on social media.

string

The description of the fanlink that will appear when it is shared on social media.

string

The URL of the image that will appear when the fanlink is shared on social media.

string

The name of the author of content that will be shown on the link page.

string

The hex color of the background for BigLinks.

string

The URL of the background image of the link.

string

The URL of the landing page's header image.

string

A YouTube video, Vimeo video, or audio file URL that will appear as playable media on the link landing page.

boolean

If preview_url is a YouTube video, autoplays video on landing pgae if true.

string

For EventLinks, the hex color of the primary action button.

string

For EventLinks and fundraiser links, the text of the primary action button.

string

For EventLinks, the date of the target event.

string

For EventLinks, the location of the target event.

string

For EventLinks, the price of tickets to the target event.

Response

Updated over 5 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 5 years ago