Skip to main content
PATCH
Update app link

Authorizations

X-API-Key
string
header
required

Path Parameters

Id of the app link.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload for PATCH /app-links/{link_id}. Only the keys present are applied.

The product is fixed at creation; delete and recreate to move a link.

platform
enum<string> | null

Where the app runs.

Available options:
ios,
android,
macos,
windows,
linux,
amazon,
huawei,
samsung,
web,
other
name
string | null

App name.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
url
string | null

Store listing or web app URL. Must start with https://.

Required string length: 9 - 500
Pattern: ^[Hh][Tt][Tt][Pp][Ss]://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,491}$
description
string | null

Short description.

Maximum string length: 500
Pattern: ^[^\x00]{0,500}$
minimum_version
string | null

Minimum app version the product needs.

Maximum string length: 50
Pattern: ^[^\x00]{0,50}$
is_required
boolean | null

Whether the product needs the app to work.

priority
integer | null

Display order on the hosted page (ascending).

Required range: 0 <= x <= 32767

Response

OK

An app link as read from the API. Mirrors :class:apps.products.models.AppLink.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
product_id
string<shortuuid>
required

The product this link is shown on.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

The product's GTIN, normalized to GTIN-14.

platform
enum<string>
required

Where the app runs.

Available options:
ios,
android,
macos,
windows,
linux,
amazon,
huawei,
samsung,
web,
other
name
string
required

App name.

url
string
required

Store listing or web app URL (https).

description
string
required

Short description. Empty string when unset.

minimum_version
string
required

Minimum app version the product needs. Empty string when unset.

is_required
boolean
required

Whether the product needs the app to work.

priority
integer
required

Display order on the hosted page (ascending).

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).