zinn-campaigns
POST /v1/email-marketing/imports
Import one chunk of contacts with its consent attestation.
Authentication
Send an API key as a bearer token. The key must carry the email_marketing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/email-marketing/imports \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "basis": <string<consent, soft_opt_in>>, "attestation": <string>, "contacts": <EmailMarketingImportRow[]> }'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
Gated on email_marketing.manage. At most max_import_rows (1,000) contacts per request; a larger list is sent as several requests. attestation (at least 20 characters) records how these people agreed to hear from the customer, and every imported contact gets a consent row pointing at this import. Invalid and role addresses (postmaster@, noreply@ …) are rejected per row; duplicates are merged; a contact who unsubscribed, bounced or complained is never re-subscribed (counted in rows_suppressed). Refused with 402 CONTACT_LIMIT when the import would take the organisation over its contact allowance (the whole chunk is refused), 403 NOT_OPEN while the product is off for the account, 413 TOO_MANY_ROWS above 1,000 rows.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
basis | string<consent, soft_opt_in> | Yes | — |
attestation | string | Yes | How these people agreed to receive the customer's emails. |
source_name | string | No | — |
contacts | EmailMarketingImportRow[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
source_name | string | Yes | — |
basis | string<consent, soft_opt_in> | Yes | — |
attestation | string | Yes | — |
attested_by | string | Yes | — |
rows_total | integer | Yes | — |
rows_added | integer | Yes | — |
rows_updated | integer | Yes | — |
rows_suppressed | integer | Yes | — |
rows_rejected | integer | Yes | — |
rejected_sample | object[] | Yes | — |
created_at | string | Yes | — |
Errors this endpoint can return
400 · 401 · 402 · 403 · 404 · 413