인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
조직 ID가 들어가는 위치
이 엔드포인트는 JSON 본문의 필드로 org_id을(를) 받습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X POST https://api.zinndigital.com/v1/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "template_id": <string> }'로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
Create a campaign from a template and an audience segment. It is created as a draft and sends nothing until the send endpoint is called.
요청 본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | — |
template_id | string | 예 | — |
segment_id | string | 아니요 | — |
channels | string<email, in_app, slack, telegram>[] | 아니요 | — |
scheduled_for | string | 아니요 | — |
include_not_in_good_standing | boolean | 아니요 | ⚖️ Suspended and unpaid organisations are excluded by default (CLAUDE.md §2.46); this is the explicit per-campaign override that makes a win-back campaign possible. The skip is… |
org_id | string | 아니요 | — |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
id | string | 예 | — |
org_id | string | 예 | — |
name | string | 예 | — |
template_id | string | 예 | — |
segment_id | string | 아니요 | — |
purpose | string<marketing, transactional> | 예 | — |
channels | string[] | 예 | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | 예 | — |
scheduled_for | string | 아니요 | — |
include_not_in_good_standing | boolean | 아니요 | — |
total_recipients | integer | 예 | — |
skipped | CampaignSkipCounts | 예 | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | CampaignDeliveryCounts | 아니요 | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
last_error | string | 아니요 | — |
created_at | string | 예 | — |
started_at | string | 아니요 | — |
finished_at | string | 아니요 | — |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 422