Sanggunian ng API
zinn-campaigns
38 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| GET | /v1/email-marketing | Zinn® Campaigns overview for one organisation. | email_marketing.view |
| 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}/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 |
| 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 to one contact, paid from the Zinn® credit balance. | 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/messages | SMS and WhatsApp messages the organisation sent, newest first, one keyset page. | email_marketing.view |
| GET | /v1/email-marketing/senders | The organisation's sending connections. | email_marketing.view |
| POST | /v1/email-marketing/senders | Connect the customer's own SMTP server for campaigns. | email_marketing.manage |
| DELETE | /v1/email-marketing/senders/{sender_id} | Remove a sending connection and its stored password. | 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 | Store your e-mail provider's webhook signing secret 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 campaigns, newest first, one keyset page. | email_marketing.view |
| POST | /v1/email-marketing/sms/campaigns | Create a draft SMS 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 |
| GET | /v1/public/email-marketing/c/{token} | The click counter. Records one click per recipient and redirects to the original link. | Walang API key |
| GET | /v1/public/email-marketing/o/{token} | The open-tracking image (a 1x1 GIF). Counts one open per recipient. | Walang API key |
| GET | /v1/public/email-marketing/u/{token} | The footer unsubscribe link (no login). | Walang API key |
| POST | /v1/public/email-marketing/u/{token} | RFC 8058 one-click unsubscribe (and the page's "stop everything" button). | Walang API key |
| GET | /v1/public/email-marketing/warmup-u/{token} | The marketing pool warm-up mail's unsubscribe link (no login). | Walang API key |
| POST | /v1/public/email-marketing/warmup-u/{token} | RFC 8058 one-click unsubscribe from the warm-up mail. | Walang API key |
| POST | /v1/webhooks/campaigns/telnyx | Inbound SMS replies (STOP / START) from our SMS vendor. | Walang API key |
| POST | /v1/webhooks/email-marketing/{connection_id} | A customer's own e-mail provider's delivery events for one sending connection. | Walang API key |