Skip to main content
PATCH

Authorizations

​
Authorization
string
header
required

Authorization: Basic base64(partner_key:secret_key).

Credentials are issued by a klikit operator. The plaintext secret_key is shown once at issuance and cannot be retrieved later — store it securely. If lost, ask your operator to rotate the secret to receive a new one. The old secret stops working immediately on rotation; there is no overlap window.

Path Parameters

​
sectionID
integer
required

Body

application/json

Wholesale replacement of an entity's visibility map. Used by every setXxxVisibilities operation (sections, categories, items, modifier groups, modifiers).

Two scopes of write:

  • Business-level (omit zoneStores) — overwrites the entity's default visibility map. Applies to every store that inherits this entity.
  • Per-store override (populate zoneStores) — writes a row in the matching store_*_overrides table for each listed (brandID, branchID) pair. The business-level map is left untouched.

Reminder on sync: business-level edits are propagated into store overrides by syncMenuToStores, but visibilities is on the default persist list — your business-level change won't overwrite an existing store-level visibility unless you add visibilities to fieldIncludeOnSync. See the menu-publish tag for the round-trip.

​
visibilities
object
required

Per-provider visibility flag. Keys are provider ids (as strings) from GET /v1/partner/providers. Set a provider's value to true to publish on that channel. Providers absent from the map default to hidden.

Klikit's own marketplace is provider id "1".

Example:
​
zoneStores
object[]

Per-store override targets. Each entry writes (or replaces) the store-level visibility row for that (brandID, branchID).

Response

200 - application/json

Visibilities updated

Canonical response wrapper. Every response — success or error — carries the request_id so you can quote one id to klikit support to correlate a request end-to-end.

​
request_id
string
required
Example:

"req_4d1b7e3f-..."

​
data
any

Endpoint-specific payload on success.

​
error
object

Machine-readable error code + human message. The code is stable across releases — switch on code in your client code rather than parsing the message text.

Common codes you will encounter as a partner: