Skip to main content
PATCH
Update the facts sheet: a key that is present replaces its section, a key that is absent is kept
A key that is present in the body replaces that section of the sheet in full. A key that is absent is left as it was. So { "codes": [...] } rewrites the codes and touches nothing else, and to clear a section you send it empty ("codes": [] or "delivery_promise": null). Keys outside the sheet’s field list are ignored.
Values outside the shape are dropped, not rejected; read the sheet back after writing. See The facts sheet.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The website id

Body

application/json
currency
string
free_shipping_threshold
number | null
shipping_flat
number | null
shipping_zones
object[]
return_days
number | null
delivery_promise
string | null
size_notes
object[]
codes
object[]
discounts_allowed
boolean
output
enum<string>
Available options:
card,
popup,
event,
none
popup
object | null

The store's popup tool and campaign. A moment handed to it counts as shown only when the tool confirms.

never_say
string[]

Sentences the engine must never show again, or anything that means the same (same words after case and punctuation are ignored, or most of the words of four letters or more). Checked before every card is composed. Deduped without regard to case; the fifty-first is dropped.

Maximum array length: 50
Required string length: 3 - 200
say_instead
object[]

Replacements the owner wrote. When the engine would say never it says say, provided say passes the same truth checks as any sentence; otherwise the moment is a mute and the moment row carries delivery.refused = owner_replacement_refused with delivery.reason. A never_say match wins over a replacement. Deduped on never.

Maximum array length: 50
klaviyo
object

Response

Facts

currency
string
free_shipping_threshold
number | null
shipping_flat
number | null
shipping_zones
object[]
return_days
number | null
delivery_promise
string | null
size_notes
object[]
codes
object[]
discounts_allowed
boolean
output
enum<string>
Available options:
card,
popup,
event,
none
popup
object | null

The store's popup tool and campaign. A moment handed to it counts as shown only when the tool confirms.

never_say
string[]

Sentences the engine must never show again, or anything that means the same (same words after case and punctuation are ignored, or most of the words of four letters or more). Checked before every card is composed. Deduped without regard to case; the fifty-first is dropped.

Maximum array length: 50
Required string length: 3 - 200
say_instead
object[]

Replacements the owner wrote. When the engine would say never it says say, provided say passes the same truth checks as any sentence; otherwise the moment is a mute and the moment row carries delivery.refused = owner_replacement_refused with delivery.reason. A never_say match wins over a replacement. Deduped on never.

Maximum array length: 50
detected_tools
string[]
read-only

Popup tools the storefront reported running, refreshed daily by the snippet; ignored in a PATCH

detected_at
string<date-time> | null
read-only
klaviyo
object