Skip to main content
PUT
/
link
/
update
cURL
curl --request PUT \
  --url https://api.bsy.sh/v1/link/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "favicon": "<string>",
  "title": "<string>",
  "custom_link": "<string>",
  "tags": [
    "<string>"
  ],
  "has_utm": true,
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "has_opengraph": true,
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_image": "<string>",
  "has_android_targeting": true,
  "android_target_url": "<string>",
  "has_ios_targeting": true,
  "ios_target_url": "<string>",
  "has_windows_targeting": true,
  "windows_target_url": "<string>",
  "has_linux_targeting": true,
  "linux_target_url": "<string>",
  "has_geo_targeting": true,
  "geo_targets": [
    {
      "target_url": "<string>"
    }
  ],
  "has_cloaking": true,
  "has_password": true,
  "password": "<string>",
  "password_logo": "<string>",
  "has_expiration": true,
  "expiration": "2023-11-07T05:31:56Z",
  "expiration_clicks": "<string>"
}
'
import requests

url = "https://api.bsy.sh/v1/link/update"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "favicon": "<string>",
    "title": "<string>",
    "custom_link": "<string>",
    "tags": ["<string>"],
    "has_utm": True,
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "has_opengraph": True,
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_image": "<string>",
    "has_android_targeting": True,
    "android_target_url": "<string>",
    "has_ios_targeting": True,
    "ios_target_url": "<string>",
    "has_windows_targeting": True,
    "windows_target_url": "<string>",
    "has_linux_targeting": True,
    "linux_target_url": "<string>",
    "has_geo_targeting": True,
    "geo_targets": [{ "target_url": "<string>" }],
    "has_cloaking": True,
    "has_password": True,
    "password": "<string>",
    "password_logo": "<string>",
    "has_expiration": True,
    "expiration": "2023-11-07T05:31:56Z",
    "expiration_clicks": "<string>"
}
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({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    favicon: '<string>',
    title: '<string>',
    custom_link: '<string>',
    tags: ['<string>'],
    has_utm: true,
    utm_source: '<string>',
    utm_medium: '<string>',
    utm_campaign: '<string>',
    utm_term: '<string>',
    utm_content: '<string>',
    has_opengraph: true,
    meta_title: '<string>',
    meta_description: '<string>',
    meta_image: '<string>',
    has_android_targeting: true,
    android_target_url: '<string>',
    has_ios_targeting: true,
    ios_target_url: '<string>',
    has_windows_targeting: true,
    windows_target_url: '<string>',
    has_linux_targeting: true,
    linux_target_url: '<string>',
    has_geo_targeting: true,
    geo_targets: [{target_url: '<string>'}],
    has_cloaking: true,
    has_password: true,
    password: '<string>',
    password_logo: '<string>',
    has_expiration: true,
    expiration: '2023-11-07T05:31:56Z',
    expiration_clicks: '<string>'
  })
};

fetch('https://api.bsy.sh/v1/link/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bsy.sh/v1/link/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'favicon' => '<string>',
    'title' => '<string>',
    'custom_link' => '<string>',
    'tags' => [
        '<string>'
    ],
    'has_utm' => true,
    'utm_source' => '<string>',
    'utm_medium' => '<string>',
    'utm_campaign' => '<string>',
    'utm_term' => '<string>',
    'utm_content' => '<string>',
    'has_opengraph' => true,
    'meta_title' => '<string>',
    'meta_description' => '<string>',
    'meta_image' => '<string>',
    'has_android_targeting' => true,
    'android_target_url' => '<string>',
    'has_ios_targeting' => true,
    'ios_target_url' => '<string>',
    'has_windows_targeting' => true,
    'windows_target_url' => '<string>',
    'has_linux_targeting' => true,
    'linux_target_url' => '<string>',
    'has_geo_targeting' => true,
    'geo_targets' => [
        [
                'target_url' => '<string>'
        ]
    ],
    'has_cloaking' => true,
    'has_password' => true,
    'password' => '<string>',
    'password_logo' => '<string>',
    'has_expiration' => true,
    'expiration' => '2023-11-07T05:31:56Z',
    'expiration_clicks' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bsy.sh/v1/link/update"

	payload := strings.NewReader("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"favicon\": \"<string>\",\n  \"title\": \"<string>\",\n  \"custom_link\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"has_utm\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"has_opengraph\": true,\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_image\": \"<string>\",\n  \"has_android_targeting\": true,\n  \"android_target_url\": \"<string>\",\n  \"has_ios_targeting\": true,\n  \"ios_target_url\": \"<string>\",\n  \"has_windows_targeting\": true,\n  \"windows_target_url\": \"<string>\",\n  \"has_linux_targeting\": true,\n  \"linux_target_url\": \"<string>\",\n  \"has_geo_targeting\": true,\n  \"geo_targets\": [\n    {\n      \"target_url\": \"<string>\"\n    }\n  ],\n  \"has_cloaking\": true,\n  \"has_password\": true,\n  \"password\": \"<string>\",\n  \"password_logo\": \"<string>\",\n  \"has_expiration\": true,\n  \"expiration\": \"2023-11-07T05:31:56Z\",\n  \"expiration_clicks\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.bsy.sh/v1/link/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"favicon\": \"<string>\",\n  \"title\": \"<string>\",\n  \"custom_link\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"has_utm\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"has_opengraph\": true,\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_image\": \"<string>\",\n  \"has_android_targeting\": true,\n  \"android_target_url\": \"<string>\",\n  \"has_ios_targeting\": true,\n  \"ios_target_url\": \"<string>\",\n  \"has_windows_targeting\": true,\n  \"windows_target_url\": \"<string>\",\n  \"has_linux_targeting\": true,\n  \"linux_target_url\": \"<string>\",\n  \"has_geo_targeting\": true,\n  \"geo_targets\": [\n    {\n      \"target_url\": \"<string>\"\n    }\n  ],\n  \"has_cloaking\": true,\n  \"has_password\": true,\n  \"password\": \"<string>\",\n  \"password_logo\": \"<string>\",\n  \"has_expiration\": true,\n  \"expiration\": \"2023-11-07T05:31:56Z\",\n  \"expiration_clicks\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.bsy.sh/v1/link/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"favicon\": \"<string>\",\n  \"title\": \"<string>\",\n  \"custom_link\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"has_utm\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"has_opengraph\": true,\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_image\": \"<string>\",\n  \"has_android_targeting\": true,\n  \"android_target_url\": \"<string>\",\n  \"has_ios_targeting\": true,\n  \"ios_target_url\": \"<string>\",\n  \"has_windows_targeting\": true,\n  \"windows_target_url\": \"<string>\",\n  \"has_linux_targeting\": true,\n  \"linux_target_url\": \"<string>\",\n  \"has_geo_targeting\": true,\n  \"geo_targets\": [\n    {\n      \"target_url\": \"<string>\"\n    }\n  ],\n  \"has_cloaking\": true,\n  \"has_password\": true,\n  \"password\": \"<string>\",\n  \"password_logo\": \"<string>\",\n  \"has_expiration\": true,\n  \"expiration\": \"2023-11-07T05:31:56Z\",\n  \"expiration_clicks\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "<string>"
}
{
  "status": "failure",
  "message": "<string>"
}
{
  "status": "failure",
  "message": "<string>"
}
{
  "status": "failure",
  "message": "<string>"
}
{
  "status": "failure",
  "message": "<string>",
  "errors": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}
{
  "status": "error",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Update the details of a Bitsy Link

​
id
string<uuid>
required

The unique identifier for the Bitsy Link to be updated.

​
favicon
string

URL of the favicon for the link.

​
title
string

Title of the link, up to 150 characters.

Maximum string length: 150
​
custom_link
string

Custom slug for the link, between 3 and 50 characters.

Required string length: 3 - 50
​
tags
string[]

Array of tags associated with the link.

Minimum string length: 1
​
has_utm
boolean

Indicates if UTM parameters are used.

​
utm_source
string

UTM source for tracking.

Maximum string length: 200
​
utm_medium
string

UTM medium for tracking.

Maximum string length: 200
​
utm_campaign
string

UTM campaign for tracking.

Maximum string length: 200
​
utm_term
string

UTM term for paid search.

Maximum string length: 200
​
utm_content
string

UTM content for differentiating ads.

Maximum string length: 200
​
has_opengraph
boolean

Indicates if OpenGraph metadata is included.

​
meta_title
string

Meta title for the link, up to 150 characters.

Maximum string length: 150
​
meta_description
string

Meta description for the link, up to 250 characters.

Maximum string length: 250
​
meta_image
string

URL of the image to use for the link's metadata.

​
has_android_targeting
boolean

Indicates if there is a target URL for Android.

​
android_target_url
string

Target URL for Android devices.

​
has_ios_targeting
boolean

Indicates if there is a target URL for iOS.

​
ios_target_url
string

Target URL for iOS devices.

​
has_windows_targeting
boolean

Indicates if there is a target URL for Windows.

​
windows_target_url
string

Target URL for Windows devices.

​
has_linux_targeting
boolean

Indicates if there is a target URL for Linux.

​
linux_target_url
string

Target URL for Linux devices.

​
has_geo_targeting
boolean

Indicates if geo-targeting is used.

​
geo_targets
object[]

Array of geo-targeting rules.

​
has_cloaking
boolean

Indicates if cloaking is enabled.

​
has_password
boolean

Indicates if a password is required to access the link.

​
password
string

Password required to access the link.

URL of the logo to display on the password prompt.

​
has_expiration
boolean

Indicates if the link has an expiration date or expiration clicks.

​
expiration
string<date-time>

Expiration date for the link in ISO 8601 format.

​
expiration_clicks
string

Maximum number of clicks before the link expires.

Response

Link updated successfully

​
status
enum<string>
required

Indicates the status of the request.

Available options:
success
​
message
string
required

A message providing additional details about the request.