Skip to main content
POST
Create a short link

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

Attributes for the new short link.

Target URL to shorten. Must be https:// — the short link is publicly resolvable and redirects any visitor here, so only pass URLs you trust; this endpoint is a common target for open-redirect and phishing abuse.

Pattern: ^https://
Example:

"https://your-site.com/long-url"

expiration_time
string<date-time>

Expiration date and time in ISO 8601 format.

Example:

"2023-07-19T18:18:34.235Z"

fallback_url
string<uri>

Fallback URL for expired or invalid links. Must be https:// — same open-redirect/phishing considerations as link apply.

Pattern: ^https://
Example:

"https://examples.com/fallback"

phone
string

Phone number the short link is associated with, in E.164 format (without the leading +). Used to attribute click metrics returned by short link metrics list.

Example:

"15155982927"

utm_campaign
string

UTM campaign name for tracking insights.

Example:

"summer_promo"

Response

Returns the created short link.

Generated short URL.

Example:

"https://wx.com/hd82Jhs21"