The API can trigger campaigns for app push, web push, Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text messages, email, and LINE according to the project’s channel configuration. Friendtalk is a legacy channel.
Recipient types and personalizationAn unsupported recipient type for the selected channel returns 400 Bad Request.
Channel
Recipient types
App push, web push
user-id
Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text message
user-id, phone-number
Email
user-id, email
LINE
user-id, line-user-id
Use user-id to look up user data for personalization. With other recipient types, Notifly uses the information in the request. For example, in Hello {{ user["name"] }}, the user name is empty and the recipient sees Hello.All recipient types support event parameters.
How Notifly handles duplicatesNotifly sends once per unique device token for app push and web push. It sends once per unique phone number for Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, and text messages. Email uses the email address, and LINE uses the LINE user ID.
Invalid recipients in a 400 responseWhen recipient validation fails, the 400 response includes errorDetails.
Campaign channel. Values are text-message, kakao-alimtalk, kakao-friendtalk, kakao-brand-message, and email.
invalidRecipientCount
number
Number of invalid recipients.
invalidRecipients
array
List of invalid recipients.
invalidRecipients[].index
number
Zero-based index in the request’s recipients array.
invalidRecipients[].type
string
Always user-id.
invalidRecipients[].userId
string
userId supplied in the request.
invalidRecipients[].reasonCode
string
MISSING_PHONE_NUMBER or MISSING_EMAIL.
invalidRecipients[].source.pointer
string
Location of the request field as a JSON Pointer.
Channel
Required field
reasonCode
text-message
phone_number
MISSING_PHONE_NUMBER
kakao-alimtalk
phone_number
MISSING_PHONE_NUMBER
kakao-friendtalk
phone_number
MISSING_PHONE_NUMBER
kakao-brand-message
phone_number
MISSING_PHONE_NUMBER
email
email
MISSING_EMAIL
push-notification, web-push-notification
No contact field check
None
A 400 response contains code, success, and error. Only recipient validation failures add errorDetails. Other 400 errors, such as invalid parameters or an inactive campaign, omit it.
A user-id recipient is invalid if the user exists in Notifly and lacks the required contact information. Notifly skips unknown user IDs.
When partialSend is false or omitted, one invalid recipient causes the entire request to fail with 400 and no messages are sent.
To retry, inspect errorDetails.invalidRecipients and remove the invalid recipients from the request.
Partial sendsSet partialSend to true to send to valid recipients even if other recipients lack a phone number or email address.
With partialSend: false (the default), any invalid recipient causes the request to fail with 400 and sends no messages.
With partialSend: true, Notifly sends to valid recipients and lists the invalid recipients in the response. It returns 200 even when every recipient is invalid.
Example response with partialSend: true and two invalid recipients.
Channels that support partial sends are kakao-alimtalk, kakao-friendtalk, kakao-brand-message, text-message, and email.
This contact information check applies to recipients specified with user-id. It does not apply when you specify the recipient directly with type: "phone-number" or type: "email".
Authorizations
Authorization
string
header
required
Pass the token issued by POST /authenticate as a bearer token.
Path Parameters
projectId
string
required
Project ID.
campaignId
string
required
Campaign ID from the console.
Body
application/json
recipients
object[]
required
List of recipients. Up to 1,000 entries.
Show child attributes
partialSend
boolean
default:false
When true, send to valid recipients even if some recipients lack required phone numbers or email addresses. The response lists any invalid recipients. When false or omitted, an invalid recipient causes the entire request to fail.
Response
The campaign was triggered. If partialSend is true and some recipients are invalid, the response includes errorDetails.
code
integer
success
boolean
error
string | null
errorDetails
object
Included when partialSend is true and one or more recipients are invalid.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Notifly Docs","colors":{"primary":"#0144CD","light":"#3F7BFF"},"logo":{"light":"https://mintcdn.com/notifly/rl-cEZ-semfYDKMK/images/notifly.png?fit=max\u0026auto=format\u0026n=rl-cEZ-semfYDKMK\u0026q=85\u0026s=1fd87113cc3e1e0462340d5e153b1152","dark":"https://mintcdn.com/notifly/rl-cEZ-semfYDKMK/images/notifly.png?fit=max\u0026auto=format\u0026n=rl-cEZ-semfYDKMK\u0026q=85\u0026s=1fd87113cc3e1e0462340d5e153b1152"},"favicon":"https://mintcdn.com/notifly/rl-cEZ-semfYDKMK/favicon.ico?fit=max\u0026auto=format\u0026n=rl-cEZ-semfYDKMK\u0026q=85\u0026s=2161f91102cfa81441a33f4bb6cbc931","appearance":{"default":"light","strict":true},"seo":{"metatags":{"canonical":"https://docs.notifly.tech","author":"Notifly","og:locale":"ko_KR","keywords":"노티플라이, Notifly, push notification, 푸시 알림, 인앱 팝업, in-app message, 마케팅 자동화, marketing automation, 유저 참여, user engagement, 모바일 SDK, mobile SDK, web push, 웹 푸시, 카카오톡, 이메일, SMS, campaign, 캠페인, user journey, 유저 여정, personalization, 개인화, analytics, 분석, Firebase, Android SDK, iOS SDK, React Native, Flutter, JavaScript SDK, GTM, API"},"paths":[{"path":"en","metatags":{"og:locale":"en_US"}},{"path":"ja","metatags":{"og:locale":"ja_JP"}}]},"integrations":{"ga4":{"measurementId":"G-LBWM5EWR3L"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"fonts":{"family":"Pretendard JP","source":"fonts/PretendardJP-SemiBold.woff","format":"woff"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"ko","default":true,"href":"ko"},{"language":"en","href":"en"},{"language":"ja","href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"notifly","hasAudioNarration":false,"actualSubdomain":"notifly","customDomains":["docs.notifly.tech"],"gitSource":{"type":"github","owner":"team-michael","repo":"notifly-event","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b00432041fcdaa6a1cc79a6","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"ko","tag":"User Guides","count":62},{"language":"en","tag":"User Guides","count":59},{"language":"ja","tag":"ユーザーガイド","count":59},{"language":"en","tag":"API Reference","count":50},{"language":"ko","tag":"API Reference","count":50},{"language":"ja","tag":"APIリファレンス","count":50},{"language":"en","tag":"Developer Guides","count":24},{"language":"ja","tag":"開発者ガイド","count":24},{"language":"ko","tag":"Developer Guides","count":23},{"language":"en","tag":"Catalogs","count":18},{"language":"ko","tag":"카탈로그","count":18},{"language":"ja","tag":"カタログ","count":18},{"language":"en","tag":"SDK integration","count":17},{"language":"ko","tag":"개발자 가이드","count":17},{"language":"ja","tag":"SDK連携","count":17},{"language":"ko","tag":"채널","count":16},{"language":"en","tag":"Mobile SDKs","count":13},{"language":"en","tag":"User Journeys","count":13},{"language":"en","tag":"Messaging management","count":13},{"language":"ko","tag":"모바일 SDK","count":13},{"language":"ko","tag":"캠페인","count":13},{"language":"ko","tag":"유저 여정","count":13},{"language":"ko","tag":"메시징 관리","count":13},{"language":"ja","tag":"モバイルSDK","count":13},{"language":"ja","tag":"ユーザージャーニー","count":13},{"language":"ja","tag":"メッセージ配信の管理","count":13},{"language":"en","tag":"Channels","count":12},{"language":"en","tag":"Integrations","count":12},{"language":"ja","tag":"チャネル","count":12},{"language":"ja","tag":"外部連携","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/style.css","content":"@import url(\"https://cdn.jsdelivr.net/gh/orioncactus/pretendard/dist/web/variable/pretendardvariable.css\");:root{--notifly-primary: #0144cd;--notifly-primary-600: #0144cd;--notifly-primary-700: #003bb5;--notifly-primary-100: #e8f0ff;--notifly-ink: #0b1220;--notifly-muted: #5a6473;--notifly-border: #e6e8ec;--mint-color-primary: var(--notifly-primary);--mint-color-primary-contrast: #ffffff;--mint-color-fg: var(--notifly-ink);--mint-color-muted: var(--notifly-muted);--mint-border-color: var(--notifly-border);--notifly-h1: 2rem;--notifly-h2: 1.5rem;--notifly-h3: 1.25rem;--notifly-body: 1rem;--notifly-small: 0.9375rem}html,body{font-family:\"Pretendard Variable\", Pretendard, -apple-system, BlinkMacSystemFont,\n \"Segoe UI\", Roboto, \"Helvetica Neue\", Arial, \"Apple SD Gothic Neo\",\n \"Noto Sans KR\", \"Malgun Gothic\", \"Apple Color Emoji\", \"Segoe UI Emoji\",\n \"Segoe UI Symbol\", sans-serif!important;color:var(--notifly-ink);font-size:16px;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.mdx-content h1,.page-title{font-size:var(--notifly-h1);font-weight:700;letter-spacing:-0.01em}.mdx-content h2{font-size:var(--notifly-h2);font-weight:700;letter-spacing:-0.01em}.mdx-content h3{font-size:var(--notifly-h3);font-weight:600}a,.link{color:var(--notifly-primary);text-underline-offset:2px}a:hover,.link:hover{color:var(--notifly-primary-700)}.topbar-cta-button,.topbar-cta-button a,button.tryit-button,.navbar .button-primary,.button-primary{background:var(--notifly-primary)!important;color:#fff!important;border:1px solid var(--notifly-primary)!important;box-shadow:none!important}.topbar-cta-button:hover,button.tryit-button:hover,.navbar .button-primary:hover,.button-primary:hover{background:var(--notifly-primary-700)!important;border-color:var(--notifly-primary-700)!important}.nav-tabs,.tabs,.TabsBar,.nav-tabs-item{--tab-active: var(--notifly-primary)}.nav-tabs-item[aria-selected=\"true\"],.tabs [aria-selected=\"true\"]{color:var(--notifly-primary);border-bottom-color:var(--notifly-primary)}@media (min-width: 1024px){#sidebar{width:19rem}}.sidebar,.Sidebar,.sidebar-content{font-family:inherit}.sidebar-group-header,.SidebarGroupHeader{font-weight:700}.sidebar a,.sidebar .link,.Sidebar a{color:var(--notifly-ink)}.sidebar a:hover,.Sidebar a:hover{color:var(--notifly-primary)}.sidebar-title,.SidebarTitle{color:var(--notifly-muted);text-transform:uppercase;font-size:0.8rem;letter-spacing:.06em}.sidebar-group-icon{color:var(--notifly-primary)}.eyebrow,.Eyebrow{color:var(--notifly-muted)}code,pre code,.code-block,.CodeBlock{font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\",\n \"Courier New\", monospace!important}.code-block,.CodeBlock{border:1px solid var(--notifly-border)}code{background:#f6f8fa;border-radius:6px;padding:0.1rem 0.3rem}.method-pill,.MethodPill,.method-nav-pill,.MethodNavPill,.nav-tag-pill,.NavTagPill{text-align:center;color:var(--notifly-primary);font-weight:600}.api-playground-input,.APIPlaygroundInput,.RequestExample,.request-example,.ResponseExample,.response-example,.panel,.Panel{border-color:var(--notifly-border)!important}.api-playground-input:focus-within,.search-input:focus,.field:focus-within{outline:2px solid var(--notifly-primary);outline-offset:2px}.search-input,.SearchInput{border:1px solid var(--notifly-border)}.search-input:focus{border-color:var(--notifly-primary)}.callout,.Callout{border-left:4px solid var(--notifly-primary);background:#f8fbff}.table-of-contents a,.toc a,.TableOfContents a{color:var(--notifly-ink)}.table-of-contents a:hover,.toc a:hover,.TableOfContents a:hover{color:var(--notifly-primary)}.pagination-title,.PaginationTitle{color:var(--notifly-primary)}::selection{background:rgba(1, 68, 205, 0.18)}.footer,.Footer{border-top:1px solid var(--notifly-border)}@import url(\"https://cdn.jsdelivr.net/gh/orioncactus/pretendard/dist/web/variable/pretendardvariable.css\");.doccards-gray a.card{background-color:#FFFFFF!important;border-color:#B6BBC1!important;color:#000000!important;border-radius:1.25rem;box-shadow:none!important;transition:transform .15s ease, box-shadow .2s ease, background .2s ease, border-color .2s ease;font-family:\"Pretendard Variable\", Pretendard, -apple-system, BlinkMacSystemFont,\n \"Segoe UI\", Roboto, \"Helvetica Neue\", Arial, \"Apple SD Gothic Neo\",\n \"Noto Sans KR\", sans-serif!important}.doccards-gray a.card:hover,.doccards-gray a.card:focus-visible{background-color:#FFFFFF!important;border-color:#000000!important;transform:translateY(-3px);box-shadow:0 8px 18px rgba(1, 68, 205, .35);outline:none}.doccards-gray a.card [data-component-part=\"card-title\"]{color:#000000!important;font-weight:700!important;font-size:17px!important}.doccards-gray a.card [data-component-part=\"card-content\"],.doccards-gray a.card [data-component-part=\"card-content\"] *{color:#727272!important;font-size:14px!important}.doccards-gray a.card [data-component-part=\"card-icon\"]{color:#727272!important;fill:#727272!important}.doccards-gray a.card [data-component-part=\"card-icon\"]>svg{background-color:#727272!important}.doccards-gray a.card #card-link-arrow-icon{color:#000000!important}.doccards-gray a.card:hover #card-link-arrow-icon{color:#000000!important}.mdx-content table{width:100%;border-collapse:collapse;margin:1.5rem 0;table-layout:fixed;border-radius:10px!important;font-family:\"Pretendard Variable\", Pretendard, -apple-system, BlinkMacSystemFont,\n \"Segoe UI\", Roboto, \"Helvetica Neue\", Arial, \"Apple SD Gothic Neo\",\n \"Noto Sans KR\", sans-serif;font-size:0.95rem;line-height:1.6;border:1px solid #DFE0E4}.mdx-content th{background-color:#F6F6F7;color:#000000;font-weight:600;text-align:left;padding:14px 18px;border:1px solid #DFE0E4}.mdx-content td{background-color:#ffffff;color:#1b1f23;padding:12px 18px;border:1px solid #DFE0E4;vertical-align:middle}.mdx-content thead,.mdx-content tbody{display:table;width:100%;table-layout:fixed}.mdx-content thead tr,.mdx-content tbody tr{display:table-row;width:100%}.mdx-content td:first-child,.mdx-content th:first-child{text-align:left;font-weight:500}.mdx-content tr:nth-child(even) td{background-color:#f9fafc}.mdx-content tr:hover td{background-color:#eff6ff}@media (max-width: 768px){.mdx-content table{font-size:0.9rem}.mdx-content th,.mdx-content td{padding:8px 10px}}.steps .step [data-component-part=\"step-number\"] .size-7{background-color:var(--notifly-primary-600)!important;color:var(--mint-color-primary-contrast)!important}.steps .step>.absolute.w-px{background-color:var(--notifly-primary-600)!important;opacity:1!important}.steps .step:last-of-type>.absolute.w-px{display:none}.steps .step:hover [data-component-part=\"step-number\"] .size-7{background-color:var(--notifly-primary-700)!important}.eyebrow{color:var(--notifly-primary-600)!important}.prose :where(blockquote):not(:where([class~=not-prose],[class~=not-prose] *)){border-inline-start-color:var(--notifly-primary-600)}"}]}
{"page":{"pagePath":"en/api-reference/trigger-campaign","slug":"/en/api-reference/trigger-campaign","pageMetadata":{"title":"Trigger a campaign","description":"Trigger a campaign for the specified recipients.","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/campaigns/{campaignId}/send","href":"/en/api-reference/trigger-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Trigger a campaign for the specified recipients.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Info,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsx(_components.p,{children:`The API can trigger campaigns for app push, web push, Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text messages, email, and LINE according to the project’s channel configuration. Friendtalk is a legacy channel.`})}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Recipient types and personalization`})}),_jsxs(_components.p,{children:[`An unsupported recipient type for the selected channel returns `,_jsx(_components.code,{children:`400 Bad Request`}),`.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Channel`}),_jsx(_components.th,{children:`Recipient types`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`App push, web push`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`user-id`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text message`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`user-id`}),`, `,_jsx(_components.code,{children:`phone-number`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Email`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`user-id`}),`, `,_jsx(_components.code,{children:`email`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`LINE`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`user-id`}),`, `,_jsx(_components.code,{children:`line-user-id`})]})]})]})]}),_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`user-id`}),` to look up user data for personalization. With other recipient types, Notifly uses the information in the request. For example, in `,_jsx(_components.code,{children:`Hello {{ user[\"name\"] }}`}),`, the user name is empty and the recipient sees `,_jsx(_components.code,{children:`Hello`}),`.`]}),_jsx(_components.p,{children:`All recipient types support event parameters.`})]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`How Notifly handles duplicates`})}),_jsx(_components.p,{children:`Notifly sends once per unique device token for app push and web push. It sends once per unique phone number for Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, and text messages. Email uses the email address, and LINE uses the LINE user ID.`})]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Invalid recipients in a 400 response`})}),_jsxs(_components.p,{children:[`When recipient validation fails, the `,_jsx(_components.code,{children:`400`}),` response includes `,_jsx(_components.code,{children:`errorDetails`}),`.`]}),_jsx(CodeBlock,{numberOfLines:`26`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`400`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bad request: invalid recipients\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INVALID_RECIPIENTS\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"channel\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"kakao-friendtalk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invalidRecipientCount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invalidRecipients\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MISSING_PHONE_NUMBER\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"pointer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/recipients/0/userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`12`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_013\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MISSING_PHONE_NUMBER\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"pointer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/recipients/12/userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`reasonCode`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`INVALID_RECIPIENTS`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`channel`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Campaign channel. Values are `,_jsx(_components.code,{children:`text-message`}),`, `,_jsx(_components.code,{children:`kakao-alimtalk`}),`, `,_jsx(_components.code,{children:`kakao-friendtalk`}),`, `,_jsx(_components.code,{children:`kakao-brand-message`}),`, and `,_jsx(_components.code,{children:`email`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipientCount`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`Number of invalid recipients.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`List of invalid recipients.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients[].index`})}),_jsx(_components.td,{children:`number`}),_jsxs(_components.td,{children:[`Zero-based index in the request’s `,_jsx(_components.code,{children:`recipients`}),` array.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients[].type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`user-id`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients[].userId`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`userId`}),` supplied in the request.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients[].reasonCode`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`MISSING_PHONE_NUMBER`}),` or `,_jsx(_components.code,{children:`MISSING_EMAIL`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalidRecipients[].source.pointer`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Location of the request field as a JSON Pointer.`})]})]})]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Channel`}),_jsx(_components.th,{children:`Required field`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`reasonCode`})})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`text-message`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`phone_number`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_PHONE_NUMBER`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`kakao-alimtalk`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`phone_number`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_PHONE_NUMBER`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`kakao-friendtalk`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`phone_number`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_PHONE_NUMBER`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`kakao-brand-message`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`phone_number`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_PHONE_NUMBER`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`email`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`email`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_EMAIL`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`push-notification`}),`, `,_jsx(_components.code,{children:`web-push-notification`})]}),_jsx(_components.td,{children:`No contact field check`}),_jsx(_components.td,{children:`None`})]})]})]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A `,_jsx(_components.code,{children:`400`}),` response contains `,_jsx(_components.code,{children:`code`}),`, `,_jsx(_components.code,{children:`success`}),`, and `,_jsx(_components.code,{children:`error`}),`. Only recipient validation failures add `,_jsx(_components.code,{children:`errorDetails`}),`. Other `,_jsx(_components.code,{children:`400`}),` errors, such as invalid parameters or an inactive campaign, omit it.`]}),`\n`,_jsxs(_components.li,{children:[`A `,_jsx(_components.code,{children:`user-id`}),` recipient is invalid if the user exists in Notifly and lacks the required contact information. Notifly skips unknown user IDs.`]}),`\n`,_jsxs(_components.li,{children:[`When `,_jsx(_components.code,{children:`partialSend`}),` is `,_jsx(_components.code,{children:`false`}),` or omitted, one invalid recipient causes the entire request to fail with `,_jsx(_components.code,{children:`400`}),` and no messages are sent.`]}),`\n`,_jsxs(_components.li,{children:[`To retry, inspect `,_jsx(_components.code,{children:`errorDetails.invalidRecipients`}),` and remove the invalid recipients from the request.`]}),`\n`]})]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Partial sends`})}),_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`partialSend`}),` to `,_jsx(_components.code,{children:`true`}),` to send to valid recipients even if other recipients lack a phone number or email address.`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`With `,_jsx(_components.code,{children:`partialSend: false`}),` (the default), any invalid recipient causes the request to fail with `,_jsx(_components.code,{children:`400`}),` and sends no messages.`]}),`\n`,_jsxs(_components.li,{children:[`With `,_jsx(_components.code,{children:`partialSend: true`}),`, Notifly sends to valid recipients and lists the invalid recipients in the response. It returns `,_jsx(_components.code,{children:`200`}),` even when every recipient is invalid.`]}),`\n`]}),_jsxs(_components.p,{children:[`Example response with `,_jsx(_components.code,{children:`partialSend: true`}),` and two invalid recipients.`]}),_jsx(CodeBlock,{numberOfLines:`26`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INVALID_RECIPIENTS\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"channel\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"kakao-alimtalk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invalidRecipientCount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invalidRecipients\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_002\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MISSING_PHONE_NUMBER\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"pointer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/recipients/1/userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_004\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasonCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MISSING_PHONE_NUMBER\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"pointer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/recipients/3/userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[`Channels that support partial sends are `,_jsx(_components.code,{children:`kakao-alimtalk`}),`, `,_jsx(_components.code,{children:`kakao-friendtalk`}),`, `,_jsx(_components.code,{children:`kakao-brand-message`}),`, `,_jsx(_components.code,{children:`text-message`}),`, and `,_jsx(_components.code,{children:`email`}),`.`]}),_jsx(Note,{children:_jsxs(_components.p,{children:[`This contact information check applies to recipients specified with `,_jsx(_components.code,{children:`user-id`}),`. It does not apply when you specify the recipient directly with `,_jsx(_components.code,{children:`type: \"phone-number\"`}),` or `,_jsx(_components.code,{children:`type: \"email\"`}),`.`]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Trigger a campaign","description":"Trigger a campaign for the specified recipients.","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/campaigns/{campaignId}/send","href":"/en/api-reference/trigger-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/notifly/f0980be26f2ef402/webmcp.js","/_mintlify/custom/notifly/0bc216feae71c939/attribution.js"],"openApiReferenceData":{"operation":{"summary":"trigger-campaign","operationId":"triggerCampaign","security":["a895914f-6f8a-4a1a-9803-5c0658cb3dec"],"x-mint":{"content":"\u003cInfo>\n The API can trigger campaigns for app push, web push, Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text messages, email, and LINE according to the project's channel configuration. Friendtalk is a legacy channel.\n\u003c/Info>\n\n\u003cWarning>\n **Recipient types and personalization**\n\n An unsupported recipient type for the selected channel returns `400 Bad Request`.\n\n | Channel | Recipient types |\n | --- | --- |\n | App push, web push | `user-id` |\n | Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text message | `user-id`, `phone-number` |\n | Email | `user-id`, `email` |\n | LINE | `user-id`, `line-user-id` |\n\n Use `user-id` to look up user data for personalization. With other recipient types, Notifly uses the information in the request. For example, in `Hello {{ user[\"name\"] }}`, the user name is empty and the recipient sees `Hello`.\n\n All recipient types support event parameters.\n\u003c/Warning>\n\n\u003cInfo>\n **How Notifly handles duplicates**\n\n Notifly sends once per unique device token for app push and web push. It sends once per unique phone number for Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, and text messages. Email uses the email address, and LINE uses the LINE user ID.\n\u003c/Info>\n\n\u003cInfo>\n **Invalid recipients in a 400 response**\n\n When recipient validation fails, the `400` response includes `errorDetails`.\n\n ```json\n {\n \"code\": 400,\n \"success\": false,\n \"error\": \"Bad request: invalid recipients\",\n \"errorDetails\": {\n \"reasonCode\": \"INVALID_RECIPIENTS\",\n \"channel\": \"kakao-friendtalk\",\n \"invalidRecipientCount\": 2,\n \"invalidRecipients\": [\n {\n \"index\": 0,\n \"type\": \"user-id\",\n \"userId\": \"user_001\",\n \"reasonCode\": \"MISSING_PHONE_NUMBER\",\n \"source\": { \"pointer\": \"/recipients/0/userId\" }\n },\n {\n \"index\": 12,\n \"type\": \"user-id\",\n \"userId\": \"user_013\",\n \"reasonCode\": \"MISSING_PHONE_NUMBER\",\n \"source\": { \"pointer\": \"/recipients/12/userId\" }\n }\n ]\n }\n }\n ```\n\n | Field | Type | Meaning |\n | --- | --- | --- |\n | `reasonCode` | string | Always `INVALID_RECIPIENTS`. |\n | `channel` | string | Campaign channel. Values are `text-message`, `kakao-alimtalk`, `kakao-friendtalk`, `kakao-brand-message`, and `email`. |\n | `invalidRecipientCount` | number | Number of invalid recipients. |\n | `invalidRecipients` | array | List of invalid recipients. |\n | `invalidRecipients[].index` | number | Zero-based index in the request's `recipients` array. |\n | `invalidRecipients[].type` | string | Always `user-id`. |\n | `invalidRecipients[].userId` | string | `userId` supplied in the request. |\n | `invalidRecipients[].reasonCode` | string | `MISSING_PHONE_NUMBER` or `MISSING_EMAIL`. |\n | `invalidRecipients[].source.pointer` | string | Location of the request field as a JSON Pointer. |\n\n | Channel | Required field | `reasonCode` |\n | --- | --- | --- |\n | `text-message` | `phone_number` | `MISSING_PHONE_NUMBER` |\n | `kakao-alimtalk` | `phone_number` | `MISSING_PHONE_NUMBER` |\n | `kakao-friendtalk` | `phone_number` | `MISSING_PHONE_NUMBER` |\n | `kakao-brand-message` | `phone_number` | `MISSING_PHONE_NUMBER` |\n | `email` | `email` | `MISSING_EMAIL` |\n | `push-notification`, `web-push-notification` | No contact field check | None |\n\n - A `400` response contains `code`, `success`, and `error`. Only recipient validation failures add `errorDetails`. Other `400` errors, such as invalid parameters or an inactive campaign, omit it.\n - A `user-id` recipient is invalid if the user exists in Notifly and lacks the required contact information. Notifly skips unknown user IDs.\n - When `partialSend` is `false` or omitted, one invalid recipient causes the entire request to fail with `400` and no messages are sent.\n - To retry, inspect `errorDetails.invalidRecipients` and remove the invalid recipients from the request.\n\u003c/Info>\n\n\u003cInfo>\n **Partial sends**\n\n Set `partialSend` to `true` to send to valid recipients even if other recipients lack a phone number or email address.\n\n - With `partialSend: false` (the default), any invalid recipient causes the request to fail with `400` and sends no messages.\n - With `partialSend: true`, Notifly sends to valid recipients and lists the invalid recipients in the response. It returns `200` even when every recipient is invalid.\n\n Example response with `partialSend: true` and two invalid recipients.\n\n ```json\n {\n \"code\": 200,\n \"success\": true,\n \"error\": null,\n \"errorDetails\": {\n \"reasonCode\": \"INVALID_RECIPIENTS\",\n \"channel\": \"kakao-alimtalk\",\n \"invalidRecipientCount\": 2,\n \"invalidRecipients\": [\n {\n \"index\": 1,\n \"type\": \"user-id\",\n \"userId\": \"user_002\",\n \"reasonCode\": \"MISSING_PHONE_NUMBER\",\n \"source\": { \"pointer\": \"/recipients/1/userId\" }\n },\n {\n \"index\": 3,\n \"type\": \"user-id\",\n \"userId\": \"user_004\",\n \"reasonCode\": \"MISSING_PHONE_NUMBER\",\n \"source\": { \"pointer\": \"/recipients/3/userId\" }\n }\n ]\n }\n }\n ```\n\n Channels that support partial sends are `kakao-alimtalk`, `kakao-friendtalk`, `kakao-brand-message`, `text-message`, and `email`.\n\n \u003cNote>\n This contact information check applies to recipients specified with `user-id`. It does not apply when you specify the recipient directly with `type: \"phone-number\"` or `type: \"email\"`.\n \u003c/Note>\n\u003c/Info>\n","metadata":{"title":"Trigger a campaign","description":"Trigger a campaign for the specified recipients."}},"parameters":["7f4b1698-f59e-45ac-b70e-2bfefdf7b065","a570b16d-e5f1-4e10-b1e3-a6e8d10c50b2"],"requestBody":"eb8313eb-33ba-4046-b892-fb75c4f741c1","responses":{"200":"eb54b535-e3b5-4651-979e-55529c555757","400":"46229d54-d10b-4270-ba61-f4117b5c0d0e","401":"bc81f14a-6e7e-4d91-853b-e8fffd6286fc","405":"abfdf548-c123-4b64-b658-0d4bcd70b6ed","413":"21491838-e358-467c-86fb-4a424cd32400","500":"97cf2bc8-187a-4e8f-b5d0-32039569a515","501":"da2277e3-ac83-4e54-8988-9da5c491d72f"},"method":"post","type":"path","servers":["b16d9e41-7973-4ab2-9977-b4527180cd78"],"path":"/projects/{projectId}/campaigns/{campaignId}/send","baseUrlOptions":["https://api.notifly.tech"],"title":"trigger-campaign","description":"Trigger a campaign for the specified recipients.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7f4b1698-f59e-45ac-b70e-2bfefdf7b065":{"name":"projectId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Project ID.","uniqueKey":"","typeLabel":"string"},"description":"Project ID."},"a570b16d-e5f1-4e10-b1e3-a6e8d10c50b2":{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Campaign ID from the console.","uniqueKey":"","typeLabel":"string"},"description":"Campaign ID from the console."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipients"],"properties":{"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Recipient type. The default is `user-id`. Supported types include `user-id`, `phone-number`, `email`, and `line-user-id`.","enum":["user-id","phone-number","email","line-user-id"],"uniqueKey":"recipients.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","description":"User ID. Required when `type` is `user-id`.","uniqueKey":"recipients.items.[INDEX].userId","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number. Required when `type` is `phone-number`.","uniqueKey":"recipients.items.[INDEX].phoneNumber","typeLabel":"string"},"email":{"type":"string","description":"Email address. Required when `type` is `email`.","uniqueKey":"recipients.items.[INDEX].email","typeLabel":"string"},"lineUserId":{"type":"string","description":"LINE user ID. Required when `type` is `line-user-id`.","uniqueKey":"recipients.items.[INDEX].lineUserId","typeLabel":"string"},"eventParams":{"type":"object","description":"Event parameters for message personalization.","uniqueKey":"recipients.items.[INDEX].eventParams","typeLabel":"object"}},"uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"description":"List of recipients. Up to 1,000 entries.","isRequired":true,"uniqueKey":"recipients","typeLabel":"object[]"},"partialSend":{"type":"boolean","default":false,"description":"When `true`, send to valid recipients even if some recipients lack required phone numbers or email addresses. The response lists any invalid recipients. When `false` or omitted, an invalid recipient causes the entire request to fail.","uniqueKey":"partialSend","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"basicRequest":{"title":"basicRequest","summary":"Standard send request","value":{"recipients":[{"type":"phone-number","phoneNumber":"010-1234-5678"}]}},"partialSendRequest":{"title":"partialSendRequest","summary":"Partial send request","value":{"recipients":[{"userId":"user_001"},{"userId":"user_002"}],"partialSend":true}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"eb54b535-e3b5-4651-979e-55529c555757":{"description":"The campaign was triggered. If `partialSend` is `true` and some recipients are invalid, the response includes `errorDetails`.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"},"errorDetails":{"type":"object","description":"Included when `partialSend` is `true` and one or more recipients are invalid.","properties":{"reasonCode":{"type":"string","enum":["INVALID_RECIPIENTS"],"uniqueKey":"errorDetails.reasonCode","typeLabel":"enum\u003cstring>"},"channel":{"type":"string","description":"Campaign channel.","uniqueKey":"errorDetails.channel","typeLabel":"string"},"invalidRecipientCount":{"type":"integer","description":"Number of invalid recipients.","uniqueKey":"errorDetails.invalidRecipientCount","typeLabel":"integer"},"invalidRecipients":{"type":"array","description":"Details about invalid recipients.","items":{"type":"object","properties":{"index":{"type":"integer","uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].index","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].type","typeLabel":"string"},"userId":{"type":"string","uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].userId","typeLabel":"string"},"reasonCode":{"type":"string","enum":["MISSING_PHONE_NUMBER","MISSING_EMAIL"],"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].reasonCode","typeLabel":"enum\u003cstring>"},"source":{"type":"object","properties":{"pointer":{"type":"string","uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errorDetails.invalidRecipients","typeLabel":"object[]"}},"uniqueKey":"errorDetails","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"successNoInvalid":{"title":"successNoInvalid","summary":"All recipients valid (no errorDetails)","value":{"code":200,"success":true,"error":null}},"partialSendWithInvalid":{"title":"partialSendWithInvalid","summary":"Partial send with invalid recipients","value":{"code":200,"success":true,"error":null,"errorDetails":{"reasonCode":"INVALID_RECIPIENTS","channel":"kakao-alimtalk","invalidRecipientCount":2,"invalidRecipients":[{"index":1,"type":"user-id","userId":"user_002","reasonCode":"MISSING_PHONE_NUMBER","source":{"pointer":"/recipients/1/userId"}},{"index":3,"type":"user-id","userId":"user_004","reasonCode":"MISSING_PHONE_NUMBER","source":{"pointer":"/recipients/3/userId"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"46229d54-d10b-4270-ba61-f4117b5c0d0e":{"description":"The request is incorrect. `errorDetails` is included only when recipient validation fails.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"errorDetails":{"type":"object","description":"Included only when recipient validation fails, such as when a `user-id` recipient lacks required contact information.","required":["reasonCode","channel","invalidRecipientCount","invalidRecipients"],"properties":{"reasonCode":{"type":"string","enum":["INVALID_RECIPIENTS"],"description":"Code that identifies a recipient validation failure.","isRequired":true,"uniqueKey":"errorDetails.reasonCode","typeLabel":"enum\u003cstring>"},"channel":{"type":"string","description":"Campaign channel.","isRequired":true,"uniqueKey":"errorDetails.channel","typeLabel":"string"},"invalidRecipientCount":{"type":"integer","description":"Number of invalid recipients.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipientCount","typeLabel":"integer"},"invalidRecipients":{"type":"array","description":"Details about invalid recipients.","items":{"type":"object","required":["index","type","userId","reasonCode","source"],"properties":{"index":{"type":"integer","description":"Zero-based index in the request's `recipients` array.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].index","typeLabel":"integer"},"type":{"type":"string","enum":["user-id"],"description":"Recipient type.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","description":"The `userId` supplied in the request.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].userId","typeLabel":"string"},"reasonCode":{"type":"string","enum":["MISSING_PHONE_NUMBER","MISSING_EMAIL"],"description":"Type of required contact information that is missing.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].reasonCode","typeLabel":"enum\u003cstring>"},"source":{"type":"object","required":["pointer"],"properties":{"pointer":{"type":"string","description":"Location of the request field as a JSON Pointer.","isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].source.pointer","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errorDetails.invalidRecipients.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errorDetails.invalidRecipients","typeLabel":"object[]"}},"uniqueKey":"errorDetails","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"generalBadRequest":{"title":"generalBadRequest","summary":"General 400 response (without errorDetails)","value":{"code":400,"success":false,"error":"Bad request: some-error-message"}},"invalidRecipients":{"title":"invalidRecipients","summary":"Recipient validation failure (with errorDetails)","value":{"code":400,"success":false,"error":"Bad request: invalid recipients","errorDetails":{"reasonCode":"INVALID_RECIPIENTS","channel":"kakao-friendtalk","invalidRecipientCount":2,"invalidRecipients":[{"index":0,"type":"user-id","userId":"user_001","reasonCode":"MISSING_PHONE_NUMBER","source":{"pointer":"/recipients/0/userId"}},{"index":12,"type":"user-id","userId":"user_013","reasonCode":"MISSING_PHONE_NUMBER","source":{"pointer":"/recipients/12/userId"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"bc81f14a-6e7e-4d91-853b-e8fffd6286fc":{"description":"The token has expired, or the authentication information is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":401,"success":false,"error":"Unauthorized: Invalid token"},"examples":{"Example":{"title":"Example","value":{"code":401,"success":false,"error":"Unauthorized: Invalid token"}}},"exampleType":"examples"}},"exampleType":"examples"},"abfdf548-c123-4b64-b658-0d4bcd70b6ed":{"description":"Unsupported HTTP Method.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":405,"success":false,"error":"Method not allowed: some-error-message"},"examples":{"Example":{"title":"Example","value":{"code":405,"success":false,"error":"Method not allowed: some-error-message"}}},"exampleType":"examples"}},"exampleType":"examples"},"21491838-e358-467c-86fb-4a424cd32400":{"description":"The request payload is too large.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":413,"success":false,"error":"Payload too large: some-error-message"},"examples":{"Example":{"title":"Example","value":{"code":413,"success":false,"error":"Payload too large: some-error-message"}}},"exampleType":"examples"}},"exampleType":"examples"},"97cf2bc8-187a-4e8f-b5d0-32039569a515":{"description":"Notifly server error. If 500 errors persist, please contact the Notifly team.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":500,"success":false,"error":"some-error-message"},"examples":{"Example":{"title":"Example","value":{"code":500,"success":false,"error":"some-error-message"}}},"exampleType":"examples"}},"exampleType":"examples"},"da2277e3-ac83-4e54-8988-9da5c491d72f":{"description":"The feature is not yet supported.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":501,"success":false,"error":"Not implemented: some-error-message"},"examples":{"Example":{"title":"Example","value":{"code":501,"success":false,"error":"Not implemented: some-error-message"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"a895914f-6f8a-4a1a-9803-5c0658cb3dec":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass the token issued by `POST /authenticate` as a bearer token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b16d9e41-7973-4ab2-9977-b4527180cd78":{"url":"https://api.notifly.tech","description":"Notifly API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass the token issued by `POST /authenticate` as a bearer token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass the token issued by `POST /authenticate` as a bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"en/api-reference/openapi.yaml"},"subdomain":"notifly","siteName":"Notifly Docs","title":"Trigger a campaign - Notifly Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"ko":{"href":"/api-reference/trigger-campaign","matchLevel":1},"en":{"href":"/en/api-reference/trigger-campaign","matchLevel":0},"ja":{"href":"/ja/api-reference/trigger-campaign","matchLevel":1}}},"lastModified":"2026-11-20T05:34:59.065Z","originalFileLocation":"en/api-reference/trigger-campaign.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Trigger a campaign for the specified recipients.\">\u003cmeta data-mint-head name=\"keywords\" content=\"노티플라이, Notifly, push notification, 푸시 알림, 인앱 팝업, in-app message, 마케팅 자동화, marketing automation, 유저 참여, user engagement, 모바일 SDK, mobile SDK, web push, 웹 푸시, 카카오톡, 이메일, SMS, campaign, 캠페인, user journey, 유저 여정, personalization, 개인화, analytics, 분석, Firebase, Android SDK, iOS SDK, React Native, Flutter, JavaScript SDK, GTM, API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Notifly Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Trigger a campaign - Notifly Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Trigger a campaign for the specified recipients.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Notifly Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.notifly.tech/en/api-reference/trigger-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://notifly.mintlify.site/_mintlify/api/og/v2?division=Campaigns+and+journeys\u0026amp;title=Trigger+a+campaign\u0026amp;description=Trigger+a+campaign+for+the+specified+recipients.\u0026amp;theme=0cab931be013e29450d4dfb9\u0026amp;signature=296102d516f6a0270a4be3087950a39d65773305e2969c22f3baeac1d2299f55\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Trigger a campaign - Notifly Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Trigger a campaign for the specified recipients.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://notifly.mintlify.site/_mintlify/api/og/v2?division=Campaigns+and+journeys\u0026amp;title=Trigger+a+campaign\u0026amp;description=Trigger+a+campaign+for+the+specified+recipients.\u0026amp;theme=0cab931be013e29450d4dfb9\u0026amp;signature=296102d516f6a0270a4be3087950a39d65773305e2969c22f3baeac1d2299f55\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/notifly/XPUTxSzUsv6_-wtt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Notifly Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0144CD\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Notifly\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.notifly.tech/en/api-reference/trigger-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/trigger-campaign.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.notifly.tech/en/api-reference/trigger-campaign\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.notifly.tech/api-reference/trigger-campaign\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.notifly.tech/ja/api-reference/trigger-campaign\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.notifly.tech/api-reference/trigger-campaign\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.notifly.tech/#organization\",\"name\":\"Notifly Docs\",\"url\":\"https://docs.notifly.tech\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/notifly/rl-cEZ-semfYDKMK/images/notifly.png?fit=max\u0026auto=format\u0026n=rl-cEZ-semfYDKMK\u0026q=85\u0026s=1fd87113cc3e1e0462340d5e153b1152\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.notifly.tech#website\",\"name\":\"Notifly Docs\",\"url\":\"https://docs.notifly.tech\",\"publisher\":{\"@id\":\"https://docs.notifly.tech/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign#webpage\",\"url\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign\",\"name\":\"Trigger a campaign\",\"description\":\"Trigger a campaign for the specified recipients.\",\"dateModified\":\"2026-11-20T05:34:59.065Z\",\"isPartOf\":{\"@id\":\"https://docs.notifly.tech#website\"},\"breadcrumb\":{\"@id\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Notifly Docs\",\"item\":\"https://docs.notifly.tech\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Trigger a campaign\",\"item\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign#apireference\",\"headline\":\"Trigger a campaign\",\"name\":\"Trigger a campaign\",\"description\":\"Trigger a campaign for the specified recipients.\",\"url\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.notifly.tech/en/api-reference/trigger-campaign#webpage\"},\"dateModified\":\"2026-11-20T05:34:59.065Z\",\"publisher\":{\"@id\":\"https://docs.notifly.tech/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.notifly.tech#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Notifly Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Notifly Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/api-reference/trigger-campaign.md","siteName":"Notifly Docs","nav":{"global":null,"languages":[{"language":"ko","default":true,"pages":[{"title":"ko","href":"/api-reference/trigger-campaign"}]},{"language":"en","tabs":[{"tab":"User Guides","pages":[{"title":"User Guides","href":"/en"}]},{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":"/en/developer-guide"}]},{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"API overview","href":"/en/api-reference/getting-started"},{"title":"API errors and response formats","href":"/en/api-reference/error"}]},{"group":"Authentication","pages":[{"title":"Issue an API token","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /authenticate","href":"/en/api-reference/authenticate"}]},{"group":"Events and users","pages":[{"title":"Track events","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /track-event","href":"/en/api-reference/track-event"},{"title":"Set user properties","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /set-user-properties","href":"/en/api-reference/set-user-properties"},{"title":"Delete users","description":"Delete one or more users registered in Notifly by user ID, email address, phone number, or LINE user ID.","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /users","href":"/en/api-reference/delete-users"}]},{"group":"Campaigns and journeys","pages":[{"title":"Trigger a campaign","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/campaigns/{campaignId}/send","href":"/en/api-reference/trigger-campaign"},{"title":"Trigger a user journey","description":"Start a user journey for the specified users.","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/user-journeys/{userJourneyId}/enter","href":"/en/api-reference/trigger-user-journey"}]},{"group":"Messaging","pages":[{"title":"Send a text message","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /messages/text-message","href":"/en/api-reference/send-text-message"},{"title":"Send Kakao AlimTalk","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /messages/kakao-alimtalk","href":"/en/api-reference/send-kakao-alimtalk"},{"title":"Send Kakao Friendtalk (support ended May 31, 2026)","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /messages/kakao-friendtalk","href":"/en/api-reference/send-kakao-friendtalk"},{"title":"Send a templated Kakao Brand Message","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /messages/kakao-brand-message","href":"/en/api-reference/send-kakao-brand-message"},{"title":"Send a free-form Kakao Brand Message","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /messages/kakao-brand-message/freestyle","href":"/en/api-reference/send-kakao-brand-message-freestyle"}]},{"group":"Messaging management","pages":[{"group":"Kakao Brand Message templates","pages":[{"title":"Upload a Brand Message image","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/messages/kakao-brand-message/images","href":"/en/api-reference/upload-kakao-brand-message-image"},{"title":"List Brand Message templates","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/messages/kakao-brand-message/templates","href":"/en/api-reference/list-kakao-brand-message-templates"},{"title":"Create a Brand Message template","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/messages/kakao-brand-message/templates","href":"/en/api-reference/create-kakao-brand-message-template"},{"title":"Get a Brand Message template","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/messages/kakao-brand-message/templates/{templateId}","href":"/en/api-reference/get-kakao-brand-message-template"}]},{"group":"Kakao AlimTalk templates","pages":[{"title":"List AlimTalk templates (legacy)","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /projects/{projectId}/messages/kakao-alimtalk/templates","href":"/en/api-reference/list-kakao-alimtalk-templates"},{"title":"List AlimTalk templates","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/messages/kakao-alimtalk/templates","href":"/en/api-reference/list-kakao-bizmessage-alimtalk-templates"},{"title":"Get an AlimTalk template","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/messages/kakao-alimtalk/templates/{templateCode}","href":"/en/api-reference/get-kakao-bizmessage-alimtalk-template"},{"title":"Register an AlimTalk template (legacy)","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/messages/kakao-alimtalk/templates","href":"/en/api-reference/create-kakao-alimtalk-template"},{"title":"Update an AlimTalk template (legacy)","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml put /projects/{projectId}/messages/kakao-alimtalk/templates/{templateCode}","href":"/en/api-reference/update-kakao-alimtalk-template"},{"title":"Delete an AlimTalk template (legacy)","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /projects/{projectId}/messages/kakao-alimtalk/templates/{templateCode}","href":"/en/api-reference/delete-kakao-alimtalk-template"}]},{"group":"080 opt-out service","pages":[{"title":"List 080 opt-out entries","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /projects/{projectId}/messages/text-message/blockservice/recipients","href":"/en/api-reference/list-080-block-recipients"},{"title":"Register 080 opt-out entries","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/messages/text-message/blockservice/recipients","href":"/en/api-reference/register-080-block-recipients"},{"title":"Remove 080 opt-out entries","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /projects/{projectId}/messages/text-message/blockservice/recipients/removes","href":"/en/api-reference/remove-080-block-recipients"}]}]},{"group":"Catalogs","pages":[{"title":"Get started with the Catalog REST API","href":"/en/api-reference/catalogs/getting-started"},{"group":"Manage catalogs","pages":[{"title":"List API catalogs","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/catalogs","href":"/en/api-reference/catalog/list-api-catalogs"},{"title":"Create an API catalog","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/catalogs","href":"/en/api-reference/catalog/create-api-catalog"},{"title":"Delete an API catalog","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /v1/projects/{projectId}/catalogs/{catalogName}","href":"/en/api-reference/catalog/delete-api-catalog"}]},{"group":"Items","pages":[{"title":"List catalog items","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/catalogs/{catalogName}/items","href":"/en/api-reference/catalog/list-api-catalog-items"},{"title":"Create catalog items in bulk","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/catalogs/{catalogName}/items","href":"/en/api-reference/catalog/create-api-catalog-items"},{"title":"Replace catalog items in bulk","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml put /v1/projects/{projectId}/catalogs/{catalogName}/items","href":"/en/api-reference/catalog/replace-api-catalog-items"},{"title":"Update catalog items in bulk","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml patch /v1/projects/{projectId}/catalogs/{catalogName}/items","href":"/en/api-reference/catalog/patch-api-catalog-items"},{"title":"Delete catalog items in bulk","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /v1/projects/{projectId}/catalogs/{catalogName}/items","href":"/en/api-reference/catalog/delete-api-catalog-items"},{"title":"Get a catalog item","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/catalogs/{catalogName}/items/{itemId}","href":"/en/api-reference/catalog/get-api-catalog-item"},{"title":"Create a catalog item","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/catalogs/{catalogName}/items/{itemId}","href":"/en/api-reference/catalog/create-api-catalog-item"},{"title":"Replace a catalog item","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml put /v1/projects/{projectId}/catalogs/{catalogName}/items/{itemId}","href":"/en/api-reference/catalog/replace-api-catalog-item"},{"title":"Update a catalog item","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml patch /v1/projects/{projectId}/catalogs/{catalogName}/items/{itemId}","href":"/en/api-reference/catalog/patch-api-catalog-item"},{"title":"Delete a catalog item","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /v1/projects/{projectId}/catalogs/{catalogName}/items/{itemId}","href":"/en/api-reference/catalog/delete-api-catalog-item"}]},{"group":"Fields","pages":[{"title":"Add catalog fields","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/catalogs/{catalogName}/fields","href":"/en/api-reference/catalog/add-api-catalog-fields"},{"title":"Delete a catalog field","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /v1/projects/{projectId}/catalogs/{catalogName}/fields/{fieldName}","href":"/en/api-reference/catalog/delete-api-catalog-field"}]},{"group":"Selections","pages":[{"title":"Create a catalog selection","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/catalogs/{catalogName}/selections","href":"/en/api-reference/catalog/create-api-catalog-selection"},{"title":"Delete a catalog selection","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml delete /v1/projects/{projectId}/catalogs/{catalogName}/selections/{selectionName}","href":"/en/api-reference/catalog/delete-api-catalog-selection"}]}]},{"group":"Exports and analytics","pages":[{"group":"Export message events","pages":[{"title":"Request an export of campaign events","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /projects/{projectId}/campaign-event-data/exports","href":"/en/api-reference/create-campaign-event-export"},{"title":"Retrieve exported campaign events","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /projects/{projectId}/campaign-event-data/exports/{exportId}/result","href":"/en/api-reference/get-campaign-event-export-result"}]},{"title":"Get message statistics","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml post /v1/projects/{projectId}/statistics","href":"/en/api-reference/get-campaign-statistics"},{"title":"Export message statistics as CSV","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /v1/projects/{projectId}/statistics.csv","href":"/en/api-reference/get-campaign-statistics-csv"},{"title":"Get detailed campaign statistics","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /projects/{projectId}/campaigns/{campaignId}/stats","href":"/en/api-reference/get-campaign-statistics-retrieval"},{"title":"Get user message history","deprecated":null,"version":null,"openapi":"/en/api-reference/openapi.yaml get /projects/{projectId}/users/{userId}/message-history","href":"/en/api-reference/get-user-message-history"}]}]}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/trigger-campaign"}]}]},"basePath":"","title":"Trigger a campaign - Notifly Docs","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}