Links

Create a link

post/links

Request

  • Base URL: https://api.warplink.app/v1
  • URL: https://api.warplink.app/v1/links
  • Auth: HTTP bearer

Request body

destination_urlstring uri required
slugstring

Custom slug. Auto-generated if omitted.

namestring

The link's name in the dashboard. Shows the slug if omitted.

domainstring

Domain to serve this link from. A link with an app defaults to the app's default_link_domain. A web-only link (no app) defaults to aplnk.to, and an existing link with no app keeps aplnk.to. A legacy app (legacy_apex_enabled) can use aplnk.to, its subdomain (link_domain) or a live custom domain. A new app can use its subdomain or a live custom domain, never aplnk.to (422 INVALID_DOMAIN). An explicit domain is never replaced. The slug test is reserved on an app subdomain. An app's previous subdomain (previous_link_domain) never takes new links.

ios_urlstring uri
ios_fallback_urlstring uri
android_urlstring uri
android_fallback_urlstring uri
og_titlestring
og_descriptionstring
og_image_urlstring uri
tagsstring[]
expires_atstring date-time

Must be in the future.

passwordstring
app_idstring uuid
utm_sourcestring

Added to the redirect URL as utm_source when no higher source supplies one. Order for utm_source: an injected utm_source in "always" mode wins; otherwise the visitor's own utm_source when parameters.forwarding passes it, then a utm_source already in the destination URL, then an injected utm_source in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

utm_mediumstring

Added to the redirect URL as utm_medium when no higher source supplies one. Order for utm_medium: an injected utm_medium in "always" mode wins; otherwise the visitor's own utm_medium when parameters.forwarding passes it, then a utm_medium already in the destination URL, then an injected utm_medium in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

utm_campaignstring

Added to the redirect URL as utm_campaign when no higher source supplies one. Order for utm_campaign: an injected utm_campaign in "always" mode wins; otherwise the visitor's own utm_campaign when parameters.forwarding passes it, then a utm_campaign already in the destination URL, then an injected utm_campaign in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

match_window_hoursinteger

Deferred deep link attribution match window in hours.

Response

Link created

idstring uuid
short_urlstring
slugstring
namestring nullable

The link's own name in the dashboard. Null shows the slug.

domainstring
destination_urlstring uri
ios_urlstring uri nullable
ios_fallback_urlstring uri nullable
android_urlstring uri nullable
android_fallback_urlstring uri nullable
og_titlestring nullable
og_descriptionstring nullable
og_image_urlstring uri nullable
app_idstring uuid nullable
utm_sourcestring nullable

Added to the redirect URL as utm_source when no higher source supplies one. Order for utm_source: an injected utm_source in "always" mode wins; otherwise the visitor's own utm_source when parameters.forwarding passes it, then a utm_source already in the destination URL, then an injected utm_source in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

utm_mediumstring nullable

Added to the redirect URL as utm_medium when no higher source supplies one. Order for utm_medium: an injected utm_medium in "always" mode wins; otherwise the visitor's own utm_medium when parameters.forwarding passes it, then a utm_medium already in the destination URL, then an injected utm_medium in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

utm_campaignstring nullable

Added to the redirect URL as utm_campaign when no higher source supplies one. Order for utm_campaign: an injected utm_campaign in "always" mode wins; otherwise the visitor's own utm_campaign when parameters.forwarding passes it, then a utm_campaign already in the destination URL, then an injected utm_campaign in "default" mode (this field is then not used), then this field. Applies to http and https URLs only; not to apps.apple.com, itunes.apple.com, play.google.com, apps.microsoft.com or custom-scheme URLs.

match_window_hoursinteger nullable
expires_atstring date-time nullable
is_activeboolean
tagsstring[]
created_atstring date-time
updated_atstring date-time

Example response

{
  "short_url": "https://aplnk.to/abc123",
  "slug": "abc123",
  "name": "Summer sale",
  "domain": "aplnk.to"
}

Changes

No recorded changes to this operation across all 1 revision of this API.