zinn-campaigns

POST /v1/store-connect/shopper

The store plugin reads one shopper's text preferences and the last 20 texts this store sent them.

All zinn-campaigns endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/store-connect/shopper \
  -H "Content-Type: application/json" \
  -d '{ "phone": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Store token only. Feeds the shopper's My Account "Messages" panel (docs/1297 §8.3). The plugin asks only for a number that is the billing phone on one of the signed-in shopper's OWN orders, and lists only the texts whose ref is one of those orders (an account phone is typed, so it proves nothing). Scoped to the token's ONE store: another store's consents or texts, even of the same organisation, are never returned. consents is every channel + purpose this number has at this store (active: false once withdrawn); messages holds only texts that were sent, newest first, at most 20. POST so the phone number never appears in a URL or a log. A preference change is posted back to recordStoreConsents (withdrawn: true to stop).

Request body

NameTypeRequiredWhat it is
phonestringYesE.164, the signed-in shopper's own number.

Response

NameTypeRequiredWhat it is
phonestringYes—
consentsobject[]Yes—
messagesobject[]Yes—

Errors this endpoint can return

401 · 422 · 429