zinn-campaigns
POST /v1/store-connect/people
The store plugin syncs its WordPress users and store customers into Zinn® Campaigns contacts.
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/people \
-H "Content-Type: application/json" \
-d '{ "people": <StorePersonInput[]> }'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 (docs/1297 §9.5, docs/1052 F30). A batch of 1-100 people from the plugin's resumable backfill, its live hooks or its daily reconcile, applied as one batched upsert keyed by organisation + e-mail hash. op: upsert creates or fills in the contact and records this store's source (attributes.sources[]); it never sets a contact's status, so an unsubscribed, bounced or complained person stays suppressed, and a new person whose address is on the organisation's suppression list arrives suppressed. A synced person gets NO consent and joins NO list, so no campaign can select them; the one exception is the e-mail soft opt-in, written only when soft_opt_in states the opt-out the store gave and only for a store customer with at least one paid order (never SMS or WhatsApp). op: delete removes this store's source and the contact with its last source unless it holds a consent of its own; op: erase (the WordPress privacy eraser) deletes the contact on its last source whatever it holds and keeps only the suppression hash and the number's opt-out. A person the engine cannot take is listed in rejected by index (an invalid or role address, or contactLimit when the plan's contact allowance is full, with limit_reached: true); the rest of the batch still applies.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
people | StorePersonInput[] | Yes | — |
soft_opt_in | object | No | Present only when the store switched the e-mail soft opt-in on. The opt-out it gave at collection, in full (at least 20 characters), kept as evidence. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
upserted | integer | Yes | — |
created | integer | Yes | — |
deleted | integer | Yes | — |
suppressed | integer | Yes | Upserted people whose contact is suppressed. |
soft_opt_in | integer | Yes | E-mail soft opt-ins written by this batch. |
limit_reached | boolean | Yes | — |
rejected | object[] | Yes | — |
Errors this endpoint can return
401 · 422 · 429