API референца
zinn-campaigns
129 крајњих тачака у овој области. Свака има сопствену страницу са својим параметрима, одговором и захтевом који можете покренути.
| Метод | Путања | Шта ради | Дозвола |
|---|---|---|---|
| GET | /v1/email-marketing | Zinn® Campaigns overview for one organisation. | email_marketing.view |
| POST | /v1/email-marketing/ai/write | Write a draft campaign email from a short brief with Zinn® AI. | email_marketing.manage |
| GET | /v1/email-marketing/brand-kit | The organisation's brand kit (name, logo, colours, font, voice). | email_marketing.view |
| PUT | /v1/email-marketing/brand-kit | Edit the brand kit. | email_marketing.manage |
| POST | /v1/email-marketing/brand-kit/read | Read the brand kit from the organisation's website. | email_marketing.manage |
| GET | /v1/email-marketing/campaigns | E-mail campaigns, newest first, one keyset page. | email_marketing.view |
| POST | /v1/email-marketing/campaigns | Create a draft e-mail campaign. | email_marketing.manage |
| GET | /v1/email-marketing/campaigns/{campaign_id} | One e-mail campaign. | email_marketing.view |
| PATCH | /v1/email-marketing/campaigns/{campaign_id} | Edit a draft (or a refused campaign, which returns to draft). | email_marketing.manage |
| GET | /v1/email-marketing/campaigns/{campaign_id}/lint | Check a campaign's copy for deliverability problems before it is sent. | email_marketing.view |
| GET | /v1/email-marketing/campaigns/{campaign_id}/report | A campaign's numbers. | email_marketing.view |
| POST | /v1/email-marketing/campaigns/{campaign_id}/send | Start sending a campaign to its list. | email_marketing.manage |
| POST | /v1/email-marketing/campaigns/{campaign_id}/test | Send one test copy now to a member of the organisation. | email_marketing.manage |
| POST | /v1/email-marketing/campaigns/{campaign_id}/translate | Translate a campaign into every contact language that is missing or stale. | email_marketing.manage |
| GET | /v1/email-marketing/campaigns/{campaign_id}/translations | Each contact language of a campaign's list and whether its translation is current. | email_marketing.view |
| GET | /v1/email-marketing/cold | Whether Cold Outreach is open to the organisation. | email_marketing.view |
| GET | /v1/email-marketing/cold/countries | The Cold Outreach rule for each country, as this organisation sees it. | email_marketing.view |
| PUT | /v1/email-marketing/cold/countries/{country} | Override the Cold Outreach rule for one country, after the warning. | email_marketing.manage |
| GET | /v1/email-marketing/cold/imports | The organisation's lead imports, newest first. | email_marketing.view |
| POST | /v1/email-marketing/cold/imports | Import business leads for Cold Outreach (checked in the background). | email_marketing.manage |
| GET | /v1/email-marketing/cold/imports/{import_id} | One lead import, its progress and the verdict of every refused row. | email_marketing.view |
| GET | /v1/email-marketing/cold/leads | The organisation's Cold Outreach leads, one keyset page at a time. | email_marketing.view |
| GET | /v1/email-marketing/cold/mailboxes | The organisation's Cold Outreach mailboxes. | email_marketing.view |
| POST | /v1/email-marketing/cold/mailboxes | Connect a mailbox (SMTP to send, IMAP to read replies) for Cold Outreach. | email_marketing.manage |
| DELETE | /v1/email-marketing/cold/mailboxes/{mailbox_id} | Remove a Cold Outreach mailbox and its stored password. | email_marketing.manage |
| GET | /v1/email-marketing/cold/mailboxes/{mailbox_id} | One Cold Outreach mailbox. | email_marketing.view |
| PATCH | /v1/email-marketing/cold/mailboxes/{mailbox_id} | Change a mailbox's name, daily cap, gap between sends, or pause it. | email_marketing.manage |
| POST | /v1/email-marketing/cold/mailboxes/{mailbox_id}/verify | Check a mailbox again, without sending anything. | email_marketing.manage |
| GET | /v1/email-marketing/cold/replies | The Unibox - every reply, automatic reply, bounce and unsubscribe to a cold thread. | email_marketing.view |
| PATCH | /v1/email-marketing/cold/replies/{reply_id} | Mark a Unibox row read or unread, or label it. | email_marketing.manage |
| POST | /v1/email-marketing/cold/replies/{reply_id}/answer | Answer a Unibox reply, in-thread, from the mailbox it reached. | email_marketing.manage |
| GET | /v1/email-marketing/cold/sequences | The organisation's cold sequences. | email_marketing.view |
| POST | /v1/email-marketing/cold/sequences | Create a cold sequence (draft). | email_marketing.manage |
| DELETE | /v1/email-marketing/cold/sequences/{sequence_id} | Delete a sequence and its enrolments. | email_marketing.manage |
| GET | /v1/email-marketing/cold/sequences/{sequence_id} | One cold sequence, with its steps and A/B variants. | email_marketing.view |
| PATCH | /v1/email-marketing/cold/sequences/{sequence_id} | Change a sequence's name, sending window, language, postal address or mailboxes. | email_marketing.manage |
| POST | /v1/email-marketing/cold/sequences/{sequence_id}/enrol | Enrol leads by id or by import (at most 10,000 per request). | email_marketing.manage |
| POST | /v1/email-marketing/cold/sequences/{sequence_id}/launch | Launch a sequence. | email_marketing.manage |
| POST | /v1/email-marketing/cold/sequences/{sequence_id}/pause | Pause an active sequence. | email_marketing.manage |
| GET | /v1/email-marketing/cold/sequences/{sequence_id}/report | Per step and A/B variant: sent, replies, reply rate, bounces, unsubscribes. | email_marketing.view |
| POST | /v1/email-marketing/cold/sequences/{sequence_id}/resume | Resume a paused sequence. | email_marketing.manage |
| PUT | /v1/email-marketing/cold/sequences/{sequence_id}/steps | Replace the whole step list (1-10 steps, 1-5 variants each). | email_marketing.manage |
| GET | /v1/email-marketing/contacts | The organisation's contacts, one keyset page at a time. | email_marketing.view |
| POST | /v1/email-marketing/contacts/{contact_id}/messages | Send one SMS or WhatsApp message to one contact. | email_marketing.manage |
| GET | /v1/email-marketing/deliverability-settings | The bounce and spam-complaint thresholds this organisation sends under. | email_marketing.view |
| PUT | /v1/email-marketing/deliverability-settings | Set or clear this organisation's threshold overrides. | email_marketing.manage |
| GET | /v1/email-marketing/flows | E-mail flows (welcome, drip, a yearly date), one keyset page. | email_marketing.view |
| POST | /v1/email-marketing/flows | Create a flow (it starts as a draft). | email_marketing.manage |
| DELETE | /v1/email-marketing/flows/{flow_id} | Delete a flow and its enrolments (its sent runs stay, as campaigns). | email_marketing.manage |
| GET | /v1/email-marketing/flows/{flow_id} | One flow with its steps and its report (enrolled, in progress, runs and recipients per step). | email_marketing.view |
| PATCH | /v1/email-marketing/flows/{flow_id} | Change a flow; steps, when given, replaces the whole sequence. | email_marketing.manage |
| POST | /v1/email-marketing/flows/{flow_id}/activate | Switch a flow on; only people who join the list from now on are enrolled. | email_marketing.manage |
| POST | /v1/email-marketing/flows/{flow_id}/pause | Pause a flow; due steps wait and nobody new is mailed until it is switched back on. | email_marketing.manage |
| GET | /v1/email-marketing/forms | Sign-up forms (double opt-in), newest first, one keyset page. | email_marketing.view |
| POST | /v1/email-marketing/forms | Create a sign-up form that adds confirmed people to one list. | email_marketing.manage |
| DELETE | /v1/email-marketing/forms/{form_id} | Delete a sign-up form (people already confirmed stay on the list). | email_marketing.manage |
| PATCH | /v1/email-marketing/forms/{form_id} | Change a sign-up form (wording, list, redirect, on or off). | email_marketing.manage |
| GET | /v1/email-marketing/imports | Past contact imports, newest first, one keyset page at a time. | email_marketing.view |
| POST | /v1/email-marketing/imports | Import one chunk of contacts with its consent attestation. | email_marketing.manage |
| GET | /v1/email-marketing/lists | The organisation's mailing lists with subscribed / unsubscribed counts. | email_marketing.view |
| POST | /v1/email-marketing/lists | Create a mailing list (or return the one with that name). | email_marketing.manage |
| POST | /v1/email-marketing/lists/{list_id}/members | Add contacts to a list by e-mail address (at most 1,000 a request). | email_marketing.manage |
| GET | /v1/email-marketing/managed-delivery/price | The public price of Zinn® managed e-mail delivery. | Нема API кључа |
| GET | /v1/email-marketing/messages | SMS and WhatsApp messages the organisation sent, newest first, one keyset page. | email_marketing.view |
| GET | /v1/email-marketing/sender-providers | The providers a campaign sender can connect (the connect picker). | email_marketing.view |
| GET | /v1/email-marketing/senders | The organisation's sending connections. | email_marketing.view |
| POST | /v1/email-marketing/senders | Connect a campaign sender (Zinn® sending, a sending service, a mailbox, or your own SMTP). | email_marketing.manage |
| DELETE | /v1/email-marketing/senders/{sender_id} | Remove a sending connection and its stored password. | email_marketing.manage |
| GET | /v1/email-marketing/senders/{sender_id}/dns | Preview the sending records we would add to your DNS (when we host it). | email_marketing.view |
| POST | /v1/email-marketing/senders/{sender_id}/dns | Add the previewed sending records to your DNS, with your consent. | email_marketing.manage |
| GET | /v1/email-marketing/senders/{sender_id}/health | The sending domain's DNS + reputation readings, newest first. | email_marketing.view |
| POST | /v1/email-marketing/senders/{sender_id}/health | Re-check the sending domain's DNS + reputation now. | email_marketing.manage |
| POST | /v1/email-marketing/senders/{sender_id}/verify | Prove a sending connection works, without sending anything. | email_marketing.manage |
| PUT | /v1/email-marketing/senders/{sender_id}/webhook | Set up delivery events from your e-mail provider for this connection. | email_marketing.manage |
| GET | /v1/email-marketing/sms | What the SMS screen needs — open?, paused?, credit balance and prices. | email_marketing.view |
| GET | /v1/email-marketing/sms/campaigns | Bulk SMS and WhatsApp campaigns, newest first, one keyset page. | email_marketing.view |
| POST | /v1/email-marketing/sms/campaigns | Create a draft SMS or WhatsApp campaign to a list. | email_marketing.manage |
| GET | /v1/email-marketing/sms/campaigns/{campaign_id} | One bulk SMS campaign. | email_marketing.view |
| PATCH | /v1/email-marketing/sms/campaigns/{campaign_id} | Edit a draft (or a refused campaign, which returns to draft). | email_marketing.manage |
| GET | /v1/email-marketing/sms/campaigns/{campaign_id}/report | A bulk SMS campaign's numbers. | email_marketing.view |
| POST | /v1/email-marketing/sms/campaigns/{campaign_id}/send | Start sending an SMS to everyone on its list who agreed to SMS — or resume one paused for credit. | email_marketing.manage |
| GET | /v1/email-marketing/sms/registrations/us | This organisation's US 10DLC registration, and what one costs. | email_marketing.view |
| POST | /v1/email-marketing/sms/registrations/us | Submit this organisation's brand and campaign for US 10DLC (charged on submit). | email_marketing.manage |
| PUT | /v1/email-marketing/sms/sender-id | Set this organisation's own SMS sender name (alphanumeric sender ID). | email_marketing.manage |
| POST | /v1/email-marketing/sms/sender-requests | Ask to register this organisation's own SMS sender name in another country. | email_marketing.manage |
| DELETE | /v1/email-marketing/whatsapp/connection | Disconnect this organisation's WhatsApp Business Account. | email_marketing.manage |
| POST | /v1/email-marketing/whatsapp/connection | Connect this organisation's own WhatsApp Business Account (Meta Embedded Signup). | email_marketing.manage |
| GET | /v1/email-marketing/whatsapp/health | Can this organisation's own WhatsApp account send, and what to fix. | email_marketing.view |
| POST | /v1/email-marketing/whatsapp/health | Read Meta again now ("Check again"). | email_marketing.manage |
| GET | /v1/email-marketing/whatsapp/templates | The message templates on this organisation's own WhatsApp account. | email_marketing.view |
| POST | /v1/email-marketing/whatsapp/templates | Submit a template for Meta's review. | email_marketing.manage |
| DELETE | /v1/email-marketing/zerobounce | Disconnect this organisation's ZeroBounce key. | email_marketing.manage |
| GET | /v1/email-marketing/zerobounce | Whether this organisation's own ZeroBounce key is connected (F41). | email_marketing.view |
| PUT | /v1/email-marketing/zerobounce | Connect (or replace) this organisation's own ZeroBounce API key. | email_marketing.manage |
| GET | /v1/public/email-marketing/c/{token} | The click counter. Records one click per recipient and redirects to the original link. | Нема API кључа |
| GET | /v1/public/email-marketing/cold-u/{token} | The unsubscribe link every cold outreach message carries (no login). | Нема API кључа |
| POST | /v1/public/email-marketing/cold-u/{token} | RFC 8058 one-click unsubscribe from a cold outreach message. | Нема API кључа |
| GET | /v1/public/email-marketing/f/{public_id} | A sign-up form's hosted page (no login). | Нема API кључа |
| POST | /v1/public/email-marketing/f/{public_id} | Submit a sign-up form (hosted page, embed or JSON). | Нема API кључа |
| GET | /v1/public/email-marketing/fc | The double opt-in confirmation page (no login). | Нема API кључа |
| POST | /v1/public/email-marketing/fc | Confirm a sign-up (adds the person to the list with a consent record). | Нема API кључа |
| GET | /v1/public/email-marketing/o/{token} | The open-tracking image (a 1x1 GIF). Counts one open per recipient. | Нема API кључа |
| GET | /v1/public/email-marketing/u/{token} | The footer unsubscribe link (no login). | Нема API кључа |
| POST | /v1/public/email-marketing/u/{token} | RFC 8058 one-click unsubscribe (and the page's "stop everything" button). | Нема API кључа |
| GET | /v1/public/email-marketing/warmup-u/{token} | The marketing pool warm-up mail's unsubscribe link (no login). | Нема API кључа |
| POST | /v1/public/email-marketing/warmup-u/{token} | RFC 8058 one-click unsubscribe from the warm-up mail. | Нема API кључа |
| POST | /v1/store-connect/authorize | A member approves a store's Zinn® Order Updates connection (the consent screen's Allow). | email_marketing.manage |
| GET | /v1/store-connect/campaigns | The Zinn® Campaigns WordPress plugin reads whether its Pro add-on is unlocked. | Нема API кључа |
| DELETE | /v1/store-connect/connection | The store plugin's own Disconnect button revokes its token. | Нема API кључа |
| GET | /v1/store-connect/connections | Connected stores, newest first (Campaigns, Stores). | email_marketing.view |
| DELETE | /v1/store-connect/connections/{connection_id} | Disconnect a store from the dashboard. | email_marketing.manage |
| POST | /v1/store-connect/consents | The store plugin records the shopper's checkout opt-ins, per channel and purpose. | Нема API кључа |
| POST | /v1/store-connect/events | The store plugin posts order events; each new one sends the shopper an update in their language. | Нема API кључа |
| GET | /v1/store-connect/forms | The WordPress plugin lists the store org's enabled sign-up forms for its form picker. | Нема API кључа |
| POST | /v1/store-connect/forms | The WordPress plugin posts one visitor's sign-up from the site's server (double opt-in). | Нема API кључа |
| GET | /v1/store-connect/orders/{ref}/messages | The store plugin reads one order's update history (sent, not sent and why, failed). | Нема API кључа |
| POST | /v1/store-connect/orders/{ref}/updates | The store plugin sends one order's shopper an update from an approved template. | Нема API кључа |
| POST | /v1/store-connect/people | The store plugin syncs its WordPress users and store customers into Zinn® Campaigns contacts. | Нема API кључа |
| GET | /v1/store-connect/people/summary | The store plugin reads how many people it has synced per source, for its daily reconcile. | Нема API кључа |
| POST | /v1/store-connect/shopper | The store plugin reads one shopper's text preferences and the last 20 texts this store sent them. | Нема API кључа |
| GET | /v1/store-connect/status | The store plugin reads its connection; doubles as the heartbeat. | Нема API кључа |
| GET | /v1/store-connect/support/tickets | This store's support tickets, newest first, with status and support's latest reply. | Нема API кључа |
| POST | /v1/store-connect/support/tickets | Zinn® Order Updates files a support ticket with its store token (docs/1297 §16). | Нема API кључа |
| POST | /v1/store-connect/support/tickets/{reference}/replies | The store owner replies to one of this store's tickets from the plugin. | Нема API кључа |
| POST | /v1/store-connect/token | The store plugin exchanges the one-time code and its PKCE verifier for a store token. | Нема API кључа |
| POST | /v1/webhooks/campaigns/telnyx | Inbound SMS replies (STOP / START) and delivery receipts from our SMS vendor. | Нема API кључа |
| GET | /v1/webhooks/campaigns/whatsapp | Meta's webhook verify-token handshake for WhatsApp. | Нема API кључа |
| POST | /v1/webhooks/campaigns/whatsapp | WhatsApp delivery receipts and STOP replies from Meta. | Нема API кључа |
| POST | /v1/webhooks/email-marketing/{connection_id} | A customer's own e-mail provider's delivery events for one sending connection. | Нема API кључа |