Apps

Every App the caller may see, with where it stands for this store.

The store's Meta pixel and conversions setup, or null when the Meta App is not set up. The access token is never returned — only a masked hint.

Sets up the Meta App, or changes its setup. conversionEvent is required — the merchant chooses whether conversions optimize for Lead (sent at order placement, deduplicated with the browser pixel) or a Purchase stage. An empty accessToken keeps the stored token; omitting perPageTrackingEnabled keeps the stored switch.

Forgets the App's setup and every key it holds, as if it had never been set up. Its Built-in Consumers stay, with nothing to send.

The store's DZVerify setup, or null when it is not set up (no phone check). The API key is never returned — only a masked hint.

Sets up DZVerify, or changes its setup. An empty apiKey keeps the stored key; with no key stored or sent, it is refused.

Forgets the App's setup and every key it holds, as if it had never been set up. Its Built-in Consumers stay, with nothing to send.

The store's Turnstile setup, or null when it is not set up (no bot check). The secret key is never returned — only a masked hint.

Sets up Turnstile, or changes its setup. An empty siteKey or secretKey keeps the stored one; with either missing altogether, it is refused.

Forgets the App's setup and every key it holds, as if it had never been set up. Its Built-in Consumers stay, with nothing to send.

The store's Sendili setup, or null when it is not set up (the store sends no email). The API key is never returned — only a masked hint.

Sets up Sendili, or changes its setup. An empty apiKey keeps the stored key; with no key stored or sent, it is refused.

Forgets the App's setup and every key it holds, as if it had never been set up. Its Built-in Consumers stay, with nothing to send.

The storefront's WhatsApp button. A store that never set it up gets the defaults, which are 'no button' — nothing renders until a number is saved and the button is switched on.

Replaces the whole configuration — a key you omit takes its default rather than keeping the stored value, so what the screen shows is what the store gets.

The number is normalised here, once. Send it however the merchant typed it; it is stored in E.164 and every reader downstream sees the same string.

Switching the button on without a number is refused (PHONE_REQUIRED): it would leave the merchant looking at an "on" switch and a storefront with no button.

Unknown keys are refused rather than ignored, so a typo cannot silently vanish. Every problem is reported at once in context.issues.

Saving the defaults clears the stored configuration entirely, as removing the App does.

Turning every surface off is accepted — it is a deliberate "paused" state and keeps the merchant's text.

Forgets the App's setup and every key it holds, as if it had never been set up. Its Built-in Consumers stay, with nothing to send.

Checks the stored (or sent) dzverify API key against the provider's quota. A key lacking the usage:read scope is valid with its quota unavailable. A refusal is a 200 with ok: false — the check itself worked.

Checks the stored (or sent) Sendili API key and answers the verified sending domains for the from-address picker. A refusal is a 200 with ok: false — the check itself worked.

The translatable fields in the store's primary language and every stored translation, each flagged outdated when its source text changed after it was written.

A JSON Merge Patch (RFC 7396) of one language: a string sets a field, null removes its translation, other fields are untouched. The language must be one the store has added, and not its primary — the resource's own fields hold that.

The store's bot, its connected chat, which events it tells and in which language, or null before a bot was ever saved. The token is never returned — only a masked hint.

Which events the bot tells, in which language, and on or off. A change of events applies to what is recorded from then on.

Asks Telegram to stop sending the bot's updates (deleteWebhook), then forgets the bot: its token, its secret and its chat. Its Consumer stays, stopped, with its delivery history. The bot is forgotten even when Telegram cannot be told; updatesStopped: false says so.

Checks the token with Telegram (getMe), has Telegram send the bot's updates to this server (setWebhook, with a secret), and only then keeps it. Nothing is kept when either step fails. The same bot keeps its connected chat; another bot needs a chat connected again.

A t.me link to the bot carrying a one-time code: pressing Start on it connects that private chat. It works once, for 15 minutes, and replaces any link opened before.

Sends a test message to the connected chat now and answers what Telegram said. It is recorded nowhere. A refusal is a 200 with delivered: false — the test itself worked.

The store's rules for its customers' reviews: whether it takes them, what a shopper may send, and what publishes without checking.

Changes the rules given and keeps the others. Reviews already received keep the status they have.