Link Management

Update URL

Update an existing URL’s properties.

Partially update a shortened URL. Only provided fields are modified; omitted fields remain unchanged. Pass null to remove optional settings like password, max_clicks, or expire_after.

Authentication: Required — you must own the URL.

API Key Scope: urls:manage or admin:all

Rate Limits: 120/min, 2,000/day

Updatable Fields: long_url, alias, password, block_bots, max_clicks, expire_after, private_stats, status

Notes:

Setting max_clicks to 0 or null removes the click limit
Changing the alias checks availability and may fail with 409 Conflict
The url_id is the MongoDB ObjectId, not the alias

PATCH

api

urls

{url_id}

Update URL

curl --request PATCH \
  --url https://spoo.me/api/v1/urls/{url_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "long_url": "https://example.com/updated/url",
  "alias": "newlink",
  "password": "newPass@456",
  "block_bots": true,
  "max_clicks": 500,
  "expire_after": "2025-12-31T23:59:59Z",
  "private_stats": true,
  "status": "ACTIVE"
}
'

import requests

url = "https://spoo.me/api/v1/urls/{url_id}"

payload = {
    "long_url": "https://example.com/updated/url",
    "alias": "newlink",
    "password": "newPass@456",
    "block_bots": True,
    "max_clicks": 500,
    "expire_after": "2025-12-31T23:59:59Z",
    "private_stats": True,
    "status": "ACTIVE"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    long_url: 'https://example.com/updated/url',
    alias: 'newlink',
    password: 'newPass@456',
    block_bots: true,
    max_clicks: 500,
    expire_after: '2025-12-31T23:59:59Z',
    private_stats: true,
    status: 'ACTIVE'
  })
};

fetch('https://spoo.me/api/v1/urls/{url_id}', 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://spoo.me/api/v1/urls/{url_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'long_url' => 'https://example.com/updated/url',
    'alias' => 'newlink',
    'password' => 'newPass@456',
    'block_bots' => true,
    'max_clicks' => 500,
    'expire_after' => '2025-12-31T23:59:59Z',
    'private_stats' => true,
    'status' => 'ACTIVE'
  ]),
  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://spoo.me/api/v1/urls/{url_id}"

	payload := strings.NewReader("{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://spoo.me/api/v1/urls/{url_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spoo.me/api/v1/urls/{url_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "password_set": true,
  "updated_at": 123,
  "alias": "mylink",
  "long_url": "https://example.com/long/url",
  "status": "ACTIVE",
  "max_clicks": 100,
  "expire_after": 1735689599,
  "block_bots": true,
  "private_stats": true
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your key as: Bearer spoo_<your_key>

Path Parameters

url_id

string

required

Unique identifier of the URL

Body

application/json

Request body for partially updating an existing shortened URL.

All fields are optional; only provided fields are updated. Pass max_clicks=0 or max_clicks=null to remove the limit. Pass password=null (or omit) to remove password protection.

long_url

string | null

New destination URL. Must be a valid http:// or https:// URL.

Example:

"https://example.com/updated/url"

alias

string | null

New custom short code. Pass null to keep existing. Must be unique and available.

Example:

"newlink"

password

string | null

New password. Pass null to remove password protection.

Example:

"newPass@456"

block_bots

boolean | null

Block known bot user agents. Pass null to keep existing setting.

max_clicks

integer | null

New click limit. Pass 0 or null to remove the limit.

Required range: x >= 0

Example:

500

expire_after

Expiration time. ISO 8601 string (e.g. 2025-12-31T23:59:59Z) or Unix epoch seconds (e.g. 1735689599). Pass null to remove.

Example:

"2025-12-31T23:59:59Z"

private_stats

boolean | null

Make statistics private (only owner can view). Pass null to keep existing.

status

enum<string> | null

URL status. ACTIVE enables redirects, INACTIVE disables them.

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

Response

Successful Response

Response body after a successful URL update (PATCH /api/v1/urls/{url_id}).

string

required

MongoDB ObjectId of the URL.

Example:

"507f1f77bcf86cd799439011"

password_set

boolean

required

Whether the URL is password-protected.

updated_at

integer

required

Last update time as Unix timestamp.

Example:

1704067200

alias

string | null

Short code.

Example:

"mylink"

long_url

string | null

Destination URL.

Example:

"https://example.com/long/url"

status

string | null

URL status.

Example:

"ACTIVE"

max_clicks

integer | null

Click limit, or null if unlimited.

Example:

100

expire_after

integer | null

Expiration as Unix timestamp, or null.

Example:

1735689599

block_bots

boolean | null

Whether bot blocking is enabled.

private_stats

boolean | null

Whether statistics are private.

Update URL StatusUpdate only the status of a URL (ACTIVE / INACTIVE). Toggle a URL between active and inactive without modifying other properties. **Authentication**: Required — you must own the URL. **API Key Scope**: `urls:manage` or `admin:all` **Rate Limits**: 120/min, 2,000/day **Status Values**: - `ACTIVE` — URL is accessible and redirects normally - `INACTIVE` — URL is disabled and returns an error page **Use Cases**: - Set `INACTIVE` to temporarily disable redirects without deleting the URL - Set `ACTIVE` to re-enable a previously disabled URL

Update URL

curl --request PATCH \
  --url https://spoo.me/api/v1/urls/{url_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "long_url": "https://example.com/updated/url",
  "alias": "newlink",
  "password": "newPass@456",
  "block_bots": true,
  "max_clicks": 500,
  "expire_after": "2025-12-31T23:59:59Z",
  "private_stats": true,
  "status": "ACTIVE"
}
'

import requests

url = "https://spoo.me/api/v1/urls/{url_id}"

payload = {
    "long_url": "https://example.com/updated/url",
    "alias": "newlink",
    "password": "newPass@456",
    "block_bots": True,
    "max_clicks": 500,
    "expire_after": "2025-12-31T23:59:59Z",
    "private_stats": True,
    "status": "ACTIVE"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    long_url: 'https://example.com/updated/url',
    alias: 'newlink',
    password: 'newPass@456',
    block_bots: true,
    max_clicks: 500,
    expire_after: '2025-12-31T23:59:59Z',
    private_stats: true,
    status: 'ACTIVE'
  })
};

fetch('https://spoo.me/api/v1/urls/{url_id}', 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://spoo.me/api/v1/urls/{url_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'long_url' => 'https://example.com/updated/url',
    'alias' => 'newlink',
    'password' => 'newPass@456',
    'block_bots' => true,
    'max_clicks' => 500,
    'expire_after' => '2025-12-31T23:59:59Z',
    'private_stats' => true,
    'status' => 'ACTIVE'
  ]),
  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://spoo.me/api/v1/urls/{url_id}"

	payload := strings.NewReader("{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://spoo.me/api/v1/urls/{url_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spoo.me/api/v1/urls/{url_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"long_url\": \"https://example.com/updated/url\",\n  \"alias\": \"newlink\",\n  \"password\": \"newPass@456\",\n  \"block_bots\": true,\n  \"max_clicks\": 500,\n  \"expire_after\": \"2025-12-31T23:59:59Z\",\n  \"private_stats\": true,\n  \"status\": \"ACTIVE\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "password_set": true,
  "updated_at": 123,
  "alias": "mylink",
  "long_url": "https://example.com/long/url",
  "status": "ACTIVE",
  "max_clicks": 100,
  "expire_after": 1735689599,
  "block_bots": true,
  "private_stats": true
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": "<string>",
  "error_code": "<string>",
  "field": "<string>",
  "details": null
}

Getting Started

API v1 Reference

API v0 Reference (Legacy)

Tools & Libraries

Self Hosting

Update URL

Authorizations

Path Parameters

Body

Response