Tài liệu tham khảo API
Campaigns
Có 18 điểm cuối trong khu vực này. Mỗi điểm cuối có một trang riêng với các tham số, phản hồi và yêu cầu mà quý vị có thể thực hiện.
| Phương thức | Đường dẫn | Chức năng | Quyền |
|---|---|---|---|
| GET | /v1/campaigns | The organisation's campaigns. | campaigns.view |
| POST | /v1/campaigns | Create a campaign from a template and an audience. | campaigns.view |
| DELETE | /v1/campaigns/esp | Disconnect the provider account and remove its stored key. | campaigns.send |
| GET | /v1/campaigns/esp | The organisation's own e-mail provider account. | campaigns.view |
| POST | /v1/campaigns/esp | Connect an e-mail provider account. | campaigns.send |
| POST | /v1/campaigns/esp/verify | Prove the provider account works and read its verified domains. | campaigns.send |
| POST | /v1/campaigns/preview | Render a template with example values. | campaigns.view |
| GET | /v1/campaigns/tags | The magic-tag palette a campaign composer offers. | campaigns.view |
| GET | /v1/campaigns/templates | The organisation's campaign templates. | campaigns.view |
| POST | /v1/campaigns/templates | Author a campaign template. | campaigns.view |
| DELETE | /v1/campaigns/templates/{templateId} | Archive a template and retire its translation sources. | campaigns.view |
| GET | /v1/campaigns/templates/{templateId} | One campaign template. | campaigns.view |
| PUT | /v1/campaigns/templates/{templateId} | Edit a campaign template. | campaigns.view |
| DELETE | /v1/campaigns/{campaignId} | Delete a campaign and retire its delivery rows. | campaigns.send |
| GET | /v1/campaigns/{campaignId} | One campaign and its delivery report. | campaigns.view |
| POST | /v1/campaigns/{campaignId}/control | Pause, resume or cancel a running send. | campaigns.send |
| POST | /v1/campaigns/{campaignId}/send | Start the durable send. | campaigns.send |
| POST | /v1/campaigns/{campaignId}/test | Send one real message on the channel the campaign will actually use. | campaigns.send |