Update Short URL
Short URLs
Update Short URL
Update an existing short URL properties including alias, domain, and settings
PUT
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
The short code, custom alias, or UUID of the short URL to update.Examples:
abc123, my-campaign, 550e8400-e29b-41d4-a716-446655440000Body Parameters
URL Settings
Update the destination URL. Must be a valid HTTP or HTTPS URL.
Update the friendly name (1-255 characters).
Update or set expiration date (ISO 8601 format). Pass
null to remove expiration.Example: 2025-12-31T23:59:59.000ZEnable or disable analytics tracking. See Analytics API for click data.
Custom Alias
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
Domain Settings
Change the URL type:
standard, subdomain, or branded.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.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
Associate with a different campaign (UUID), or pass
null to remove from campaign.See List Campaigns to find campaign IDs.Set or update password protection. Pass
null to remove password.Whether the short URL should be dynamic (302 redirect) or standard (301 redirect).
- Standard (false): Uses a 301 Permanent Redirect. Best for SEO and speed, but the original URL cannot be changed once created.
- Dynamic (true): Uses a 302 Temporary Redirect. Allows you to change the destination URL at any time without changing the short URL.
Generate a new QR code for the updated short URL. If true, the QR code will encode the current short URL with
isshortqrscan=1 appended.The format for the returned QR code.
image: Returns a native image block (recommended for API/MCP) or base64 data URL.json: Returns just the base64 data URL in the JSON response.
Updated list of categorization tags.Example:
["marketing", "social", "q4-2024"]Request Examples
- cURL
- Node.js
- TypeScript
- Python
- PHP
- Go
- Java
- Update Destination
- Change Alias
- Move to Subdomain
- Move to Branded
- Add to Campaign
Response Examples
- 200 Success
- 200 Moved to Subdomain
- 200 Moved to Branded
- 409 Alias Conflict
- 403 Access Denied
- 403 Domain Not Owned
- 404 Not Found
Use Cases
A/B Testing Destinations
A/B Testing Destinations
Quickly swap destinations to test different landing pages:
Temporary Campaign Links
Temporary Campaign Links
Set expiration dates for time-limited promotions:
Moving to Branded Domain
Moving to Branded Domain
Migrate a link from standard to your branded domain:
Organize with Campaigns
Organize with Campaigns
Add or remove links from campaigns:
Update Alias Safely
Update Alias Safely
Check availability before changing an alias:
Related Endpoints
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