Mọi thao tác quý vị có thể thực hiện trên bảng điều khiển trong Zinn® Campaigns đều có thể thực hiện qua API, và hầu hết các thao tác đó cũng có thể thực hiện từ trợ lý AI được kết nối với tài khoản của quý vị qua MCP. Hướng dẫn này bao gồm việc đăng nhập, các quyền hạn, ví dụ thực tế cho cả hai cách, các giới hạn, các lỗi và từng thao tác trong số 89 thao tác Campaigns. Danh sách thao tác dưới đây được tạo từ thông số kỹ thuật API của chúng tôi, vì vậy danh sách này luôn khớp với những gì API thực hiện. Mọi trường của mỗi thao tác đều có trong tài liệu tham khảo API tại zinndigital.com/developers/api/zinn-campaigns.
Đăng nhập
- Khoá API. Hãy tạo một khoá trong trang tổng quan tại phần Cài đặt → Khoá API và gửi khoá đó dưới dạng
Authorization: Bearer zdk_live_… (khoá zdk_test_… hoạt động trong chế độ sandbox). Chỉ cấp cho khoá các quyền Campaigns cần thiết và không cấp thêm quyền nào khác.
- Trợ lý AI (MCP). Hãy kết nối Claude, ChatGPT, Cursor hoặc bất kỳ ứng dụng khách MCP nào với
https://api.zinndigital.com/v1/mcp, bằng cách đăng nhập từ ứng dụng hoặc sử dụng mã kết nối (zmcp_live_…). Xem mục Kết nối Claude, Cursor hoặc ChatGPT với tài khoản của quý vị. Trên màn hình chấp thuận, hãy đánh dấu chọn các quyền Zinn® Campaigns.
- Quyền hạn.
email_marketing.view dùng để đọc các chiến dịch, danh sách, liên hệ, biểu mẫu, người gửi, cài đặt SMS và báo cáo; email_marketing.manage dùng để tạo và chỉnh sửa các mục này. Các chiến dịch quý vị gửi qua dịch vụ email của riêng mình sẽ sử dụng campaigns.view và campaigns.manage.
- Đại lý bán lẻ. Hãy truyền
org_id để thao tác trên một trong các tổ chức khách hàng của quý vị. Hãy bỏ qua thông số này khi khoá hoặc kết nối của quý vị chỉ liên kết với duy nhất một tổ chức.
Ví dụ: tạo một chiến dịch bản nháp bằng API
curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{
"name": "Spring sale",
"subject": "Our spring sale starts today",
"list_id": "<list id>",
"sender_id": "<sender id>",
"template": "basic"
}'
Câu trả lời là 201 cùng với bản nháp. Hãy kiểm thử bằng POST /v1/email-marketing/campaigns/{campaign_id}/test, kiểm tra bằng GET /v1/email-marketing/campaigns/{campaign_id}/lint, và gửi bằng POST /v1/email-marketing/campaigns/{campaign_id}/send.
Ví dụ: cùng một bản nháp từ trợ lý AI
Hãy yêu cầu trợ lý của quý vị bằng những từ ngữ thông thường, ví dụ "soạn một email Zinn® Campaigns có tên Đợt giảm giá mùa xuân với tiêu đề 'Đợt giảm giá mùa xuân của chúng tôi bắt đầu từ hôm nay'". Ở phía sau hậu trường, trợ lý sẽ tìm kiếm thao tác bằng api_operations_search, đọc các tham số của thao tác bằng api_operation_get, và chạy thao tác đó bằng api_operation_call:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "api_operation_call",
"arguments": {
"operation_id": "createEmailMarketingCampaign",
"confirm": true,
"body": {
"name": "Spring sale",
"subject": "Our spring sale starts today"
}
}
}
}
Những điều trợ lý sẽ không thực hiện. Bất kỳ hành động nào gửi tới người nhận của bạn hoặc tiêu tốn tiền bạc hay hạn mức — gửi chiến dịch, gửi tin nhắn SMS hoặc WhatsApp, viết bằng tín dụng AI, đăng ký gửi tin nhắn US — đều bị từ chối đối với trợ lý, do đó một chỉ dẫn bị hiểu nhầm sẽ không bao giờ có thể tiếp cận khách hàng của bạn. Trợ lý chuẩn bị bản nháp; bạn nhấn Gửi trong bảng điều khiển hoặc tự mình gọi API. Các thông tin bảo mật như mật khẩu SMTP cũng không bao giờ được chuyển qua trợ lý: hãy nhập chúng trong bảng điều khiển.
Giới hạn
- 1.200 yêu cầu mỗi phút cho mỗi người hoặc khóa API, và 6.000 yêu cầu mỗi phút cho mỗi tổ chức. Giới hạn nào nghiêm ngặt hơn sẽ được áp dụng.
- 600 yêu cầu mỗi phút cho mỗi kết nối MCP.
- Khi vượt quá giới hạn, phản hồi sẽ là
429 với tiêu đề Retry-After: vui lòng đợi số giây tương ứng.
- Việc thêm thành viên vào danh sách tiếp nhận tối đa 1.000 địa chỉ cho mỗi yêu cầu; hạn mức liên hệ và email trong gói của bạn áp dụng cho mọi thao tác bạn thực hiện qua API.
Lỗi
Mọi lỗi đều có cấu trúc giống nhau:
{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}
code không bao giờ thay đổi cho cùng một sự cố, vì vậy hãy kiểm tra nó thay vì message. Hãy trích dẫn request_id khi quý khách liên hệ với bộ phận hỗ trợ. Các câu trả lời quý khách sẽ gặp: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Lỗi 403 có nghĩa là khóa hoặc kết nối thiếu quyền được nêu trong danh sách dưới đây; lỗi 404 cũng bao gồm trường hợp nội dung nào đó trong tổ chức mà quý khách không thể thấy; lỗi 422 liệt kê từng trường bị sai trong details; sau lỗi 429, hãy đợi số giây được chỉ định trong tiêu đề Retry-After.
Webhook
Kết quả gửi thư được chuyển vào Zinn® Campaigns từ nhà cung cấp dịch vụ gửi email của quý khách:
- Với nhà cung cấp của riêng quý khách (ví dụ: Resend), hãy lưu khóa bí mật ký webhook của nhà cung cấp đó trên kết nối gửi trong bảng điều khiển (Chiến dịch → Gửi). Quý khách sẽ nhận được
webhook_url; hãy trỏ các sự kiện đã gửi, bị trả lại và bị khiếu nại của nhà cung cấp về URL đó. Thư bị trả lại hoặc khiếu nại spam sẽ xóa địa chỉ đó khỏi các lần gửi trong tương lai ngay lập tức.
- Với tính năng gửi của Zinn®, không có gì cần phải thiết lập.
Đọc kết quả bằng các thao tác báo cáo (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
Mọi thao tác Chiến dịch
Tổng quan
GET /v1/email-marketing — Tổng quan về Zinn® Campaigns cho một tổ chức. Thao tác getEmailMarketingOverview. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
Chiến dịch email
GET /v1/email-marketing/campaigns — Các chiến dịch tiếp thị qua email, mới nhất trước, một trang keyset. Thao tác listEmailMarketingCampaigns. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, qua MCP.
POST /v1/email-marketing/campaigns — Tạo một chiến dịch tiếp thị qua email dạng bản nháp. Thao tác createEmailMarketingCampaign. Quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, qua MCP.
GET /v1/email-marketing/campaigns/{campaign_id} — Một chiến dịch tiếp thị qua email. Thao tác getEmailMarketingCampaign. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, qua MCP.
PATCH /v1/email-marketing/campaigns/{campaign_id} — Chỉnh sửa bản nháp (hoặc chiến dịch bị từ chối, chuyển về trạng thái bản nháp). Thao tác updateEmailMarketingCampaign. Quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, qua MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — Kiểm tra nội dung văn bản của chiến dịch để tìm các vấn đề về khả năng gửi thư trước khi gửi. Thao tác lintEmailMarketingCampaign. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, qua MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/report — Số liệu thống kê của một chiến dịch. Thao tác getEmailMarketingCampaignReport. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, qua MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/send — Bắt đầu gửi chiến dịch đến danh sách của chiến dịch đó. Thao tác sendEmailMarketingCampaign. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Chỉ dành cho API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn mức, vì vậy con người sẽ nhấn thao tác đó (gửi đến người nhận thực tế và tiêu tốn hạn mức).
POST /v1/email-marketing/campaigns/{campaign_id}/test — Gửi ngay một bản sao thử nghiệm cho một thành viên trong tổ chức. Thao tác testEmailMarketingCampaign. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/translate — Dịch chiến dịch sang mọi ngôn ngữ liên hệ còn thiếu hoặc đã lỗi thời. Thao tác translateEmailMarketingCampaign. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/translations — Từng ngôn ngữ liên hệ trong danh sách của chiến dịch và liệu bản dịch của ngôn ngữ đó có phải là bản mới nhất hay không. Thao tác listEmailMarketingCampaignTranslations. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
Viết bằng AI
POST /v1/email-marketing/ai/write — Viết bản nháp email chiến dịch từ bản tóm tắt ngắn với Zinn® AI. Thao tác writeEmailMarketingCampaignWithAi. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn ngạch sử dụng, vì vậy con người phải tự bấm (viết bằng AI sẽ tiêu tốn tín dụng AI).
Bộ nhận diện thương hiệu
GET /v1/email-marketing/brand-kit — Bộ nhận diện thương hiệu của tổ chức (tên, biểu trưng, màu sắc, phông chữ, văn phong). Thao tác getEmailMarketingBrandKit. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
PUT /v1/email-marketing/brand-kit — Chỉnh sửa bộ nhận diện thương hiệu. Thao tác updateEmailMarketingBrandKit. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/email-marketing/brand-kit/read — Đọc bộ nhận diện thương hiệu từ trang web của tổ chức. Thao tác readEmailMarketingBrandKit. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
Danh bạ và tin nhắn một lần
GET /v1/email-marketing/contacts — Danh bạ của tổ chức, mỗi lần một trang keyset. Thao tác listEmailMarketingContacts. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/contacts/{contact_id}/messages — Gửi một tin nhắn SMS tới một người liên hệ, thanh toán từ số dư tín dụng Zinn®. Thao tác sendEmailMarketingMessage. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: chỉ API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn mức, vì vậy con người sẽ nhấn (một tin nhắn gửi một lần tới một người liên hệ sẽ tiêu tốn hạn mức).
GET /v1/email-marketing/messages — Các tin nhắn SMS và WhatsApp mà tổ chức đã gửi, tin mới nhất hiển thị trước, một trang keyset. Thao tác listEmailMarketingMessages. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
Danh sách
GET /v1/email-marketing/lists — Danh sách gửi thư của tổ chức cùng số lượng đã đăng ký / đã hủy đăng ký. Thao tác listEmailMarketingLists. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/lists — Tạo một danh sách gửi thư (hoặc trả về danh sách có tên đó). Thao tác createEmailMarketingList. Các quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/lists/{list_id}/members — Thêm liên hệ vào danh sách theo địa chỉ email (tối đa 1.000 liên hệ mỗi yêu cầu). Thao tác addEmailMarketingListMembers. Các quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
Nhập dữ liệu
GET /v1/email-marketing/imports — Các lần nhập liên hệ trước đây, mới nhất trước, mỗi lần một trang keyset. Thao tác listEmailMarketingImports. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/imports — Nhập một nhóm liên hệ kèm theo chứng thực chấp thuận. Thao tác createEmailMarketingImport. Các quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
Biểu mẫu đăng ký
GET /v1/email-marketing/forms — Biểu mẫu đăng ký (xác nhận kép), mới nhất trước, một trang keyset. Thao tác listEmailMarketingForms. Quyền hạn được kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/forms — Tạo biểu mẫu đăng ký để thêm những người đã xác nhận vào một danh sách. Thao tác createEmailMarketingForm. Quyền hạn được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
DELETE /v1/email-marketing/forms/{form_id} — Xóa biểu mẫu đăng ký (những người đã xác nhận vẫn ở trong danh sách). Thao tác deleteEmailMarketingForm. Quyền hạn được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
PATCH /v1/email-marketing/forms/{form_id} — Thay đổi biểu mẫu đăng ký (câu chữ, danh sách, chuyển hướng, bật hoặc tắt). Thao tác updateEmailMarketingForm. Quyền hạn được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
Kết nối gửi
GET /v1/email-marketing/senders — Các kết nối gửi của tổ chức. Thao tác listEmailMarketingSenders. Các quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/senders — Kết nối người gửi chiến dịch (tính năng gửi của Zinn® hoặc máy chủ SMTP riêng của khách hàng). Thao tác createEmailMarketingSender. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: chỉ API và bảng điều khiển: mang theo thông tin bí mật tuyệt đối không được chuyển đến mô hình AI (nội dung là mật khẩu SMTP).
DELETE /v1/email-marketing/senders/{sender_id} — Xóa một kết nối gửi và mật khẩu đã lưu của kết nối đó. Thao tác deleteEmailMarketingSender. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/senders/{sender_id}/verify — Xác minh kết nối gửi hoạt động mà không cần gửi bất kỳ nội dung nào. Thao tác verifyEmailMarketingSender. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
PUT /v1/email-marketing/senders/{sender_id}/webhook — Lưu trữ bí mật ký webhook của nhà cung cấp e-mail của quý khách cho kết nối này. Thao tác setEmailMarketingSenderWebhook. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải do quý khách (lưu trữ bí mật webhook của nhà cung cấp).
SMS và WhatsApp
GET /v1/email-marketing/sms — Những gì màn hình SMS cần — đang mở?, đã tạm dừng?, số dư tín dụng và giá. Thao tác getEmailMarketingSms. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
GET /v1/email-marketing/sms/campaigns — Các chiến dịch SMS hàng loạt, mới nhất trước, một trang keyset. Thao tác listSmsMarketingCampaigns. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/sms/campaigns — Tạo một bản nháp SMS cho danh sách. Thao tác createSmsMarketingCampaign. Các quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — Một chiến dịch SMS hàng loạt. Thao tác getSmsMarketingCampaign. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Chỉnh sửa bản nháp (hoặc chiến dịch bị từ chối chuyển về lại bản nháp). Thao tác updateSmsMarketingCampaign. Các quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Số liệu của một chiến dịch SMS hàng loạt. Thao tác getSmsMarketingCampaignReport. Các quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Bắt đầu gửi SMS đến mọi người trong danh sách đã đồng ý nhận SMS — hoặc tiếp tục chiến dịch bị tạm dừng do thiếu số dư. Thao tác sendSmsMarketingCampaign. Quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn mức, vì vậy con người phải tự nhấn (gửi tin nhắn SMS/WhatsApp trả phí).
GET /v1/email-marketing/sms/registrations/us — Bản đăng ký US 10DLC của tổ chức này và chi phí tương ứng. Thao tác getEmailMarketingUsRegistration. Quyền được kiểm tra: email_marketing.view. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/email-marketing/sms/registrations/us — Gửi thương hiệu và chiến dịch của tổ chức này để đăng ký US 10DLC (tính phí khi gửi). Thao tác submitEmailMarketingUsRegistration. Quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn mức, vì vậy con người phải tự nhấn (đăng ký US 10DLC có tính phí nhà mạng).
Chiến dịch qua dịch vụ email của riêng bạn (mẫu, phân khúc, danh sách chặn)
GET /v1/campaigns — Các chiến dịch của tổ chức. Thao tác listCampaigns. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/campaigns — Tạo một chiến dịch từ một mẫu và đối tượng người nhận. Thao tác createCampaign. Từ trợ lý AI: Có, thông qua MCP.
DELETE /v1/campaigns/esp — Ngắt kết nối tài khoản nhà cung cấp và xóa khóa đã lưu của tài khoản đó. Thao tác disconnectEsp. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: yêu cầu này chứa bí mật tuyệt đối không được chuyển đến mô hình AI (hủy khóa ESP đã lưu).
GET /v1/campaigns/esp — Tài khoản nhà cung cấp email của chính tổ chức. Thao tác getEspConnection. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/campaigns/esp — Kết nối tài khoản nhà cung cấp email. Thao tác connectEsp. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: yêu cầu này chứa bí mật tuyệt đối không được chuyển đến mô hình AI (phần thân là khóa API ESP).
POST /v1/campaigns/esp/verify — Xác minh tài khoản nhà cung cấp hoạt động và đọc các miền đã xác minh của tài khoản đó. Thao tác verifyEspConnection. Từ trợ lý AI: Chỉ qua API và bảng điều khiển: yêu cầu này chứa bí mật tuyệt đối không được chuyển đến mô hình AI (kiểm tra lại khóa ESP đã lưu).
POST /v1/campaigns/preview — Render một mẫu với các giá trị ví dụ. Thao tác previewCampaignTemplate. Từ trợ lý AI: Có, thông qua MCP.
GET /v1/campaigns/segments — Các phân khúc đối tượng đã lưu của bạn. Thao tác listCampaignSegments. Quyền được kiểm tra: campaigns.view. Từ trợ lý AI: Có, thông qua MCP.
POST /v1/campaigns/segments — Lưu một phân khúc đối tượng mới. Thao tác createCampaignSegment. Quyền được kiểm tra: campaigns.manage. Từ trợ lý AI: Có, thông qua MCP.
GET /v1/campaigns/segments/fields — Từ vựng bộ lọc, danh sách giá trị của nó và các thẻ ma thuật. Thao tác getCampaignSegmentFields. Quyền đã kiểm tra: campaigns.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/campaigns/segments/preview — Số lượng người tiếp cận được, họ là ai và những ai bị loại trừ. Thao tác previewCampaignSegment. Quyền đã kiểm tra: campaigns.view. Từ trợ lý AI: có, thông qua MCP.
DELETE /v1/campaigns/segments/{segmentId} — Lưu trữ một phân khúc. Thao tác archiveCampaignSegment. Quyền đã kiểm tra: campaigns.manage. Từ trợ lý AI: có, thông qua MCP.
GET /v1/campaigns/segments/{segmentId} — Một phân khúc đã lưu. Thao tác getCampaignSegment. Quyền đã kiểm tra: campaigns.view. Từ trợ lý AI: có, thông qua MCP.
PATCH /v1/campaigns/segments/{segmentId} — Đổi tên phân khúc hoặc thay đổi bộ lọc của phân khúc đó. Thao tác updateCampaignSegment. Quyền đã kiểm tra: campaigns.manage. Từ trợ lý AI: có, thông qua MCP.
GET /v1/campaigns/suppressions — Các địa chỉ không được nhận nội dung tiếp thị. Thao tác listCampaignSuppressions. Quyền đã kiểm tra: campaigns.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/campaigns/suppressions — Thêm một địa chỉ vào danh sách chặn gửi. Thao tác createCampaignSuppression. Quyền đã kiểm tra: campaigns.manage. Từ trợ lý AI: có, thông qua MCP.
GET /v1/campaigns/tags — Bảng thẻ ma thuật do trình soạn chiến dịch cung cấp. Thao tác listCampaignTags. Từ trợ lý AI: có, thông qua MCP.
GET /v1/campaigns/templates — Các mẫu chiến dịch của tổ chức. Thao tác listCampaignTemplates. Từ trợ lý AI: có, thông qua MCP.
POST /v1/campaigns/templates — Tạo mẫu chiến dịch. Thao tác createCampaignTemplate. Từ trợ lý AI: có, thông qua MCP.
DELETE /v1/campaigns/templates/{templateId} — Lưu trữ mẫu và hủy kích hoạt các nguồn dịch của mẫu đó. Thao tác archiveCampaignTemplate. Từ trợ lý AI: có, thông qua MCP.
GET /v1/campaigns/templates/{templateId} — Một mẫu chiến dịch. Thao tác getCampaignTemplate. Từ trợ lý AI: có, thông qua MCP.
PUT /v1/campaigns/templates/{templateId} — Chỉnh sửa mẫu chiến dịch. Thao tác updateCampaignTemplate. Từ trợ lý AI: có, thông qua MCP.
POST /v1/campaigns/unsubscribe — Rời khỏi danh sách tiếp thị. Không cần tài khoản. Thao tác unsubscribeFromCampaigns. Từ trợ lý AI: chỉ API và bảng điều khiển: chức năng này mang khóa bí mật tuyệt đối không được chuyển đến mô hình AI (nhận mã token hủy đăng ký có chữ ký của người nhận).
DELETE /v1/campaigns/{campaignId} — Xóa chiến dịch và loại bỏ các hàng phân phối của chiến dịch đó. Thao tác deleteCampaign. Từ trợ lý AI: chỉ API và bảng điều khiển: chức năng này yêu cầu quyền không được cấp cho các kết nối AI (việc xóa chiến dịch ESP cần campaigns.send).
GET /v1/campaigns/{campaignId} — Một chiến dịch và báo cáo phân phối của chiến dịch đó. Thao tác getCampaign. Từ trợ lý AI: có, thông qua MCP.
POST /v1/campaigns/{campaignId}/control — Tạm dừng, tiếp tục hoặc hủy một lượt gửi đang chạy. Thao tác controlCampaign. Từ trợ lý AI: chỉ API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn ngạch, do đó người dùng sẽ nhấn (tạm dừng/tiếp tục một lượt gửi trực tiếp).
POST /v1/campaigns/{campaignId}/send — Bắt đầu lượt gửi dài hạn. Thao tác sendCampaign. Từ trợ lý AI: chỉ API và bảng điều khiển: thao tác này tiêu tốn tiền hoặc hạn ngạch, do đó người dùng sẽ nhấn (gửi chiến dịch ESP đến người nhận thực).
POST /v1/campaigns/{campaignId}/test — Gửi một tin nhắn thực trên kênh mà chiến dịch sẽ thực sự sử dụng. Thao tác testSendCampaign. Từ trợ lý AI: chỉ API và bảng điều khiển: thao tác này cần quyền hạn mà các kết nối AI không được cung cấp (lượt gửi thử nghiệm ESP cần có campaigns.send).
Các trang công khai và webhook gửi đến
GET /v1/public/email-marketing/c/{token} — Bộ đếm lượt nhấp. Ghi lại một lượt nhấp cho mỗi người nhận và chuyển hướng đến liên kết gốc. Thao tác emailMarketingClick. Từ trợ lý AI: trang mà người nhận của bạn mở từ email (chuyển hướng theo dõi lượt nhấp).
GET /v1/public/email-marketing/f/{public_id} — Trang được lưu trữ của biểu mẫu đăng ký (không cần đăng nhập). Thao tác emailMarketingFormPage. Từ trợ lý AI: trang mà người nhận của bạn mở từ email (trang biểu mẫu đăng ký công khai).
POST /v1/public/email-marketing/f/{public_id} — Gửi biểu mẫu đăng ký (trang được lưu trữ, mã nhúng hoặc JSON). Thao tác emailMarketingFormSubmit. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải do bạn (khách truy cập gửi biểu mẫu đăng ký).
GET /v1/public/email-marketing/fc — Trang xác nhận chọn tham gia kép (double opt-in) (không cần đăng nhập). Thao tác emailMarketingFormConfirmPage. Từ trợ lý AI: trang mà người nhận của bạn mở từ email (trang xác nhận chọn tham gia kép).
POST /v1/public/email-marketing/fc — Xác nhận đăng ký (thêm người đó vào danh sách cùng với bản ghi đồng ý). Thao tác emailMarketingFormConfirm. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải do bạn (khách truy cập xác nhận chọn tham gia kép).
GET /v1/public/email-marketing/o/{token} — Hình ảnh theo dõi lượt mở (tệp GIF 1x1). Tính một lượt mở cho mỗi người nhận. Thao tác emailMarketingOpenPixel. Từ trợ lý AI: trang mà người nhận của bạn mở từ email (pixel theo dõi lượt mở).
GET /v1/public/email-marketing/u/{token} — Liên kết hủy đăng ký ở chân trang (không cần đăng nhập). Thao tác emailMarketingUnsubscribePage. Từ trợ lý AI: trang mà người nhận của bạn mở từ email (trang hủy đăng ký).
POST /v1/public/email-marketing/u/{token} — Hủy đăng ký bằng một cú nhấp theo RFC 8058 (và nút "dừng mọi thứ" của trang). Thao tác emailMarketingUnsubscribeOneClick. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải bởi quý vị (hủy đăng ký bằng một cú nhấp theo RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — Liên kết hủy đăng ký của thư làm ấm nhóm tiếp thị (không cần đăng nhập). Thao tác emailMarketingWarmupUnsubscribePage. Từ trợ lý AI: trang mà người nhận của quý vị mở từ một email (trang hủy đăng ký làm ấm).
POST /v1/public/email-marketing/warmup-u/{token} — Hủy đăng ký bằng một cú nhấp theo RFC 8058 từ thư làm ấm. Thao tác emailMarketingWarmupUnsubscribeOneClick. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải bởi quý vị (hủy đăng ký làm ấm bằng một cú nhấp).
POST /v1/webhooks/campaign-events — Nhập sự kiện gửi thư đã ký từ nhà cung cấp email. Thao tác receiveCampaignDeliveryWebhook. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải bởi quý vị (webhook gửi thư ESP đã ký).
POST /v1/webhooks/campaigns/telnyx — Phản hồi SMS đến (STOP / START) từ nhà cung cấp dịch vụ SMS của chúng tôi. Thao tác receiveCampaignsTelnyxInbound. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải bởi quý vị (webhook đến đã ký từ Telnyx).
POST /v1/webhooks/email-marketing/{connection_id} — Các sự kiện gửi thư của nhà cung cấp email riêng của khách hàng cho một kết nối gửi. Thao tác receiveEmailMarketingProviderWebhook. Từ trợ lý AI: được gọi bởi một hệ thống khác (nhà cung cấp hoặc khách truy cập), không phải bởi quý khách (webhook đã ký từ người gửi-nhà cung cấp).
Luồng
GET /v1/email-marketing/flows — Các luồng email (chào mừng, nhỏ giọt, một ngày hằng năm), một trang keyset. Thao tác listEmailMarketingFlows. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/flows — Tạo một luồng (bắt đầu dưới dạng bản nháp). Thao tác createEmailMarketingFlow. Quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
DELETE /v1/email-marketing/flows/{flow_id} — Xóa một luồng và các lượt ghi danh của nó (các lượt chạy đã gửi vẫn được giữ lại, dưới dạng chiến dịch). Thao tác deleteEmailMarketingFlow. Quyền đã kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
GET /v1/email-marketing/flows/{flow_id} — Một luồng cùng các bước và báo cáo của nó (đã ghi danh, đang xử lý, các lượt chạy và người nhận theo từng bước). Thao tác getEmailMarketingFlow. Quyền đã kiểm tra: email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
PATCH /v1/email-marketing/flows/{flow_id} — Thay đổi một quy trình; khi được cung cấp, steps sẽ thay thế toàn bộ chuỗi. Thao tác updateEmailMarketingFlow. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/flows/{flow_id}/activate — Bật một quy trình; chỉ những người tham gia danh sách từ thời điểm này trở đi mới được ghi danh. Thao tác activateEmailMarketingFlow. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.
POST /v1/email-marketing/flows/{flow_id}/pause — Tạm dừng một quy trình; các bước đến hạn sẽ chờ và không có người mới nào nhận được thư cho đến khi quy trình được bật lại. Thao tác pauseEmailMarketingFlow. Các quyền được kiểm tra: email_marketing.manage, email_marketing.view. Từ trợ lý AI: có, thông qua MCP.