Update Short Link

Update the destination URL of an existing short link

PUT /links/:id

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.new-destination.com"}' \
-X PUT https://api.ayrshare.com/api/links/TkuWEy

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/links/TkuWEy", {
      method: "PUT",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        url: "https://www.new-destination.com", // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'url': 'https://www.new-destination.com'}
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY'}

r = requests.put('https://api.ayrshare.com/api/links/TkuWEy',
    json=payload,
    headers=headers)

print(r.json())

require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'PUT',
    'https://api.ayrshare.com/api/links/TkuWEy',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'url' => 'https://www.new-destination.com',
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

200: Success

{
    "status": "success",
    "id": "TkuWEy",
    "originalUrl": "https://www.new-destination.com",
    "shortUrl": "https://ayrs.io/TkuWEy",
    "created": "2023-07-17T15:20:51.118Z",
    "updated": "2024-01-10T12:30:00.000Z"
}

{
  "action": "request",
  "status": "error",
  "code": 126,
  "message": "Shorten URL failed. Please verify the URL is properly formatted and the correct UTM parameters are used."
}

{
  "action": "link",
  "status": "error",
  "code": 418,
  "message": "Link not found or not owned by user."
}

Update the destination URL of an existing short link. The short link ID is returned when you first create a short link via POST /links.

Social Media Preview Caching: Social media platforms cache Open Graph preview cards from the original destination URL. After updating a short link, the preview card shown on social platforms may not match the new destination until the cache expires.

Header Parameters

Path Parameters

id · string · required

The short link ID returned from POST /links (e.g., “TkuWEy”).

Body Parameters

url · string · required

The new destination URL. Must be a valid URL starting with https://

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.new-destination.com"}' \
-X PUT https://api.ayrshare.com/api/links/TkuWEy

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/links/TkuWEy", {
      method: "PUT",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        url: "https://www.new-destination.com", // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'url': 'https://www.new-destination.com'}
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY'}

r = requests.put('https://api.ayrshare.com/api/links/TkuWEy',
    json=payload,
    headers=headers)

print(r.json())

require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'PUT',
    'https://api.ayrshare.com/api/links/TkuWEy',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'url' => 'https://www.new-destination.com',
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

200: Success

{
    "status": "success",
    "id": "TkuWEy",
    "originalUrl": "https://www.new-destination.com",
    "shortUrl": "https://ayrs.io/TkuWEy",
    "created": "2023-07-17T15:20:51.118Z",
    "updated": "2024-01-10T12:30:00.000Z"
}

{
  "action": "request",
  "status": "error",
  "code": 126,
  "message": "Shorten URL failed. Please verify the URL is properly formatted and the correct UTM parameters are used."
}

{
  "action": "link",
  "status": "error",
  "code": 418,
  "message": "Link not found or not owned by user."
}