Apps

Create an app

post/apps

Request

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

Request body

namestring required
ios_bundle_idstring

Reverse-domain notation, e.g. com.example.myapp

ios_team_idstring

Apple Team ID, e.g. ABCDE12345

ios_app_store_idstring

Numeric App Store ID

ios_app_store_urlstring uri
ios_universal_link_pathsstring[]
android_package_namestring

Java package name, e.g. com.example.myapp

android_sha256_fingerprintsstring[]
android_play_store_urlstring uri
android_app_links_pathsstring[]
link_handlestring

The app's link subdomain, as in link_handle.aplnk.to. 3 to 30 characters: lowercase letters, numbers and hyphens, not starting or ending with a hyphen. Reserved names such as www, api, app and docs are refused. Defaults to a name derived from the app name, with a suffix added if that name is taken. Uppercase letters are accepted and stored in lowercase. A value you send that another app already holds returns 409 APP_HANDLE_TAKEN, and one that was just released returns 409 APP_HANDLE_HELD with details.available_at.

Response

App created

idstring uuid
org_idstring uuid
namestring
ios_bundle_idstring nullable
ios_team_idstring nullable
ios_app_store_idstring nullable
ios_app_store_urlstring uri nullable
ios_universal_link_pathsstring[] nullable
android_package_namestring nullable
android_sha256_fingerprintsstring[] nullable
android_play_store_urlstring uri nullable
android_app_links_pathsstring[] nullable
icon_urlstring uri nullable
icon_source'auto' | 'manual'
probabilistic_matchingboolean

False means routing-only mode: the server no longer matches installs by probabilistic match or raw device signals for this app. Deep links keep working, and deferred links and attribution use only deterministic signals (the Android Play Install Referrer click id, and a device that already has an install). Defaults to true.

link_handlestring

The lowercase subdomain label for this app's links, for example acme in acme.aplnk.to. Every app has one.

link_domainstring

The full host derived from link_handle, for example acme.aplnk.to.

legacy_apex_enabledboolean

True for an app that existed when app subdomains launched. Its links on aplnk.to keep working and aplnk.to keeps listing the app for good.

default_link_domainstring

The domain a new link gets when a create request names none: the saved default, or link_domain when none is saved. Change it with PUT /v1/apps/{id}/link-domain. It never changes a link that already exists.

default_link_domain_availableboolean

False when the saved default is a custom domain that is no longer live. A link created with no domain then gets 409 DEFAULT_DOMAIN_UNAVAILABLE until you choose a domain or a new default.

allowed_link_domainsstring[]

The hostnames a new link for this app may use: the default first when it is available, then aplnk.to (legacy apps only), link_domain and the org's live custom domains.

previous_link_handlestring nullable

The app's old subdomain label while a rename period is open. null otherwise.

previous_link_domainstring nullable

The full old host while a rename period is open, for example oldname.aplnk.to. It keeps opening the app.

rename_period_ends_atstring date-time nullable

The date shown for the open rename period. It is not a deadline and not a promise to move links that day. If links on the old subdomain later move to the new one, their old URLs redirect. null when no period is open.

rename_period_extensionsinteger

How many times the open rename period was extended by 1 month. At most 2.

created_atstring date-time
updated_atstring date-time

Changes

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