Update Short URL

Update the properties of an existing short URL. You can modify the destination URL, name, expiration, custom alias, domain settings, and more. Only the fields you include in the request body will be updated.

Custom Alias Updates: You can change the custom alias of an existing URL. The new alias must be available within the URL’s domain context. Use the Check Alias Availability endpoint to verify availability first.

Path Parameters

shortCode

string

required

The short code, custom alias, or UUID of the short URL to update.Examples: abc123, my-campaign, 550e8400-e29b-41d4-a716-446655440000

Body Parameters

URL Settings

url

string

Update the destination URL. Must be a valid HTTP or HTTPS URL.

name

string

Update the friendly name (1-255 characters).

expires_at

string

Update or set expiration date (ISO 8601 format). Pass null to remove expiration.Example: 2025-12-31T23:59:59.000Z

tracking_enabled

boolean

Enable or disable analytics tracking. See Analytics API for click data.

Custom Alias

custom_alias

string

Update the custom alias. The new alias must be:

3-50 characters
Alphanumeric with underscores or dashes only
Unique within the URL’s domain context

Changing the alias will change the short URL. Existing links using the old alias will stop working. Make sure to update any published links.

Use Check Alias Availability to verify the new alias is available before updating.

Domain Settings

url_type

string

Change the URL type: standard, subdomain, or branded.

Changing the URL type will change the short URL domain. This is a significant change - existing links will stop working.

subdomain

string

Change to a different subdomain (when url_type is subdomain). Must be a verified subdomain you own.See List Subdomains to view your registered subdomains.

branded_domain

string

Change to a different branded domain (when url_type is branded). Must be a verified domain you own.See List Branded Domains to view your registered domains.

Organization

campaign_id

string

Associate with a different campaign (UUID), or pass null to remove from campaign.See List Campaigns to find campaign IDs.

password

string

Set or update password protection. Pass null to remove password.

Request Examples

Update Destination
Change Alias
Move to Subdomain
Move to Branded
Add to Campaign

curl -X PUT "https://jmpy.me/api/v1/short-urls/my-campaign" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Campaign Link",
    "url": "https://example.com/new-destination",
    "expires_at": "2025-12-31T23:59:59Z"
  }'

# Check availability first: /api-reference/custom-aliases/check
curl -X PUT "https://jmpy.me/api/v1/short-urls/old-alias" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_alias": "new-alias"
  }'

# Requires a registered subdomain
# See: /api-reference/domains/create-subdomain
curl -X PUT "https://jmpy.me/api/v1/short-urls/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url_type": "subdomain",
    "subdomain": "marketing"
  }'

# Requires a verified branded domain
# See: /api-reference/domains/create-branded
curl -X PUT "https://jmpy.me/api/v1/short-urls/my-link" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url_type": "branded",
    "branded_domain": "go.mycompany.com"
  }'

# See: /api-reference/campaigns/list to find campaign IDs
curl -X PUT "https://jmpy.me/api/v1/short-urls/my-link" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

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

const shortCode = 'my-campaign';

const response = await fetch(`https://jmpy.me/api/v1/short-urls/${shortCode}`, {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Updated Campaign Link',
    url: 'https://example.com/new-destination',
    tracking_enabled: true,
    expires_at: '2025-12-31T23:59:59Z'
  })
});

const { data } = await response.json();
console.log(`Updated: ${data.short_url}`);

import axios from 'axios';

interface UpdateRequest {
  name?: string;
  url?: string;
  custom_alias?: string;
  url_type?: 'standard' | 'subdomain' | 'branded';
  subdomain?: string;
  branded_domain?: string;
  expires_at?: string | null;
  campaign_id?: string | null;
  tracking_enabled?: boolean;
}

const shortCode = 'my-campaign';
const updates: UpdateRequest = {
  name: 'Updated Campaign Link',
  url: 'https://example.com/new-destination',
  expires_at: '2025-12-31T23:59:59Z'
};

const response = await axios.put(
  `https://jmpy.me/api/v1/short-urls/${shortCode}`,
  updates,
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(`Updated: ${response.data.data.short_url}`);

import requests

short_code = "my-campaign"

response = requests.put(
    f"https://jmpy.me/api/v1/short-urls/{short_code}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "name": "Updated Campaign Link",
        "url": "https://example.com/new-destination",
        "custom_alias": "new-campaign-name"
    }
)

result = response.json()
print(f"Updated: {result['data']['short_url']}")

<?php
$shortCode = 'my-campaign';

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', "https://jmpy.me/api/v1/short-urls/{$shortCode}", [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'name' => 'Updated Campaign Link',
        'url' => 'https://example.com/new-destination',
        'expires_at' => '2025-12-31T23:59:59Z'
    ]
]);

$data = json_decode($response->getBody(), true);
echo "Updated: " . $data['data']['short_url'];
?>

package main

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

func main() {
    shortCode := "my-campaign"
    url := fmt.Sprintf("https://jmpy.me/api/v1/short-urls/%s", shortCode)
    
    data := map[string]interface{}{
        "name":       "Updated Campaign Link",
        "url":        "https://example.com/new-destination",
        "expires_at": "2025-12-31T23:59:59Z",
    }
    jsonData, _ := json.Marshal(data)

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

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    fmt.Println("Short URL updated successfully")
}

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

String shortCode = "my-campaign";
String json = """
{
    "name": "Updated Campaign Link",
    "url": "https://example.com/new-destination",
    "expires_at": "2025-12-31T23:59:59Z"
}""";

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

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response Examples

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "short_code": "new-alias",
    "short_url": "https://jmpy.me/new-alias",
    "original_url": "https://example.com/new-destination",
    "name": "Updated Campaign Link",
    "custom_alias": "new-alias",
    "click_count": 1542,
    "tracking_enabled": true,
    "url_type": "standard",
    "subdomain": null,
    "branded_domain": null,
    "expires_at": "2025-12-31T23:59:59.000Z",
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-21T09:15:00.000Z"
  }
}

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "short_code": "promo",
    "short_url": "https://marketing.jmpy.me/promo",
    "original_url": "https://example.com/page",
    "name": "Marketing Promo",
    "custom_alias": "promo",
    "click_count": 256,
    "tracking_enabled": true,
    "url_type": "subdomain",
    "subdomain": "marketing",
    "branded_domain": null,
    "expires_at": null,
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-21T09:15:00.000Z"
  }
}

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "short_code": "careers",
    "short_url": "https://go.mycompany.com/careers",
    "original_url": "https://mycompany.com/careers",
    "name": "Careers Page",
    "custom_alias": "careers",
    "click_count": 1024,
    "tracking_enabled": true,
    "url_type": "branded",
    "subdomain": null,
    "branded_domain": "go.mycompany.com",
    "expires_at": null,
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-21T09:15:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "ALIAS_EXISTS",
    "message": "Custom alias 'new-alias' already exists on jmpy.me",
    "details": {
      "field": "custom_alias",
      "context": {
        "url_type": "standard",
        "subdomain": null,
        "branded_domain": null
      }
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "Access denied"
  }
}

{
  "success": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "You do not own this subdomain or it is not verified"
  }
}

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

Use Cases

A/B Testing Destinations

Quickly swap destinations to test different landing pages:

async function updateDestination(shortCode, newUrl) {
  const response = await fetch(
    `https://jmpy.me/api/v1/short-urls/${shortCode}`,
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({ url: newUrl })
    }
  );
  
  const { data } = await response.json();
  console.log(`Updated ${data.short_url} → ${data.original_url}`);
}

// Switch to version B
await updateDestination('promo', 'https://example.com/landing-page-v2');

// Check analytics: /api-reference/analytics/url-overview

Temporary Campaign Links

Set expiration dates for time-limited promotions:

# Set link to expire at end of sale
curl -X PUT "https://jmpy.me/api/v1/short-urls/sale" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expires_at": "2024-12-25T23:59:59Z"}'

# Remove expiration
curl -X PUT "https://jmpy.me/api/v1/short-urls/sale" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expires_at": null}'

Moving to Branded Domain

Migrate a link from standard to your branded domain:

import requests

# First, ensure you have a verified branded domain
# See: /api-reference/domains/create-branded

short_code = "my-link"

response = requests.put(
    f"https://jmpy.me/api/v1/short-urls/{short_code}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "url_type": "branded",
        "branded_domain": "go.mycompany.com"
    }
)

result = response.json()
print(f"New URL: {result['data']['short_url']}")
# Output: New URL: https://go.mycompany.com/my-link

Organize with Campaigns

Add or remove links from campaigns:

// Add to campaign
// First, find campaign ID: /api-reference/campaigns/list
await fetch('https://jmpy.me/api/v1/short-urls/my-link', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaign_id: '550e8400-e29b-41d4-a716-446655440000'
  })
});

// Remove from campaign
await fetch('https://jmpy.me/api/v1/short-urls/my-link', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaign_id: null  // Pass null to remove
  })
});

Update Alias Safely

Check availability before changing an alias:

async function safelyUpdateAlias(currentAlias, newAlias, urlType = 'standard') {
  // Step 1: Check if new alias is available
  // See: /api-reference/custom-aliases/check
  const checkResponse = await fetch(
    `https://jmpy.me/api/v1/short-urls/check-alias?alias=${newAlias}&url_type=${urlType}`,
    { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
  );
  const { data: checkData } = await checkResponse.json();
  
  if (!checkData.available) {
    throw new Error(`Alias "${newAlias}" is already taken`);
  }
  
  // Step 2: Update the alias
  const updateResponse = 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: newAlias })
    }
  );
  
  const { data } = await updateResponse.json();
  console.log(`Alias updated: ${data.short_url}`);
}

Get Short URL

View current short URL details

Check Alias

Verify alias availability before updating

Delete Short URL

Remove a short URL permanently

URL Analytics

View click analytics for this URL

List Campaigns

Find campaign IDs for association

List Domains

View available domains for migration

API Reference

Short URLs

Custom Aliases

QR Codes

Domains

Campaigns

Short URL Analytics

QR Code Analytics

Short URL A/B Testing

QR Code A/B Testing

Path Parameters

Body Parameters

URL Settings

Custom Alias

Domain Settings

Organization

Request Examples

Response Examples

Use Cases

Get Short URL

Check Alias

Delete Short URL

URL Analytics

List Campaigns

List Domains

API Reference

Short URLs

Custom Aliases

QR Codes

Domains

Campaigns

Short URL Analytics

QR Code Analytics

Short URL A/B Testing

QR Code A/B Testing

​Path Parameters

​Body Parameters

​URL Settings

​Custom Alias

​Domain Settings

​Organization

​Request Examples

​Response Examples

​Use Cases

​Related Endpoints

Get Short URL

Check Alias

Delete Short URL

URL Analytics

List Campaigns

List Domains

Path Parameters

Body Parameters

URL Settings

Custom Alias

Domain Settings

Organization

Request Examples

Response Examples

Use Cases

Related Endpoints