Skip to content

Variables

Every route on this page needs the variables scope. See Variables for how clients use them.

GET/seller/v1/variablesscope: variables
Query Notes
app_id Your token’s app
200 OK
{
"ok": true,
"data": {
"items": [
{
"id": "var_342c8c7e97e24ae1b79183b18d7011d5",
"app_id": "app_ea9745b1df9e4a9bacb22cb1c200993b",
"app_name": "My App",
"name": "download_url",
"free_access": 0,
"created_at": 1794497607,
"updated_at": 1794497607,
"tier_ids": ["tier_e26fe8d406f94e13bff9d10c9291c37f"],
"value": "https://example.com/build.zip",
"size": 29
}
],
"max_bytes": 131072
}
}

value is included up to 4 KB. For larger values it is null; read them with Get a variable. size is in bytes; max_bytes is the limit per value. An empty tier_ids means every active subscription.

GET/seller/v1/variablescope: variables
Query Required
variable_id yes
200 OK
{ "ok": true, "data": { "id": "var_342c8c7e97e24ae1b79183b18d7011d5", "name": "download_url", "value": "https://example.com/build.zip", "size": 29 } }
POST/seller/v1/variable/createscope: variables
Field Type Required Notes
app_id string yes
name string yes Letters, digits, _, ., -, up to 64
value string yes Text up to 128 KB (in bytes)
tier_ids string[] no Up to 100. Empty (default) = every active subscription
free_access boolean no Also open to free mode devices, and so to everyone signed in. Default false
Request
{
"app_id": "app_ea9745b1df9e4a9bacb22cb1c200993b",
"name": "download_url",
"value": "https://example.com/build.zip",
"tier_ids": ["tier_e26fe8d406f94e13bff9d10c9291c37f"]
}
201 Created
{ "ok": true, "data": { "id": "var_342c8c7e97e24ae1b79183b18d7011d5" } }

The id is what your app passes to FetchVariable.

POST/seller/v1/variable/updatescope: variables
Field Type Required Notes
variable_id string yes
value string no New value
tier_ids string[] no Replaces the list
free_access boolean no
200 OK
{ "ok": true, "data": { "updated": true } }

Running clients get the new value the next time they fetch it.

POST/seller/v1/variable/deletescope: variables
Request
{ "variable_id": "var_342c8c7e97e24ae1b79183b18d7011d5" }
200 OK
{ "ok": true, "data": { "deleted": true } }