zinn-campaigns

POST /v1/email-marketing/cold/imports

Import business leads for Cold Outreach (checked in the background).

All zinn-campaigns endpoints

All developer docs →

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

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/cold/imports \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "attested": <boolean>, "leads": <EmailMarketingColdLeadRow[]> }'

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. attested must be true: the caller confirms the statement in attestation on GET /v1/email-marketing/cold (business contacts, a legitimate interest, published or provided business addresses); it is stored word for word with who confirmed it. Answers 202 at once; a durable workflow then checks every row (syntax, duplicates, the country rule from the country column or else the country-code domain, business addresses, the organisation's suppression list and the platform complaint list, then MX). Read GET imports/{id} for progress and the verdict of every refused row. At most max_import_rows rows per request: send a bigger file as several imports. 404 (refusal.campaigns.gone) when the caller has no acting organisation.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoThe 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

NameTypeRequiredWhat it is
attestedbooleanYesMust be true; confirms the attestation statement shown by the overview.
source_namestringNo—
leadsEmailMarketingColdLeadRow[]Yes—

Response

NameTypeRequiredWhat it is
idstringYes—
statusstring<queued, running, done, failed>Yes—
source_namestringNo—
attested_bystringNo—
rows_totalintegerYes—
rows_checkedintegerYes—
rows_addedintegerYes—
rows_updatedintegerYes—
rows_refusedintegerYes—
verdict_countsobjectYesOne count per verdict.
refusedEmailMarketingColdImportVerdict[]Yes—
created_atstringYes—
finished_atstringNo—

Errors this endpoint can return

400 · 401 · 403 · 404 · 413 · 503