zinn-campaigns

POST /v1/email-marketing/cold/replies/{reply_id}/answer

Answer a Unibox reply, in-thread, from the mailbox it reached.

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/replies/{reply_id}/answer \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "body": <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

Gated on email_marketing.manage. Queues one plain-text answer to a reply from a person and starts its send on the Cold Outreach worker: it goes from the same mailbox, through that mailbox's own mail server, with In-Reply-To and References set so it files in the same conversation. One answer per reply: 409 while one is queued or once it was sent; a failed answer may be sent again. A bounce, automatic reply or unsubscribe request is refused with 400 (field kind); an empty or over-long body with 400 (field body). 503 when the send could not be started (nothing was sent; the reply is left failed so it can be retried). 404 outside the caller's 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…
reply_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
bodystringYesThe answer, plain text. Leading and trailing spaces are dropped.

Response

NameTypeRequiredWhat it is
idstringYes—
mailbox_idstringYes—
sequence_idstringNo—
lead_idstringNo—
kindstring<reply, auto_reply, bounce, unsubscribe>Yes—
from_emailstringYes—
from_namestringNo—
subjectstringNo—
snippetstringNoThe reply's own words
received_atstringYes—
readbooleanYes—
labelstring<, interested, not_interested, meeting, later, wrong_person>Yes—
answer_statusstring<, queued, sent, failed>YesThe customer's answer to this reply from the Unibox: empty when none was written, queued while it is being sent, sent, or failed (it may be sent again).
answer_detailstringYesWhy a failed answer failed: mailbox (the mailbox cannot send), unavailable (it could not be started; nothing was sent), auth_<code>, smtp_<code> or network_<error>…
answered_atstringYes—

Errors this endpoint can return

400 · 401 · 403 · 404 · 409 · 503