URL Management

Update URL Status

Quickly toggle a shortened URL’s status between ACTIVE and INACTIVE without modifying other properties.

Authentication: Required (JWT token or session cookie)

API Key: Required (must have urls:manage or admin:all scope)

Rate Limits: 60/min, 5000/day

Ownership: Can only update URLs owned by your account

Status Values:

ACTIVE - URL is accessible and redirects normally
INACTIVE - URL is disabled and returns an error page

Use Cases:

Temporarily disable a URL without deleting it
Quickly pause/resume campaigns or promotions
Preserve analytics data while preventing access
Bulk status management for multiple URLs

Note: This is a convenience endpoint. You can also update status using the main PATCH /urls/ endpoint.

PATCH

urls

{url_id}

status

Update URL Status

curl --request PATCH \
  --url https://spoo.me/api/v1/urls/{url_id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACTIVE"
}
'

{
  "id": "<string>",
  "alias": "<string>",
  "long_url": "<string>",
  "status": "ACTIVE",
  "password_set": true,
  "max_clicks": 123,
  "expire_after": 123,
  "block_bots": true,
  "private_stats": true,
  "updated_at": 123
}

Authorizations

Authorization

string

header

required

API key in format: spoo_. Use in Authorization header as 'Bearer spoo_'

Path Parameters

url_id

string

required

MongoDB ObjectId of the URL

Body

application/json

status

enum<string>

required

New status for the URL

Available options:

ACTIVE,

INACTIVE

Response

URL status updated successfully

string

alias

string

long_url

string<uri>

status

enum<string>

Available options:

ACTIVE,

INACTIVE

password_set

boolean

max_clicks

integer | null

expire_after

integer | null

block_bots

boolean

private_stats

boolean

updated_at

integer

Unix timestamp

Delete URLPermanently remove a shortened URL from the database. This action is **irreversible** and will delete all associated analytics data. **Authentication**: Required (JWT token or session cookie) **API Key**: Required (must have `urls:manage` or `admin:all` scope) **Rate Limits**: 60/min, 5000/day **Ownership**: Can only delete URLs owned by your account **Important Consequences**: - The short URL will become immediately unavailable - All click statistics and analytics data will be permanently deleted - The alias/short code will become available for reuse - This operation cannot be undone **Alternative**: Consider setting `status` to `INACTIVE` instead if you want to preserve the URL and its analytics for future reference.

⌘I

Update URL Status

curl --request PATCH \
  --url https://spoo.me/api/v1/urls/{url_id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACTIVE"
}
'

{
  "id": "<string>",
  "alias": "<string>",
  "long_url": "<string>",
  "status": "ACTIVE",
  "password_set": true,
  "max_clicks": 123,
  "expire_after": 123,
  "block_bots": true,
  "private_stats": true,
  "updated_at": 123
}

Getting Started

API v1 Reference

API v0 Reference (Legacy)

Tools & Libraries

Self Hosting

Update URL Status

Authorizations

Path Parameters

Body

Response