Raw schema
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "custom slug of 5 to 64 lowercase letters, digits or hyphens; omit for a random one"
},
"fallbackUrl": {
"type": "string",
"description": "http(s) page for desktop visitors and anyone without a matching target"
},
"title": {
"type": "string",
"description": "name shown in the dashboard, up to 200 characters"
},
"deeplinkUrl": {
"type": "string",
"description": "in-app URL that opens the installed app, for example acme://product/42"
},
"targets": {
"type": "object",
"description": "store or app page URL per platform; allowed keys: iphone, ipad, android, huawei, samsung (Galaxy Store), xiaomi (GetApps), rustore (RuStore, used for Android visitors in Russia)",
"additionalProperties": {
"type": "string"
}
},
"countryRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code of the visitor, for example RU; use GB for the United Kingdom"
},
"url": {
"type": "string",
"description": "http(s) store or page URL for Android visitors from that country"
}
},
"required": [
"country",
"url"
],
"additionalProperties": false
},
"description": "up to 50 rules, one per country, that send Android visitors from that country to their own URL; huawei, samsung and xiaomi targets still win, and a rule for RU wins over the rustore target"
},
"parameterForwarding": {
"type": "boolean",
"description": "pass the query string of each click on to the destination (Business and Enterprise)"
},
"socialPreview": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "headline of the preview card, up to 120 characters"
},
"description": {
"type": "string",
"description": "line under the headline, up to 300 characters"
},
"imageUrl": {
"type": "string",
"description": "https URL of the preview image, ideally 1200 x 630 pixels"
}
},
"description": "title, description and image that WhatsApp, iMessage, Slack, X, LinkedIn and other apps show when the link is shared; leave it out to show the destination's own preview",
"required": [
"title"
],
"additionalProperties": false
}
},
"required": [
"fallbackUrl"
],
"additionalProperties": false
}