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
}
'

PUT

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 Alias
Move to Branded

# 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"
  }'

# Move 'promo' from standard to branded domain
curl -X PUT "https://jmpy.me/api/v1/short-urls/promo" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url_type": "branded",
    "branded_domain": "links.mybrand.com"
  }'

Rename Alias

const fetch = require('node-fetch');

const currentAlias = 'summer24';
const response = await fetch(`https://jmpy.me/api/v1/short-urls/${currentAlias}`, {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    custom_alias: 'summer-sale-ended',
    url: 'https://example.com/sale-over'
  })
});
const data = await response.json();

Rename Alias

import axios from 'axios';

const currentAlias = 'summer24';
const response = await axios.put(
  `https://jmpy.me/api/v1/short-urls/${currentAlias}`,
  {
    custom_alias: 'summer-sale-ended',
    url: 'https://example.com/sale-over'
  },
  { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);

Rename Alias

import requests

alias = "summer24"
url = f"https://jmpy.me/api/v1/short-urls/{alias}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
data = {
    "custom_alias": "summer-sale-ended",
    "url": "https://example.com/sale-over"
}

response = requests.put(url, headers=headers, json=data)

Rename Alias

<?php
$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://jmpy.me/api/v1/short-urls/summer24', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'custom_alias' => 'summer-sale-ended',
        'url' => 'https://example.com/sale-over'
    ]
]);
?>

Rename Alias

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func main() {
    targetUrl := "https://jmpy.me/api/v1/short-urls/summer24"
    data := map[string]string{
        "custom_alias": "summer-sale-ended",
        "url":          "https://example.com/sale-over",
    }
    jsonData, _ := json.Marshal(data)

    req, _ := http.NewRequest("PUT", targetUrl, bytes.NewBuffer(jsonData))
    req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
    req.Header.Add("Content-Type", "application/json")

    http.DefaultClient.Do(req)
}

Rename Alias

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;

String jsonInfo = """
{
    "custom_alias": "summer-sale-ended",
    "url": "https://example.com/sale-over"
}""";

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://jmpy.me/api/v1/short-urls/summer24"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .PUT(HttpRequest.BodyPublishers.ofString(jsonInfo))
    .build();
client.send(request, HttpResponse.BodyHandlers.ofString());

Response Examples

200 OK
409 Conflict
404 Not Found

{
  "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"
  }
}

{
  "success": false,
  "error": {
    "code": "ALIAS_EXISTS",
    "message": "Custom alias 'summer-sale-ended' already exists"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Short URL not found"
  }
}

Use Cases

Correcting Typos

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

Recycling Links

Keep the same printed QR code or shared link active, but update the destination URL or alias for a new campaign season.

Create Alias

Create a new short URL with a custom alias

Delete Alias

Remove an alias permanently

Get by Alias Delete Alias

​Path Parameters

​Body Parameters

​Request Examples

​Response Examples

​Use Cases

​Related Endpoints

Create Alias

Delete Alias

Path Parameters

Body Parameters

Request Examples

Response Examples

Use Cases

Related Endpoints