v1

latestOpenAPI 3.1.02026-07-265314114.3 KB
Variables

Create Variable

Cria uma nova variável (campo personalizado).

post/app/variable

Request body

namestring required

Identificador único da variável. Apenas letras, números, - e _

descriptionstring required

Descrição exibida para o cliente no momento do preenchimento

type'SELECT' | 'NUMBER' | 'TEXT' | 'ROBLOX' required

Tipo da variável: SELECT, NUMBER, TEXT ou ROBLOX

requiredboolean

Se o preenchimento é obrigatório (padrão: true para variáveis de pacote)

regexstring

Expressão regular para validação do valor informado pelo cliente

checkout_variableboolean

Se true, a variável será exibida no checkout ao invés de no pacote

applies_tonumber[]

IDs dos pacotes aos quais a variável de checkout se aplica (apenas quando checkout_variable é true)

Response

Variável criada

idnumber

ID único da variável

store_idnumber

ID da loja

namestring

Identificador da variável (usado em comandos como {nome_variavel})

descriptionstring

Descrição da variável exibida para o cliente

type'SELECT' | 'NUMBER' | 'TEXT' | 'ROBLOX'

Tipo da variável (SELECT, NUMBER, TEXT, ROBLOX)

requiredboolean

Se o preenchimento é obrigatório

regexstring nullable

Expressão regular para validação do campo

applies_tonumber[] nullable

IDs dos pacotes aos quais a variável de checkout se aplica

bracket_displaystring

Nome formatado para uso em comandos (ex: {nickname})

displaystring

Nome formatado para exibição