Zinn® Campaigns API 및 MCP: 개발자 가이드

대시보드의 Zinn® Campaigns에서 수행할 수 있는 모든 작업은 API를 통해서도 수행할 수 있으며, 대부분은 MCP를 통해 계정에 연결된 AI 어시스턴트에서도 수행할 수 있습니다. 이 가이드에서는 로그인, 권한, 두 가지 방식 모두에 대한 실제 예제, 제한 사항, 오류 및 89개의 모든 Campaigns 작업을 다룹니다. 아래 작업 목록은 당사의 API 사양을 기반으로 생성되므로 API의 실제 동작과 항상 일치합니다. 모든 작업의 모든 필드는 zinndigital.com/developers/api/zinn-campaigns의 API 참조 문서에서 확인하실 수 있습니다.

로그인

• API 키. 대시보드의 설정 → API 키에서 키를 생성하고 Authorization: Bearer zdk_live_…로 전송하십시오(샌드박스 모드에서는 zdk_test_… 키가 작동합니다). 키에는 필요한 Campaigns 권한만 부여하고 그 이상의 권한은 부여하지 마십시오.
• AI 어시스턴트(MCP). 앱에서 로그인하거나 연결 토큰(zmcp_live_…)을 사용하여 Claude, ChatGPT, Cursor 또는 임의의 MCP 클라이언트를 https://api.zinndigital.com/v1/mcp에 연결하십시오. 계정에 Claude, Cursor 또는 ChatGPT 연결하기를 참조하십시오. 동의 화면에서 Zinn® Campaigns 권한을 선택하십시오.
• 권한. email_marketing.view는 캠페인, 목록, 연락처, 양식, 발신자, SMS 설정 및 보고서를 읽습니다. email_marketing.manage는 이를 생성하고 수정합니다. 자체 이메일 서비스를 통해 전송하는 캠페인은 campaigns.view 및 campaigns.manage를 사용합니다.
• 리셀러. 고객 조직 중 하나를 대상으로 작업하려면 org_id를 전달하십시오. 키 또는 연결이 정확히 하나의 조직에만 연결되는 경우에는 생략하십시오.

예제: 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"
}'

응답은 초안과 함께 201입니다. POST /v1/email-marketing/campaigns/{campaign_id}/test로 테스트하고, GET /v1/email-marketing/campaigns/{campaign_id}/lint로 확인하며, POST /v1/email-marketing/campaigns/{campaign_id}/send로 전송하십시오.

예시: AI 어시스턴트의 동일한 초안

어시스턴트에게 일상적인 말로 요청하십시오. 예를 들어 "'Our spring sale starts today'라는 제목으로 Spring sale이라는 Zinn® Campaigns 이메일 초안을 작성해 줘"와 같이 요청할 수 있습니다. 백그라운드에서 어시스턴트는 api_operations_search로 작업을 찾고, api_operation_get으로 매개변수를 읽은 다음, 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"
      }
    }
  }
}

어시스턴트가 수행하지 않는 작업. 수신자에게 발송되거나 비용 또는 할당량을 소모하는 모든 작업(캠페인 발송, SMS 또는 WhatsApp 메시지 발송, AI 크레딧을 사용한 작성, US 문자 메시지 등록)은 어시스턴트에게 허용되지 않으므로, 잘못 이해된 지침이 고객에게 도달하는 일은 절대 없습니다. 어시스턴트는 초안을 준비하며, 대시보드에서 보내기를 누르거나 API를 직접 호출하셔야 합니다. SMTP 비밀번호와 같은 보안 정보도 어시스턴트를 통해 전달되지 않습니다. 대시보드에 직접 입력하십시오.

제한 사항

• 개인 또는 API 키당 분당 1,200건의 요청, 조직당 분당 6,000건의 요청. 둘 중 더 엄격한 기준이 적용됩니다.
• MCP 연결당 분당 600건의 요청.
• 한도를 초과하면 Retry-After 헤더와 함께 429 응답이 반환됩니다. 해당 시간(초)만큼 기다려 주십시오.
• 목록 구성원 추가는 요청당 최대 1,000개의 주소를 처리할 수 있으며, 요금제의 연락처 및 이메일 할당량은 API를 통해 수행하는 모든 작업에 적용됩니다.

오류

모든 오류는 동일한 형식을 갖습니다:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

동일한 문제에 대해 code는 절대 변경되지 않으므로 message 대신 이를 테스트하십시오. 고객 지원팀에 문의할 때는 request_id를 알려주십시오. 표시되는 응답은 다음과 같습니다. 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403은 키 또는 연결에 아래 나열된 권한이 없음을 의미합니다. 404는 볼 수 없는 조직의 항목도 포함합니다. 422는 잘못된 각 필드를 details에 나열합니다. 429가 발생한 후에는 Retry-After 헤더에 지정된 시간(초)만큼 대기하십시오.

웹훅

전송 결과는 이메일을 발송하는 제공업체로부터 Zinn® Campaigns로 유입됩니다.

• 자체 제공업체(예: Resend)를 사용하는 경우, 대시보드(캠페인 → 발송)의 발송 연결에 해당 제공업체의 웹훅 서명 비밀키를 저장하십시오. webhook_url이 제공되면 제공업체의 전송 성공, 반송 및 스팸 신고 이벤트를 해당 주소로 지정하십시오. 반송 또는 스팸 신고가 발생하면 향후 발송 대상에서 해당 주소가 즉시 제거됩니다.
• Zinn® 발송 기능을 사용하면 아무것도 설정할 필요가 없습니다.

보고서 작업(getEmailMarketingCampaignReport, getSmsMarketingCampaignReport)을 통해 결과를 확인하십시오.

모든 Campaigns 작업

개요

• GET /v1/email-marketing — 단일 조직을 위한 Zinn® Campaigns 개요입니다. 작업 이름: getEmailMarketingOverview. 확인된 권한: email_marketing.view. 인공지능 어시스턴트 지원: 예, MCP를 통해 지원.

이메일 캠페인

• GET /v1/email-marketing/campaigns — 이메일 캠페인 목록, 최신순, 키셋 1페이지. 작업 listEmailMarketingCampaigns. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• POST /v1/email-marketing/campaigns — 이메일 캠페인 초안 생성. 작업 createEmailMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• GET /v1/email-marketing/campaigns/{campaign_id} — 단일 이메일 캠페인. 작업 getEmailMarketingCampaign. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — 초안 수정(또는 거부된 캠페인 수정, 초안 상태로 되돌아감). 작업 updateEmailMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — 캠페인을 전송하기 전에 본문 문구의 전송 성공률 문제를 검사합니다. 작업 lintEmailMarketingCampaign. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — 캠페인 지표. 작업 getEmailMarketingCampaignReport. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — 캠페인을 수신자 목록으로 전송하기 시작합니다. 작업: sendEmailMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: API 및 대시보드 전용: 비용이나 할당량이 소모되므로 담당자가 직접 눌러야 합니다(실제 수신자에게 전송되며 할당량이 소모됨).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — 조직 구성원에게 지금 테스트 사본 1건을 보냅니다. 작업: testEmailMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — 누락되었거나 오래된 모든 연락처 언어로 캠페인을 번역합니다. 작업: translateEmailMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — 캠페인 목록의 각 연락처 언어 및 번역의 최신 상태 여부를 조회합니다. 작업: listEmailMarketingCampaignTranslations. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.

AI로 작성하기

• POST /v1/email-marketing/ai/write — Zinn® AI를 사용하여 짧은 브리프를 바탕으로 캠페인 이메일 초안을 작성합니다. 작업: writeEmailMarketingCampaignWithAi. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: API 및 대시보드 전용. 비용 또는 허용량이 소모되므로 사람이 직접 클릭해야 합니다(AI 작성 시 AI 크레딧이 소모됨).

브랜드 키트

• GET /v1/email-marketing/brand-kit — 조직의 브랜드 키트(이름, 로고, 색상, 글꼴, 톤앤매너)입니다. 작업: getEmailMarketingBrandKit. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 지원됨(MCP를 통해 이용 가능).
• PUT /v1/email-marketing/brand-kit — 브랜드 키트를 수정합니다. 작업: updateEmailMarketingBrandKit. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 지원됨(MCP를 통해 이용 가능).
• POST /v1/email-marketing/brand-kit/read — 조직의 웹사이트에서 브랜드 키트를 읽어옵니다. 작업: readEmailMarketingBrandKit. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 지원됨(MCP를 통해 이용 가능).

연락처 및 일회성 메시지

• GET /v1/email-marketing/contacts — 조직의 연락처 목록이며 한 번에 키셋 한 페이지씩 제공됩니다. 작업: listEmailMarketingContacts. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 가능합니다.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Zinn® 크레딧 잔액에서 차감하여 단일 연락처로 SMS 1건을 전송합니다. 작업: sendEmailMarketingMessage. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: API 및 대시보드 전용. 비용 또는 허용량이 소모되므로 사용자가 직접 눌러야 합니다(연락처로의 일회성 메시지는 허용량을 소모함).
• GET /v1/email-marketing/messages — 조직이 전송한 SMS 및 WhatsApp 메시지 목록이며 최신순으로 키셋 한 페이지씩 제공됩니다. 작업: listEmailMarketingMessages. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 가능합니다.

목록

• GET /v1/email-marketing/lists — 구독/구독 취소 수가 포함된 조직의 메일링 리스트입니다. 작업 listEmailMarketingLists. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/lists — 메일링 리스트를 생성합니다(또는 해당 이름의 메일링 리스트를 반환합니다). 작업 createEmailMarketingList. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/lists/{list_id}/members — 이메일 주소로 리스트에 연락처를 추가합니다(요청당 최대 1,000개). 작업 addEmailMarketingListMembers. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.

가져오기

• GET /v1/email-marketing/imports — 과거 연락처 가져오기 내역으로, 최신순으로 정렬되며 한 번에 하나의 키셋 페이지를 표시합니다. 작업 listEmailMarketingImports. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/imports — 동의 증명과 함께 연락처 덩어리 하나를 가져옵니다. 작업 createEmailMarketingImport. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.

가입 양식

• GET /v1/email-marketing/forms — 가입 양식(더블 옵트인), 최신순, 키셋 1페이지. 작업 listEmailMarketingForms. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• POST /v1/email-marketing/forms — 확인된 사람을 단일 목록에 추가하는 가입 양식을 생성합니다. 작업 createEmailMarketingForm. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• DELETE /v1/email-marketing/forms/{form_id} — 가입 양식을 삭제합니다(이미 확인된 사람은 목록에 유지됨). 작업 deleteEmailMarketingForm. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• PATCH /v1/email-marketing/forms/{form_id} — 가입 양식을 변경합니다(문구, 목록, 리디렉션, 켜기 또는 끄기). 작업 updateEmailMarketingForm. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.

발송 연결

• GET /v1/email-marketing/senders — 조직의 발송 연결입니다. 작업 listEmailMarketingSenders. 확인된 권한: email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/senders — 캠페인 발신자를 연결합니다 (Zinn® 발송 또는 고객 소유의 SMTP 서버). 작업 createEmailMarketingSender. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: API 및 대시보드 전용: AI 모델에 절대 전달되어서는 안 되는 비밀 정보를 포함합니다 (본문이 SMTP 비밀번호임).
• DELETE /v1/email-marketing/senders/{sender_id} — 발송 연결 및 저장된 비밀번호를 제거합니다. 작업 deleteEmailMarketingSender. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/email-marketing/senders/{sender_id}/verify — 아무것도 발송하지 않고 발송 연결이 작동하는지 검증합니다. 작업 verifyEmailMarketingSender. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — 이 연결에 대한 이메일 제공업체의 웹후크 서명 암호를 저장합니다. 작업 setEmailMarketingSenderWebhook. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 사용자가 아닌 다른 시스템(제공업체 또는 방문자)에 의해 호출됩니다 (제공업체의 웹후크 암호를 저장함).

SMS 및 WhatsApp

• GET /v1/email-marketing/sms — SMS 화면에 필요한 항목 — 열림 여부, 일시 중지 여부, 크레딧 잔액 및 가격. 작업 getEmailMarketingSms. 확인된 권한: email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• GET /v1/email-marketing/sms/campaigns — 대량 SMS 캠페인, 최신순, 단일 키셋 페이지. 작업 listSmsMarketingCampaigns. 확인된 권한: email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• POST /v1/email-marketing/sms/campaigns — 목록에 보낼 초안 SMS를 만듭니다. 작업 createSmsMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — 단일 대량 SMS 캠페인. 작업 getSmsMarketingCampaign. 확인된 권한: email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — 초안(또는 초안 상태로 돌아간 거부된 캠페인)을 수정합니다. 작업 updateSmsMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — 대량 SMS 캠페인의 수치. 작업 getSmsMarketingCampaignReport. 확인된 권한: email_marketing.view. AI 어시스턴트 지원: 예, MCP를 통해 지원.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — SMS 수신에 동의한 목록의 모든 사용자에게 SMS 발송을 시작하거나, 크레딧 문제로 일시 중지된 발송을 재개합니다. 작업 sendSmsMarketingCampaign. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 사용 여부: API 및 대시보드 전용: 비용이나 허용량이 소모되므로 사람이 직접 눌러야 합니다(유료 SMS/WhatsApp 메시지 발송).
• GET /v1/email-marketing/sms/registrations/us — 이 조직의 US 10DLC 등록 정보 및 관련 비용입니다. 작업 getEmailMarketingUsRegistration. 확인된 권한: email_marketing.view. AI 어시스턴트 사용 여부: 예, MCP를 통해 가능합니다.
• POST /v1/email-marketing/sms/registrations/us — US 10DLC를 위해 이 조직의 브랜드 및 캠페인을 제출합니다(제출 시 요금 청구). 작업 submitEmailMarketingUsRegistration. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 사용 여부: API 및 대시보드 전용: 비용이나 허용량이 소모되므로 사람이 직접 눌러야 합니다(US 10DLC 등록에는 통신사 수수료가 발생함).

자체 이메일 서비스를 통한 캠페인(템플릿, 세그먼트, 제외 목록)

• GET /v1/campaigns — 조직의 캠페인 목록입니다. 작업 listCampaigns. AI 어시스턴트 사용 여부: 예, MCP를 통해 가능합니다.
• POST /v1/campaigns — 템플릿과 타겟 고객을 기반으로 캠페인을 생성합니다. 작업 createCampaign. AI 어시스턴트 사용 여부: 예, MCP를 통해 가능합니다.
• DELETE /v1/campaigns/esp — 서비스 제공업체 계정 연결을 해제하고 저장된 키를 제거합니다. 작업 disconnectEsp. AI 어시스턴트에서: API 및 대시보드 전용: AI 모델에 절대 도달해서는 안 되는 기밀 정보를 포함합니다(저장된 ESP 키를 파기함).
• GET /v1/campaigns/esp — 조직 자체의 이메일 서비스 제공업체 계정입니다. 작업 getEspConnection. AI 어시스턴트에서: 예, MCP를 통함.
• POST /v1/campaigns/esp — 이메일 서비스 제공업체 계정을 연결합니다. 작업 connectEsp. AI 어시스턴트에서: API 및 대시보드 전용: AI 모델에 절대 도달해서는 안 되는 기밀 정보를 포함합니다(본문이 ESP API 키임).
• POST /v1/campaigns/esp/verify — 서비스 제공업체 계정이 작동하는지 확인하고 검증된 도메인을 읽습니다. 작업 verifyEspConnection. AI 어시스턴트에서: API 및 대시보드 전용: AI 모델에 절대 도달해서는 안 되는 기밀 정보를 포함합니다(저장된 ESP 키를 재확인함).
• POST /v1/campaigns/preview — 예시 값으로 템플릿을 Render합니다. 작업 previewCampaignTemplate. AI 어시스턴트에서: 예, MCP를 통함.
• GET /v1/campaigns/segments — 저장된 타겟층 세그먼트입니다. 작업 listCampaignSegments. 확인된 권한: campaigns.view. AI 어시스턴트에서: 예, MCP를 통함.
• POST /v1/campaigns/segments — 새 타겟층 세그먼트를 저장합니다. 작업 createCampaignSegment. 확인된 권한: campaigns.manage. AI 어시스턴트에서: 예, MCP를 통함.
• GET /v1/campaigns/segments/fields — 필터 어휘, 값 목록 및 매직 태그입니다. 작업 getCampaignSegmentFields. 확인된 권한: campaigns.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/campaigns/segments/preview — 도달 대상 인원수, 대상자 정보 및 제외 대상자 정보입니다. 작업 previewCampaignSegment. 확인된 권한: campaigns.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• DELETE /v1/campaigns/segments/{segmentId} — 세그먼트를 보관합니다. 작업 archiveCampaignSegment. 확인된 권한: campaigns.manage. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• GET /v1/campaigns/segments/{segmentId} — 저장된 단일 세그먼트입니다. 작업 getCampaignSegment. 확인된 권한: campaigns.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• PATCH /v1/campaigns/segments/{segmentId} — 세그먼트 이름을 바꾸거나 필터를 변경합니다. 작업 updateCampaignSegment. 확인된 권한: campaigns.manage. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• GET /v1/campaigns/suppressions — 마케팅을 수신해서는 안 되는 주소 목록입니다. 작업 listCampaignSuppressions. 확인된 권한: campaigns.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• POST /v1/campaigns/suppressions — 수신 제외 목록에 주소를 추가합니다. 작업 createCampaignSuppression. 확인된 권한: campaigns.manage. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원됩니다.
• GET /v1/campaigns/tags — 캠페인 작성기가 제공하는 매직 태그 팔레트입니다. 작업 listCampaignTags. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• GET /v1/campaigns/templates — 조직의 캠페인 템플릿입니다. 작업 listCampaignTemplates. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• POST /v1/campaigns/templates — 캠페인 템플릿을 작성합니다. 작업 createCampaignTemplate. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• DELETE /v1/campaigns/templates/{templateId} — 템플릿을 보관 처리하고 해당 번역 소스를 폐기합니다. 작업 archiveCampaignTemplate. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• GET /v1/campaigns/templates/{templateId} — 캠페인 템플릿 1개입니다. 작업 getCampaignTemplate. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• PUT /v1/campaigns/templates/{templateId} — 캠페인 템플릿을 수정합니다. 작업 updateCampaignTemplate. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• POST /v1/campaigns/unsubscribe — 마케팅 목록에서 탈퇴합니다. 계정이 필요하지 않습니다. 작업 unsubscribeFromCampaigns. AI 어시스턴트 지원: API 및 대시보드 전용: AI 모델에 절대 전달되어서는 안 되는 비밀 정보를 포함합니다(수신자의 서명된 수신 거부 토큰을 받음).
• DELETE /v1/campaigns/{campaignId} — 캠페인을 삭제하고 전송 기록을 폐기합니다. 작업 deleteCampaign. AI 어시스턴트 지원: API 및 대시보드 전용: AI 연결에는 제공되지 않는 권한이 필요합니다(ESP 캠페인 삭제 시 campaigns.send 필요).
• GET /v1/campaigns/{campaignId} — 캠페인 하나 및 해당 캠페인의 전송 보고서입니다. 작업: getCampaign. AI 어시스턴트 지원: 예, MCP를 통해 지원됩니다.
• POST /v1/campaigns/{campaignId}/control — 진행 중인 전송을 일시 중지, 재개 또는 취소합니다. 작업: controlCampaign. AI 어시스턴트 지원: API 및 대시보드 전용: 비용이나 허용량이 소모되므로 사람이 직접 클릭해야 합니다(실시간 전송 일시 중지/재개).
• POST /v1/campaigns/{campaignId}/send — 지속 가능한 전송을 시작합니다. 작업: sendCampaign. AI 어시스턴트 지원: API 및 대시보드 전용: 비용이나 허용량이 소모되므로 사람이 직접 클릭해야 합니다(실제 수신자에게 ESP 캠페인을 전송함).
• POST /v1/campaigns/{campaignId}/test — 캠페인에서 실제로 사용할 채널로 실제 메시지 한 건을 전송합니다. 작업: testSendCampaign. AI 어시스턴트 지원: API 및 대시보드 전용: AI 연결에 제공되지 않는 권한이 필요합니다(ESP 테스트 전송에는 campaigns.send 필요).

공개 페이지 및 수신 웹훅

• GET /v1/public/email-marketing/c/{token} — 클릭 수 카운터입니다. 수신자당 1회의 클릭을 기록하고 원래 링크로 리디렉션합니다. 작업: emailMarketingClick. AI 어시스턴트 지원: 수신자가 이메일에서 여는 페이지(클릭 추적 리디렉션).
• GET /v1/public/email-marketing/f/{public_id} — 호스팅되는 가입 폼 페이지(로그인 불필요)입니다. 작업: emailMarketingFormPage. AI 어시스턴트 지원: 수신자가 이메일에서 여는 페이지(공개 가입 폼 페이지).
• POST /v1/public/email-marketing/f/{public_id} — 가입 양식을 제출합니다(호스팅된 페이지, 삽입 코드 또는 JSON). 작업 emailMarketingFormSubmit. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에 의해 호출됩니다(방문자가 가입 양식을 제출함).
• GET /v1/public/email-marketing/fc — 이중 수신 동의 확인 페이지(로그인 불필요). 작업 emailMarketingFormConfirmPage. AI 어시스턴트 안내: 수신자가 이메일에서 여는 페이지(이중 수신 동의 확인 페이지).
• POST /v1/public/email-marketing/fc — 가입을 확인합니다(동의 기록과 함께 해당 사용자를 목록에 추가). 작업 emailMarketingFormConfirm. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에 의해 호출됩니다(방문자가 이중 수신 동의를 확인함).
• GET /v1/public/email-marketing/o/{token} — 오픈 추적 이미지(1x1 GIF). 수신자당 1회의 오픈을 집계합니다. 작업 emailMarketingOpenPixel. AI 어시스턴트 안내: 수신자가 이메일에서 여는 페이지(오픈 추적 픽셀).
• GET /v1/public/email-marketing/u/{token} — 바닥글 수신 거부 링크(로그인 불필요). 작업 emailMarketingUnsubscribePage. AI 어시스턴트 안내: 수신자가 이메일에서 여는 페이지(수신 거부 페이지).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 원클릭 구독 취소(및 페이지의 "모두 중지" 버튼). 작업 emailMarketingUnsubscribeOneClick. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에서 호출합니다(RFC 8058 원클릭 구독 취소).
• GET /v1/public/email-marketing/warmup-u/{token} — 마케팅 풀 웜업 메일의 구독 취소 링크(로그인 불필요). 작업 emailMarketingWarmupUnsubscribePage. AI 어시스턴트 안내: 수신자가 이메일에서 여는 페이지(웜업 구독 취소 페이지).
• POST /v1/public/email-marketing/warmup-u/{token} — 웜업 메일의 RFC 8058 원클릭 구독 취소. 작업 emailMarketingWarmupUnsubscribeOneClick. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에서 호출합니다(웜업 원클릭 구독 취소).
• POST /v1/webhooks/campaign-events — 이메일 제공업체의 서명된 전송 이벤트를 수신합니다. 작업 receiveCampaignDeliveryWebhook. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에서 호출합니다(서명된 ESP 전송 웹훅).
• POST /v1/webhooks/campaigns/telnyx — SMS 공급업체의 인바운드 SMS 회신(STOP / START). 작업 receiveCampaignsTelnyxInbound. AI 어시스턴트 안내: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에서 호출합니다(서명된 Telnyx 인바운드 웹훅).
• POST /v1/webhooks/email-marketing/{connection_id} — 단일 발송 연결에 대한 고객 자체 이메일 제공업체의 전송 이벤트입니다. 작업: receiveEmailMarketingProviderWebhook. AI 어시스턴트 호출 여부: 귀하가 아닌 다른 시스템(제공업체 또는 방문자)에 의해 호출됩니다(서명된 발신자-제공업체 웹후크).

Flows

• GET /v1/email-marketing/flows — 이메일 흐름(환영, 드립, 연간 특정일), 단일 키셋 페이지입니다. 작업: listEmailMarketingFlows. 확인된 권한: email_marketing.view. AI 어시스턴트 호출 여부: 예, MCP를 통해 호출됩니다.
• POST /v1/email-marketing/flows — 흐름을 만듭니다(초안으로 시작됨). 작업: createEmailMarketingFlow. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 호출 여부: 예, MCP를 통해 호출됩니다.
• DELETE /v1/email-marketing/flows/{flow_id} — 흐름 및 해당 등록 항목을 삭제합니다(발송된 실행 내역은 캠페인으로 유지됨). 작업: deleteEmailMarketingFlow. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 호출 여부: 예, MCP를 통해 호출됩니다.
• GET /v1/email-marketing/flows/{flow_id} — 단계 및 보고서가 포함된 단일 흐름입니다(등록됨, 진행 중, 단계별 실행 횟수 및 수신자). 작업: getEmailMarketingFlow. 확인된 권한: email_marketing.view. AI 어시스턴트 호출 여부: 예, MCP를 통해 호출됩니다.
• PATCH /v1/email-marketing/flows/{flow_id} — 플로우를 변경합니다. steps가 제공되면 전체 시퀀스를 대체합니다. 작업: updateEmailMarketingFlow. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• POST /v1/email-marketing/flows/{flow_id}/activate — 플로우를 활성화합니다. 지금부터 목록에 등록되는 사용자만 참여합니다. 작업: activateEmailMarketingFlow. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.
• POST /v1/email-marketing/flows/{flow_id}/pause — 플로우를 일시 중지합니다. 예정된 단계는 대기 상태가 되며 다시 활성화할 때까지 새로운 사용자에게 메일이 발송되지 않습니다. 작업: pauseEmailMarketingFlow. 확인된 권한: email_marketing.manage, email_marketing.view. AI 어시스턴트 지원 여부: 예, MCP를 통해 지원.