Important: Creating a broadcast does not schedule or send it. After creating the broadcast,
you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Notifuse Documentation","colors":{"primary":"#7763F1","light":"#7763F1","dark":"#7763F1"},"logo":{"light":"https://mintcdn.com/notifuse/Gw4P7NadUImyvZfw/assets/logo/logo-small.png?fit=max\u0026auto=format\u0026n=Gw4P7NadUImyvZfw\u0026q=85\u0026s=3f27c94b7162528f7c2d50f0d0dffdc4","dark":"https://mintcdn.com/notifuse/Gw4P7NadUImyvZfw/assets/logo/logo-small.png?fit=max\u0026auto=format\u0026n=Gw4P7NadUImyvZfw\u0026q=85\u0026s=3f27c94b7162528f7c2d50f0d0dffdc4","href":"https://notifuse.com"},"favicon":"https://mintcdn.com/notifuse/Gw4P7NadUImyvZfw/assets/logo/icon.png?fit=max\u0026auto=format\u0026n=Gw4P7NadUImyvZfw\u0026q=85\u0026s=4747c87b24b335428a3813ddeddb25c6","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:hello@notifuse.com","label":"Support"},{"href":"https://github.com/notifuse","label":"GitHub"}],"primary":{"type":"button","label":"Try Notifuse Cloud","href":"https://cloud.notifuse.com"}},"footer":{"socials":{"x":"https://x.com/notifuse","github":"https://github.com/notifuse"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"notifuse","hasAudioNarration":false,"actualSubdomain":"notifuse","customDomains":["docs.notifuse.com"],"gitSource":{"type":"github","owner":"notifuse","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae9df284323a0c25b2c5b30","collectionId":"b5de9097-7179-4ec5-86b5-8d626496611a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9df284323a0c25b2c5b30"},"entitlements":{},"buildId":"6ae9ede375120cb36f290c17","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Documentation","count":40},{"language":"default","tag":"Features","count":25},{"language":"default","tag":"Blog","count":21},{"language":"default","tag":"Web Analytics","count":17},{"language":"default","tag":"Broadcasts","count":12},{"language":"default","tag":"Webhooks","count":10},{"language":"default","tag":"Self-hosting","count":8},{"language":"default","tag":"Email Providers","count":7},{"language":"default","tag":"Contacts","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/create-a-broadcast","slug":"/api-reference/create-a-broadcast","pageMetadata":{"title":"Create a broadcast","description":"Creates a new broadcast campaign in draft status.\n\n**Important:** Creating a broadcast does not schedule or send it. After creating the broadcast,\nyou must call the `/api/broadcasts.schedule` endpoint to schedule or send it immediately.\n","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.create","href":"/api-reference/create-a-broadcast","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new broadcast campaign in draft status.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Important:\"\n }), \" Creating a broadcast does not schedule or send it. After creating the broadcast,\\nyou must call the \", _jsx(_components.code, {\n children: \"/api/broadcasts.schedule\"\n }), \" endpoint to schedule or send it immediately.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a broadcast","description":"Creates a new broadcast campaign in draft status.\n\n**Important:** Creating a broadcast does not schedule or send it. After creating the broadcast,\nyou must call the `/api/broadcasts.schedule` endpoint to schedule or send it immediately.\n","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.create","href":"/api-reference/create-a-broadcast","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a broadcast","description":"Creates a new broadcast campaign in draft status.\n\n**Important:** Creating a broadcast does not schedule or send it. After creating the broadcast,\nyou must call the `/api/broadcasts.schedule` endpoint to schedule or send it immediately.\n","operationId":"createBroadcast","security":["e1eceed2-0cb9-45ff-b2b2-647da7af5a5a"],"requestBody":"932bc277-1167-4248-bbce-536fd403a6a0","responses":{"201":"6aa6c165-842a-4d6f-a2c1-2a9900d14bce","400":"9dfad2ca-0dea-4743-9a1b-baad6ffd8101","401":"c17d01e3-2e83-4007-a885-a152eeb12c63","500":"4f711467-00dc-4203-a95e-3e9d5bc737de"},"method":"post","type":"path","servers":["26d4277a-6e4c-4b4f-b10e-d4b74e4c1afe"],"path":"/api/broadcasts.create","baseUrlOptions":["https://{notifuseDomain}"],"title":"Create a broadcast","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspace_id","name","audience"],"properties":{"workspace_id":{"type":"string","description":"The ID of the workspace","example":"ws_1234567890","isRequired":true,"uniqueKey":"workspace_id","typeLabel":"string"},"name":{"type":"string","description":"Name of the broadcast","example":"Spring Newsletter 2024","maxLength":255,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"audience":{"type":"object","required":["list"],"properties":{"list":{"type":"string","description":"List ID to send to","example":"newsletter","isRequired":true,"uniqueKey":"audience.list","typeLabel":"string"},"segments":{"type":"array","description":"Optional segment IDs to filter recipients","items":{"type":"string","uniqueKey":"audience.segments.items.[INDEX]","typeLabel":"string"},"example":["premium_users"],"uniqueKey":"audience.segments","typeLabel":"string[]"},"exclude_unsubscribed":{"type":"boolean","default":true,"description":"Whether to exclude the list's unsubscribed contacts. Omitting the key excludes them; send false to mail them too, e.g. for a legal notice. Bounced and complained contacts are never mailed, whatever this value.","example":true,"uniqueKey":"audience.exclude_unsubscribed","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"audience","typeLabel":"object"},"test_settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether A/B testing is enabled","example":true,"uniqueKey":"test_settings.enabled","typeLabel":"boolean"},"sample_percentage":{"type":"integer","minimum":1,"maximum":100,"description":"Percentage of audience to use for testing","example":20,"uniqueKey":"test_settings.sample_percentage","typeLabel":"integer"},"auto_send_winner":{"type":"boolean","description":"Automatically send winning variation to remaining audience","example":true,"uniqueKey":"test_settings.auto_send_winner","typeLabel":"boolean"},"auto_send_winner_metric":{"type":"string","enum":["open_rate","click_rate"],"description":"Metric used to determine the winner","example":"open_rate","uniqueKey":"test_settings.auto_send_winner_metric","typeLabel":"enum\u003cstring>"},"test_duration_hours":{"type":"integer","minimum":1,"maximum":168,"description":"Duration of the test in hours (max 7 days)","example":24,"uniqueKey":"test_settings.test_duration_hours","typeLabel":"integer"},"variations":{"type":"array","description":"Test variations (2-8 variations allowed)","minItems":2,"maxItems":8,"items":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string","description":"Template ID for this variation","example":"template_variant_a","isRequired":true,"uniqueKey":"test_settings.variations.items.[INDEX].template_id","typeLabel":"string"},"variation_name":{"type":"string","description":"Name of this variation","example":"Variation A","uniqueKey":"test_settings.variations.items.[INDEX].variation_name","typeLabel":"string"},"metrics":{"type":"object","properties":{"recipients":{"type":"integer","description":"Number of recipients","uniqueKey":"test_settings.variations.items.[INDEX].metrics.recipients","typeLabel":"integer"},"delivered":{"type":"integer","description":"Number of delivered messages","uniqueKey":"test_settings.variations.items.[INDEX].metrics.delivered","typeLabel":"integer"},"opens":{"type":"integer","description":"Number of opens","uniqueKey":"test_settings.variations.items.[INDEX].metrics.opens","typeLabel":"integer"},"clicks":{"type":"integer","description":"Number of clicks","uniqueKey":"test_settings.variations.items.[INDEX].metrics.clicks","typeLabel":"integer"},"bounced":{"type":"integer","description":"Number of bounces","uniqueKey":"test_settings.variations.items.[INDEX].metrics.bounced","typeLabel":"integer"},"complained":{"type":"integer","description":"Number of complaints","uniqueKey":"test_settings.variations.items.[INDEX].metrics.complained","typeLabel":"integer"},"unsubscribed":{"type":"integer","description":"Number of unsubscribes","uniqueKey":"test_settings.variations.items.[INDEX].metrics.unsubscribed","typeLabel":"integer"}},"uniqueKey":"test_settings.variations.items.[INDEX].metrics","typeLabel":"object"},"template":{"oneOf":[{"type":"object","description":"Full template object (populated when with_templates=true)","uniqueKey":"test_settings.variations.items.[INDEX].template.oneOf.0","typeLabel":"object"},{"type":"null","description":"Full template object (populated when with_templates=true)","uniqueKey":"test_settings.variations.items.[INDEX].template.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_settings.variations.items.[INDEX].template","typeLabel":"object | null"}},"uniqueKey":"test_settings.variations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"test_settings.variations","typeLabel":"object[]"}},"uniqueKey":"test_settings","typeLabel":"object"},"utm_parameters":{"type":"object","properties":{"source":{"type":"string","description":"UTM source parameter","example":"newsletter","uniqueKey":"utm_parameters.source","typeLabel":"string"},"medium":{"type":"string","description":"UTM medium parameter","example":"email","uniqueKey":"utm_parameters.medium","typeLabel":"string"},"campaign":{"type":"string","description":"UTM campaign parameter","example":"spring_2024","uniqueKey":"utm_parameters.campaign","typeLabel":"string"},"term":{"type":"string","description":"UTM term parameter","uniqueKey":"utm_parameters.term","typeLabel":"string"},"content":{"type":"string","description":"UTM content parameter","uniqueKey":"utm_parameters.content","typeLabel":"string"}},"uniqueKey":"utm_parameters","typeLabel":"object"},"data_feed":{"type":"object","description":"Configuration for external data feeds","properties":{"global_feed":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the global data feed is enabled","example":true,"uniqueKey":"data_feed.global_feed.enabled","typeLabel":"boolean"},"url":{"type":"string","description":"URL endpoint to fetch global data from (must be HTTPS)","example":"https://api.example.com/broadcast-data","uniqueKey":"data_feed.global_feed.url","typeLabel":"string"},"headers":{"type":"array","description":"Custom HTTP headers to include in the request","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"HTTP header name","example":"Authorization","isRequired":true,"uniqueKey":"data_feed.global_feed.headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"HTTP header value","example":"Bearer token123","isRequired":true,"uniqueKey":"data_feed.global_feed.headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data_feed.global_feed.headers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data_feed.global_feed.headers","typeLabel":"object[]"}},"uniqueKey":"data_feed.global_feed","typeLabel":"object"},"global_feed_data":{"type":"object","additionalProperties":true,"description":"Cached data from the global feed (populated after fetch)","uniqueKey":"data_feed.global_feed_data","typeLabel":"object"},"global_feed_fetched_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the global feed was last fetched","uniqueKey":"data_feed.global_feed_fetched_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the global feed was last fetched","uniqueKey":"data_feed.global_feed_fetched_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_feed.global_feed_fetched_at","typeLabel":"string\u003cdate-time> | null"},"recipient_feed":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the per-recipient data feed is enabled","example":true,"uniqueKey":"data_feed.recipient_feed.enabled","typeLabel":"boolean"},"url":{"type":"string","description":"URL endpoint to fetch per-recipient data from (must be HTTPS)","example":"https://api.example.com/recipient-data","uniqueKey":"data_feed.recipient_feed.url","typeLabel":"string"},"headers":{"type":"array","description":"Custom HTTP headers to include in the request","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"HTTP header name","example":"Authorization","isRequired":true,"uniqueKey":"data_feed.recipient_feed.headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"HTTP header value","example":"Bearer token123","isRequired":true,"uniqueKey":"data_feed.recipient_feed.headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data_feed.recipient_feed.headers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data_feed.recipient_feed.headers","typeLabel":"object[]"}},"uniqueKey":"data_feed.recipient_feed","typeLabel":"object"}},"uniqueKey":"data_feed","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"description":"Custom metadata for the broadcast","uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"workspace_id":"ws_1234567890","name":"Spring Newsletter 2024","audience":{"list":"newsletter","segments":["premium_users"],"exclude_unsubscribed":true},"test_settings":{"enabled":true,"sample_percentage":20,"auto_send_winner":true,"auto_send_winner_metric":"open_rate","test_duration_hours":24,"variations":[{"template_id":"template_variant_a","variation_name":"Variation A","metrics":{"recipients":123,"delivered":123,"opens":123,"clicks":123,"bounced":123,"complained":123,"unsubscribed":123},"template":{}}]},"utm_parameters":{"source":"newsletter","medium":"email","campaign":"spring_2024","term":"\u003cstring>","content":"\u003cstring>"},"data_feed":{"global_feed":{"enabled":true,"url":"https://api.example.com/broadcast-data","headers":[{"name":"Authorization","value":"Bearer token123"}]},"global_feed_data":{},"global_feed_fetched_at":"2023-11-07T05:31:56Z","recipient_feed":{"enabled":true,"url":"https://api.example.com/recipient-data","headers":[{"name":"Authorization","value":"Bearer token123"}]}},"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6aa6c165-842a-4d6f-a2c1-2a9900d14bce":{"description":"Broadcast created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"broadcast":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the broadcast","example":"broadcast_12345","uniqueKey":"broadcast.id","typeLabel":"string"},"workspace_id":{"type":"string","description":"The ID of the workspace","example":"ws_1234567890","uniqueKey":"broadcast.workspace_id","typeLabel":"string"},"name":{"type":"string","description":"Name of the broadcast","example":"Spring Newsletter 2024","maxLength":255,"uniqueKey":"broadcast.name","typeLabel":"string"},"channel_type":{"type":"string","description":"Communication channel type","example":"email","uniqueKey":"broadcast.channel_type","typeLabel":"string"},"status":{"type":"string","enum":["draft","scheduled","processing","paused","processed","cancelled","failed","testing","test_completed","winner_selected"],"description":"Current status of the broadcast","example":"draft","uniqueKey":"broadcast.status","typeLabel":"enum\u003cstring>"},"audience":{"type":"object","required":["list"],"properties":{"list":{"type":"string","description":"List ID to send to","example":"newsletter","isRequired":true,"uniqueKey":"broadcast.audience.list","typeLabel":"string"},"segments":{"type":"array","description":"Optional segment IDs to filter recipients","items":{"type":"string","uniqueKey":"broadcast.audience.segments.items.[INDEX]","typeLabel":"string"},"example":["premium_users"],"uniqueKey":"broadcast.audience.segments","typeLabel":"string[]"},"exclude_unsubscribed":{"type":"boolean","default":true,"description":"Whether to exclude the list's unsubscribed contacts. Omitting the key excludes them; send false to mail them too, e.g. for a legal notice. Bounced and complained contacts are never mailed, whatever this value.","example":true,"uniqueKey":"broadcast.audience.exclude_unsubscribed","typeLabel":"boolean"}},"uniqueKey":"broadcast.audience","typeLabel":"object"},"schedule":{"type":"object","description":"Schedule settings for a broadcast. Note: When a broadcast is first created,\nthese fields are empty/false. Use the /api/broadcasts.schedule endpoint to\nconfigure scheduling.\n","properties":{"is_scheduled":{"type":"boolean","description":"Whether the broadcast is scheduled (false after creation, set via broadcasts.schedule)","example":false,"uniqueKey":"broadcast.schedule.is_scheduled","typeLabel":"boolean"},"scheduled_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Scheduled date in YYYY-MM-DD format","example":"2024-03-15","uniqueKey":"broadcast.schedule.scheduled_date","typeLabel":"string"},"scheduled_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"Scheduled time in HH:MM format","example":"10:30","uniqueKey":"broadcast.schedule.scheduled_time","typeLabel":"string"},"timezone":{"type":"string","description":"IANA timezone","example":"America/New_York","uniqueKey":"broadcast.schedule.timezone","typeLabel":"string"},"use_recipient_timezone":{"type":"boolean","description":"Send at scheduled time in each recipient's timezone","example":false,"uniqueKey":"broadcast.schedule.use_recipient_timezone","typeLabel":"boolean"}},"uniqueKey":"broadcast.schedule","typeLabel":"object"},"test_settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether A/B testing is enabled","example":true,"uniqueKey":"broadcast.test_settings.enabled","typeLabel":"boolean"},"sample_percentage":{"type":"integer","minimum":1,"maximum":100,"description":"Percentage of audience to use for testing","example":20,"uniqueKey":"broadcast.test_settings.sample_percentage","typeLabel":"integer"},"auto_send_winner":{"type":"boolean","description":"Automatically send winning variation to remaining audience","example":true,"uniqueKey":"broadcast.test_settings.auto_send_winner","typeLabel":"boolean"},"auto_send_winner_metric":{"type":"string","enum":["open_rate","click_rate"],"description":"Metric used to determine the winner","example":"open_rate","uniqueKey":"broadcast.test_settings.auto_send_winner_metric","typeLabel":"enum\u003cstring>"},"test_duration_hours":{"type":"integer","minimum":1,"maximum":168,"description":"Duration of the test in hours (max 7 days)","example":24,"uniqueKey":"broadcast.test_settings.test_duration_hours","typeLabel":"integer"},"variations":{"type":"array","description":"Test variations (2-8 variations allowed)","minItems":2,"maxItems":8,"items":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string","description":"Template ID for this variation","example":"template_variant_a","isRequired":true,"uniqueKey":"broadcast.test_settings.variations.items.[INDEX].template_id","typeLabel":"string"},"variation_name":{"type":"string","description":"Name of this variation","example":"Variation A","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].variation_name","typeLabel":"string"},"metrics":{"type":"object","properties":{"recipients":{"type":"integer","description":"Number of recipients","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.recipients","typeLabel":"integer"},"delivered":{"type":"integer","description":"Number of delivered messages","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.delivered","typeLabel":"integer"},"opens":{"type":"integer","description":"Number of opens","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.opens","typeLabel":"integer"},"clicks":{"type":"integer","description":"Number of clicks","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.clicks","typeLabel":"integer"},"bounced":{"type":"integer","description":"Number of bounces","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.bounced","typeLabel":"integer"},"complained":{"type":"integer","description":"Number of complaints","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.complained","typeLabel":"integer"},"unsubscribed":{"type":"integer","description":"Number of unsubscribes","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics.unsubscribed","typeLabel":"integer"}},"uniqueKey":"broadcast.test_settings.variations.items.[INDEX].metrics","typeLabel":"object"},"template":{"oneOf":[{"type":"object","description":"Full template object (populated when with_templates=true)","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].template.oneOf.0","typeLabel":"object"},{"type":"null","description":"Full template object (populated when with_templates=true)","uniqueKey":"broadcast.test_settings.variations.items.[INDEX].template.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.test_settings.variations.items.[INDEX].template","typeLabel":"object | null"}},"uniqueKey":"broadcast.test_settings.variations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"broadcast.test_settings.variations","typeLabel":"object[]"}},"uniqueKey":"broadcast.test_settings","typeLabel":"object"},"utm_parameters":{"type":"object","properties":{"source":{"type":"string","description":"UTM source parameter","example":"newsletter","uniqueKey":"broadcast.utm_parameters.source","typeLabel":"string"},"medium":{"type":"string","description":"UTM medium parameter","example":"email","uniqueKey":"broadcast.utm_parameters.medium","typeLabel":"string"},"campaign":{"type":"string","description":"UTM campaign parameter","example":"spring_2024","uniqueKey":"broadcast.utm_parameters.campaign","typeLabel":"string"},"term":{"type":"string","description":"UTM term parameter","uniqueKey":"broadcast.utm_parameters.term","typeLabel":"string"},"content":{"type":"string","description":"UTM content parameter","uniqueKey":"broadcast.utm_parameters.content","typeLabel":"string"}},"uniqueKey":"broadcast.utm_parameters","typeLabel":"object"},"data_feed":{"type":"object","description":"Configuration for external data feeds","properties":{"global_feed":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the global data feed is enabled","example":true,"uniqueKey":"broadcast.data_feed.global_feed.enabled","typeLabel":"boolean"},"url":{"type":"string","description":"URL endpoint to fetch global data from (must be HTTPS)","example":"https://api.example.com/broadcast-data","uniqueKey":"broadcast.data_feed.global_feed.url","typeLabel":"string"},"headers":{"type":"array","description":"Custom HTTP headers to include in the request","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"HTTP header name","example":"Authorization","isRequired":true,"uniqueKey":"broadcast.data_feed.global_feed.headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"HTTP header value","example":"Bearer token123","isRequired":true,"uniqueKey":"broadcast.data_feed.global_feed.headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"broadcast.data_feed.global_feed.headers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"broadcast.data_feed.global_feed.headers","typeLabel":"object[]"}},"uniqueKey":"broadcast.data_feed.global_feed","typeLabel":"object"},"global_feed_data":{"type":"object","additionalProperties":true,"description":"Cached data from the global feed (populated after fetch)","uniqueKey":"broadcast.data_feed.global_feed_data","typeLabel":"object"},"global_feed_fetched_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the global feed was last fetched","uniqueKey":"broadcast.data_feed.global_feed_fetched_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the global feed was last fetched","uniqueKey":"broadcast.data_feed.global_feed_fetched_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.data_feed.global_feed_fetched_at","typeLabel":"string\u003cdate-time> | null"},"recipient_feed":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the per-recipient data feed is enabled","example":true,"uniqueKey":"broadcast.data_feed.recipient_feed.enabled","typeLabel":"boolean"},"url":{"type":"string","description":"URL endpoint to fetch per-recipient data from (must be HTTPS)","example":"https://api.example.com/recipient-data","uniqueKey":"broadcast.data_feed.recipient_feed.url","typeLabel":"string"},"headers":{"type":"array","description":"Custom HTTP headers to include in the request","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"HTTP header name","example":"Authorization","isRequired":true,"uniqueKey":"broadcast.data_feed.recipient_feed.headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"HTTP header value","example":"Bearer token123","isRequired":true,"uniqueKey":"broadcast.data_feed.recipient_feed.headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"broadcast.data_feed.recipient_feed.headers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"broadcast.data_feed.recipient_feed.headers","typeLabel":"object[]"}},"uniqueKey":"broadcast.data_feed.recipient_feed","typeLabel":"object"}},"uniqueKey":"broadcast.data_feed","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"description":"Custom metadata for the broadcast","uniqueKey":"broadcast.metadata","typeLabel":"object"},"winning_template":{"oneOf":[{"type":"string","description":"ID of the winning template variation","example":"template_winner","uniqueKey":"broadcast.winning_template.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the winning template variation","example":"template_winner","uniqueKey":"broadcast.winning_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.winning_template","typeLabel":"string | null"},"test_sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the A/B test was sent","uniqueKey":"broadcast.test_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the A/B test was sent","uniqueKey":"broadcast.test_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.test_sent_at","typeLabel":"string\u003cdate-time> | null"},"winner_sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the winning variation was sent","uniqueKey":"broadcast.winner_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the winning variation was sent","uniqueKey":"broadcast.winner_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.winner_sent_at","typeLabel":"string\u003cdate-time> | null"},"enqueued_count":{"type":"integer","description":"Number of emails added to the queue by orchestrator","example":1000,"uniqueKey":"broadcast.enqueued_count","typeLabel":"integer"},"test_phase_recipient_count":{"type":"integer","description":"Number of recipients in test phase","uniqueKey":"broadcast.test_phase_recipient_count","typeLabel":"integer"},"winner_phase_recipient_count":{"type":"integer","description":"Number of recipients in winner phase","uniqueKey":"broadcast.winner_phase_recipient_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"When the broadcast was created","uniqueKey":"broadcast.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When the broadcast was last updated","uniqueKey":"broadcast.updated_at","typeLabel":"string\u003cdate-time>"},"started_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the broadcast started sending","uniqueKey":"broadcast.started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the broadcast started sending","uniqueKey":"broadcast.started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.started_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the broadcast completed sending","uniqueKey":"broadcast.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the broadcast completed sending","uniqueKey":"broadcast.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.completed_at","typeLabel":"string\u003cdate-time> | null"},"cancelled_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the broadcast was cancelled","uniqueKey":"broadcast.cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the broadcast was cancelled","uniqueKey":"broadcast.cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.cancelled_at","typeLabel":"string\u003cdate-time> | null"},"paused_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the broadcast was paused","uniqueKey":"broadcast.paused_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the broadcast was paused","uniqueKey":"broadcast.paused_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.paused_at","typeLabel":"string\u003cdate-time> | null"},"pause_reason":{"oneOf":[{"type":"string","description":"Reason for pausing the broadcast","uniqueKey":"broadcast.pause_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason for pausing the broadcast","uniqueKey":"broadcast.pause_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"broadcast.pause_reason","typeLabel":"string | null"}},"uniqueKey":"broadcast","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"broadcast":{"id":"broadcast_12345","workspace_id":"ws_1234567890","name":"Spring Newsletter 2024","channel_type":"email","status":"draft","audience":{"list":"newsletter","segments":["premium_users"],"exclude_unsubscribed":true},"schedule":{"is_scheduled":false,"scheduled_date":"2024-03-15","scheduled_time":"10:30","timezone":"America/New_York","use_recipient_timezone":false},"test_settings":{"enabled":true,"sample_percentage":20,"auto_send_winner":true,"auto_send_winner_metric":"open_rate","test_duration_hours":24,"variations":[{"template_id":"template_variant_a","variation_name":"Variation A","metrics":{"recipients":123,"delivered":123,"opens":123,"clicks":123,"bounced":123,"complained":123,"unsubscribed":123},"template":{}}]},"utm_parameters":{"source":"newsletter","medium":"email","campaign":"spring_2024","term":"\u003cstring>","content":"\u003cstring>"},"data_feed":{"global_feed":{"enabled":true,"url":"https://api.example.com/broadcast-data","headers":[{"name":"Authorization","value":"Bearer token123"}]},"global_feed_data":{},"global_feed_fetched_at":"2023-11-07T05:31:56Z","recipient_feed":{"enabled":true,"url":"https://api.example.com/recipient-data","headers":[{"name":"Authorization","value":"Bearer token123"}]}},"metadata":{},"winning_template":"template_winner","test_sent_at":"2023-11-07T05:31:56Z","winner_sent_at":"2023-11-07T05:31:56Z","enqueued_count":1000,"test_phase_recipient_count":123,"winner_phase_recipient_count":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","started_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z","cancelled_at":"2023-11-07T05:31:56Z","paused_at":"2023-11-07T05:31:56Z","pause_reason":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9dfad2ca-0dea-4743-9a1b-baad6ffd8101":{"description":"Bad request - validation failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"missingName":{"title":"missingName","value":{"error":"name is required"}},"missingList":{"title":"missingList","value":{"error":"list is required"}},"invalidTestSettings":{"title":"invalidTestSettings","value":{"error":"at least 2 variations are required for A/B testing"}}},"exampleType":"examples"}},"exampleType":"examples"},"c17d01e3-2e83-4007-a885-a152eeb12c63":{"description":"Unauthorized - invalid or missing authentication token","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4f711467-00dc-4203-a95e-3e9d5bc737de":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Failed to create broadcast"},"examples":{"Example":{"title":"Example","value":{"error":"Failed to create broadcast"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e1eceed2-0cb9-45ff-b2b2-647da7af5a5a":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API token for authentication","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"26d4277a-6e4c-4b4f-b10e-d4b74e4c1afe":{"url":"https://{notifuseDomain}","description":"Customer-specific Notifuse API server","variables":{"notifuseDomain":{"description":"Your unique Notifuse domain","default":"demo.notifuse.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API token for authentication","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API token for authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"notifuse","siteName":"Notifuse Documentation","title":"Create a broadcast - Notifuse Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T13:59:41.770Z","originalFileLocation":"api-reference/create-a-broadcast.mdx"},"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=\"Creates a new broadcast campaign in draft status. Important: Creating a broadcast does not schedule or send it. After creating the broadcast, you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Notifuse Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_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/notifuse/c0N0ayUOq9_6B61d/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a broadcast - Notifuse Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new broadcast campaign in draft status. Important: Creating a broadcast does not schedule or send it. After creating the broadcast, you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Notifuse Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.notifuse.com/api-reference/create-a-broadcast\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://notifuse.mintlify.site/_mintlify/api/og/v2?division=Broadcasts\u0026amp;title=Create+a+broadcast\u0026amp;description=Creates+a+new+broadcast+campaign+in+draft+status.%0A%0A**Important%3A**+Creating+a+broadcast+does+not+schedule+or+send+it.+After+creating+the+broadcast%2C%0Ayou+must+call\u0026amp;theme=2416c428fba7698fa1a23c53\u0026amp;signature=0d083c31ad1ab53f8a96c83b1607f741e0e62a050aad23c774c94078b91b64a8\">\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=\"Create a broadcast - Notifuse Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new broadcast campaign in draft status. Important: Creating a broadcast does not schedule or send it. After creating the broadcast, you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://notifuse.mintlify.site/_mintlify/api/og/v2?division=Broadcasts\u0026amp;title=Create+a+broadcast\u0026amp;description=Creates+a+new+broadcast+campaign+in+draft+status.%0A%0A**Important%3A**+Creating+a+broadcast+does+not+schedule+or+send+it.+After+creating+the+broadcast%2C%0Ayou+must+call\u0026amp;theme=2416c428fba7698fa1a23c53\u0026amp;signature=0d083c31ad1ab53f8a96c83b1607f741e0e62a050aad23c774c94078b91b64a8\">\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/notifuse/c0N0ayUOq9_6B61d/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Notifuse Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7763F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.notifuse.com/api-reference/create-a-broadcast\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-a-broadcast.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.notifuse.com/#organization\",\"name\":\"Notifuse Documentation\",\"url\":\"https://docs.notifuse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/notifuse/Gw4P7NadUImyvZfw/assets/logo/logo-small.png?fit=max\u0026auto=format\u0026n=Gw4P7NadUImyvZfw\u0026q=85\u0026s=3f27c94b7162528f7c2d50f0d0dffdc4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.notifuse.com#website\",\"name\":\"Notifuse Documentation\",\"url\":\"https://docs.notifuse.com\",\"publisher\":{\"@id\":\"https://docs.notifuse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.notifuse.com/api-reference/create-a-broadcast#webpage\",\"url\":\"https://docs.notifuse.com/api-reference/create-a-broadcast\",\"name\":\"Create a broadcast\",\"description\":\"Creates a new broadcast campaign in draft status. Important: Creating a broadcast does not schedule or send it. After creating the broadcast, you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.\",\"dateModified\":\"2026-10-23T13:59:41.770Z\",\"isPartOf\":{\"@id\":\"https://docs.notifuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.notifuse.com/api-reference/create-a-broadcast#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.notifuse.com/api-reference/create-a-broadcast#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Broadcasts\",\"item\":\"https://docs.notifuse.com/api-reference/list-broadcasts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a broadcast\",\"item\":\"https://docs.notifuse.com/api-reference/create-a-broadcast\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.notifuse.com/api-reference/create-a-broadcast#apireference\",\"headline\":\"Create a broadcast\",\"name\":\"Create a broadcast\",\"description\":\"Creates a new broadcast campaign in draft status. Important: Creating a broadcast does not schedule or send it. After creating the broadcast, you must call the /api/broadcasts.schedule endpoint to schedule or send it immediately.\",\"url\":\"https://docs.notifuse.com/api-reference/create-a-broadcast\",\"mainEntityOfPage\":{\"@id\":\"https://docs.notifuse.com/api-reference/create-a-broadcast#webpage\"},\"dateModified\":\"2026-10-23T13:59:41.770Z\",\"publisher\":{\"@id\":\"https://docs.notifuse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.notifuse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Notifuse Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Notifuse Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Self-hosting","pages":[{"title":"Self-hosting","href":"/self-hosting/installation"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Root user programmatic signin","deprecated":null,"version":null,"openapi":"/openapi.json post /api/user.rootSignin","href":"/api-reference/authentication/root-user-programmatic-signin"}]},{"group":"Transactional","pages":[{"title":"Send a transactional notification","deprecated":null,"version":null,"openapi":"/openapi.json post /api/transactional.send","href":"/api-reference/send-a-transactional-notification"}]},{"group":"Contacts","pages":[{"title":"List contacts with filtering and pagination","deprecated":null,"version":null,"openapi":"/openapi.json get /api/contacts.list","href":"/api-reference/list-contacts-with-filtering-and-pagination"},{"title":"Count contacts in a workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /api/contacts.count","href":"/api-reference/count-contacts-in-a-workspace"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/contacts.upsert","href":"/api-reference/create-or-update-a-contact"},{"title":"Get a contact by email address","deprecated":null,"version":null,"openapi":"/openapi.json get /api/contacts.getByEmail","href":"/api-reference/get-a-contact-by-email-address"},{"title":"Get a contact by external ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/contacts.getByExternalID","href":"/api-reference/get-a-contact-by-external-id"},{"title":"Batch import contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/contacts.import","href":"/api-reference/batch-import-contacts"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/contacts.delete","href":"/api-reference/delete-a-contact"}]},{"group":"Lists","pages":[{"title":"Update contact list subscription status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/contactLists.updateStatus","href":"/api-reference/update-contact-list-subscription-status"},{"title":"Subscribe to email lists","deprecated":null,"version":null,"openapi":"/openapi.json post /subscribe","href":"/api-reference/subscribe-to-email-lists"},{"title":"Subscribe to email lists (authenticated)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/lists.subscribe","href":"/api-reference/subscribe-to-email-lists-authenticated"}]},{"group":"Custom Events","pages":[{"title":"Import custom events","deprecated":null,"version":null,"openapi":"/openapi.json post /api/customEvents.import","href":"/api-reference/import-custom-events"}]},{"group":"Web Analytics","pages":[{"title":"Ingest a web analytics beat","deprecated":null,"version":null,"openapi":"/openapi.json post /track","href":"/api-reference/web-analytics/ingest-a-web-analytics-beat"},{"title":"Replace the workspace's web analytics settings","deprecated":null,"version":null,"openapi":"/openapi.json post /api/workspaces.setWebAnalyticsSettings","href":"/api-reference/web-analytics/replace-the-workspaces-web-analytics-settings"},{"title":"Start an attribution backfill","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webAnalytics.backfillStart","href":"/api-reference/web-analytics/start-an-attribution-backfill"},{"title":"Get the latest backfill run","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webAnalytics.backfillStatus","href":"/api-reference/web-analytics/get-the-latest-backfill-run"},{"title":"Cancel the in-flight backfill run","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webAnalytics.backfillCancel","href":"/api-reference/web-analytics/cancel-the-in-flight-backfill-run"},{"title":"List annotations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/annotations.list","href":"/api-reference/web-analytics/list-annotations"},{"title":"Get an annotation","deprecated":null,"version":null,"openapi":"/openapi.json get /api/annotations.get","href":"/api-reference/web-analytics/get-an-annotation"},{"title":"Create an annotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/annotations.create","href":"/api-reference/web-analytics/create-an-annotation"},{"title":"Update an annotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/annotations.update","href":"/api-reference/web-analytics/update-an-annotation"},{"title":"Delete an annotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/annotations.delete","href":"/api-reference/web-analytics/delete-an-annotation"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/broadcasts.list","href":"/api-reference/list-broadcasts"},{"title":"Get a broadcast","description":"Retrieves a single broadcast by ID. Optionally includes template details for each variation.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/broadcasts.get","href":"/api-reference/get-a-broadcast"},{"title":"Create a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.create","href":"/api-reference/create-a-broadcast"},{"title":"Update a broadcast","description":"Updates an existing broadcast. Only broadcasts in draft, scheduled, or paused status can be updated.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.update","href":"/api-reference/update-a-broadcast"},{"title":"Schedule a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.schedule","href":"/api-reference/schedule-a-broadcast"},{"title":"Pause a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.pause","href":"/api-reference/pause-a-broadcast"},{"title":"Resume a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.resume","href":"/api-reference/resume-a-broadcast"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.cancel","href":"/api-reference/cancel-a-broadcast"},{"title":"Send broadcast to individual","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.sendToIndividual","href":"/api-reference/send-broadcast-to-individual"},{"title":"Delete a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.delete","href":"/api-reference/delete-a-broadcast"},{"title":"Get A/B test results","deprecated":null,"version":null,"openapi":"/openapi.json get /api/broadcasts.getTestResults","href":"/api-reference/get-ab-test-results"},{"title":"Select winning A/B test variation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/broadcasts.selectWinner","href":"/api-reference/select-winning-ab-test-variation"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/templates.list","href":"/api-reference/list-templates"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.json get /api/templates.get","href":"/api-reference/get-a-template"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/templates.create","href":"/api-reference/create-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/templates.update","href":"/api-reference/update-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/templates.delete","href":"/api-reference/delete-a-template"},{"title":"Compile template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/templates.compile","href":"/api-reference/compile-template"}]},{"group":"Blog","pages":[{"title":"List blog categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogCategories.list","href":"/api-reference/blog/list-blog-categories"},{"title":"Get a blog category","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogCategories.get","href":"/api-reference/blog/get-a-blog-category"},{"title":"Create a blog category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogCategories.create","href":"/api-reference/blog/create-a-blog-category"},{"title":"Update a blog category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogCategories.update","href":"/api-reference/blog/update-a-blog-category"},{"title":"Delete a blog category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogCategories.delete","href":"/api-reference/blog/delete-a-blog-category"},{"title":"List blog posts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogPosts.list","href":"/api-reference/blog/list-blog-posts"},{"title":"Get a blog post","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogPosts.get","href":"/api-reference/blog/get-a-blog-post"},{"title":"Create a blog post","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogPosts.create","href":"/api-reference/blog/create-a-blog-post"},{"title":"Update a blog post","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogPosts.update","href":"/api-reference/blog/update-a-blog-post"},{"title":"Delete a blog post","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogPosts.delete","href":"/api-reference/blog/delete-a-blog-post"},{"title":"Publish a blog post","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogPosts.publish","href":"/api-reference/blog/publish-a-blog-post"},{"title":"Unpublish a blog post","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogPosts.unpublish","href":"/api-reference/blog/unpublish-a-blog-post"},{"title":"List blog theme versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogThemes.list","href":"/api-reference/blog/list-blog-theme-versions"},{"title":"Get a blog theme version","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogThemes.get","href":"/api-reference/blog/get-a-blog-theme-version"},{"title":"Get the published blog theme","deprecated":null,"version":null,"openapi":"/openapi.json get /api/blogThemes.getPublished","href":"/api-reference/blog/get-the-published-blog-theme"},{"title":"Create a blog theme version","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogThemes.create","href":"/api-reference/blog/create-a-blog-theme-version"},{"title":"Update a blog theme version","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogThemes.update","href":"/api-reference/blog/update-a-blog-theme-version"},{"title":"Publish a blog theme version","deprecated":null,"version":null,"openapi":"/openapi.json post /api/blogThemes.publish","href":"/api-reference/blog/publish-a-blog-theme-version"}]},{"group":"Webhooks","pages":[{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.create","href":"/api-reference/create-a-webhook-subscription"},{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/webhookSubscriptions.list","href":"/api-reference/list-webhook-subscriptions"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /api/webhookSubscriptions.get","href":"/api-reference/get-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.update","href":"/api-reference/update-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.delete","href":"/api-reference/delete-a-webhook-subscription"},{"title":"Toggle webhook subscription enabled state","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.toggle","href":"/api-reference/toggle-webhook-subscription-enabled-state"},{"title":"Regenerate webhook secret","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.regenerateSecret","href":"/api-reference/regenerate-webhook-secret"},{"title":"Get webhook delivery history","deprecated":null,"version":null,"openapi":"/openapi.json get /api/webhookSubscriptions.deliveries","href":"/api-reference/get-webhook-delivery-history"},{"title":"Send a test webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/webhookSubscriptions.test","href":"/api-reference/send-a-test-webhook"},{"title":"List available event types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/webhookSubscriptions.eventTypes","href":"/api-reference/list-available-event-types"}]},{"group":"Audit logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/auditLogs.list","href":"/api-reference/audit-logs/list-audit-logs"},{"title":"Get an audit log entry","deprecated":null,"version":null,"openapi":"/openapi.json get /api/auditLogs.get","href":"/api-reference/audit-logs/get-an-audit-log-entry"},{"title":"List audit actions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/auditLogs.actions","href":"/api-reference/audit-logs/list-audit-actions"},{"title":"Export audit logs","deprecated":null,"version":null,"openapi":"/openapi.json post /api/auditLogs.export","href":"/api-reference/audit-logs/export-audit-logs"},{"title":"Set the workspace audit log retention","deprecated":null,"version":null,"openapi":"/openapi.json post /api/workspaces.setAuditLogSettings","href":"/api-reference/audit-logs/set-the-workspace-audit-log-retention"}]}]},{"tab":"Cloud","href":"https://cloud.notifuse.com"}]},"basePath":"","title":"Create a broadcast - Notifuse Documentation","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}