PUT
https://jmpy.me/api/v1
/
short-urls
/
{alias}
Update Alias
curl --request PUT \
  --url https://jmpy.me/api/v1/short-urls/{alias} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_alias": "<string>",
  "url": "<string>",
  "url_type": "<string>",
  "subdomain": "<string>",
  "branded_domain": "<string>",
  "name": "<string>",
  "expires_at": "<string>",
  "tracking_enabled": true
}
'
Update a short URL’s destination, properties, or rename the alias itself. You can also move a short URL between different domain contexts (e.g., from standard to branded).

Path Parameters

alias
string
required
The current custom alias (or short code) of the short URL.

Body Parameters

custom_alias
string
The new alias you want to set.Requirements:
  • 3-50 characters
  • Alphanumeric, underscores, or dashes
  • Must be unique in the target domain
url
string
Update the destination URL.
url_type
string
Change the URL context (Move to standard, subdomain, or branded).
subdomain
string
Required if moving to a subdomain context.
branded_domain
string
Required if moving to a branded domain context.
name
string
Update the friendly name.
expires_at
string
Update the expiration date (ISO 8601). Set to null to remove expiration.
tracking_enabled
boolean
Enable or disable analytics tracking.

Request Examples

# Rename 'summer24' to 'summer-sale-ended'
curl -X PUT "https://jmpy.me/api/v1/short-urls/summer24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_alias": "summer-sale-ended",
    "url": "https://example.com/sale-over"
  }'

Response Examples

{
  "success": true,
  "data": {
    "id": "...",
    "short_code": "summer-sale-ended",
    "custom_alias": "summer-sale-ended",
    "url_type": "standard",
    "full_url": "https://jmpy.me/summer-sale-ended",
    "original_url": "https://example.com/sale-over"
  }
}

Use Cases

If you accidentally created summmer-sale (3 ‘m’s), you can easily fix it without deleting and recreating.