[{"data":1,"prerenderedAt":799},["ShallowReactive",2],{"navigation_docs":3,"-campaigns-create-campaign":104,"-campaigns-create-campaign-surround":794},[4,26,32,45,70,87],{"title":5,"path":6,"stem":7,"children":8,"page":25},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F2.authentication",{"title":18,"path":19,"stem":20},"Campaign setup","\u002Fgetting-started\u002Fcampaigns","1.getting-started\u002F3.campaigns",{"title":22,"path":23,"stem":24},"AI agent skills","\u002Fgetting-started\u002Fai-agent-skills","1.getting-started\u002F4.ai-agent-skills",false,{"title":27,"path":28,"stem":29,"children":30},"Templates","\u002Ftemplates","2.templates\u002Findex",[31],{"title":27,"path":28,"stem":29},{"title":33,"path":34,"stem":35,"children":36,"page":25},"Campaigns","\u002Fcampaigns","3.campaigns",[37,41],{"title":38,"path":39,"stem":40},"Create campaign","\u002Fcampaigns\u002Fcreate-campaign","3.campaigns\u002F1.create-campaign",{"title":42,"path":43,"stem":44},"Fetch campaign","\u002Fcampaigns\u002Ffetch-campaign","3.campaigns\u002F2.fetch-campaign",{"title":46,"path":47,"stem":48,"children":49,"page":25},"Recipients","\u002Frecipients","4.recipients",[50,54,58,62,66],{"title":51,"path":52,"stem":53},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":55,"path":56,"stem":57},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":59,"path":60,"stem":61},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":63,"path":64,"stem":65},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":67,"path":68,"stem":69},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F5.png-api",{"title":71,"path":72,"stem":73,"children":74,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[75,79,83],{"title":76,"path":77,"stem":78},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":80,"path":81,"stem":82},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":84,"path":85,"stem":86},"Checkout recipients","\u002Fpartner-workflows\u002Fcheckout-recipients","5.partner-workflows\u002F3.checkout-recipients",{"title":88,"path":89,"stem":90,"children":91,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[92,96,100],{"title":93,"path":94,"stem":95},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":97,"path":98,"stem":99},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":101,"path":102,"stem":103},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F2.qr-code-scans",{"id":105,"title":38,"body":106,"description":787,"extension":788,"links":789,"meta":790,"navigation":791,"path":39,"seo":792,"stem":40,"__hash__":793},"docs\u002F3.campaigns\u002F1.create-campaign.md",{"type":107,"value":108,"toc":780},"minimark",[109,113,130,140,145,161,165,334,338,528,532,546,718,726,730,776],[110,111,112],"p",{},"Create a Scribeless campaign, then use the returned campaign ID when creating recipients.",[114,115,120],"pre",{"className":116,"code":117,"language":118,"meta":119,"style":119},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[110,131,132,133,139],{},"For most integrations, creating the campaign in the platform UI is simpler. Use this endpoint when you already have the product and template IDs your integration should use. You can discover published templates and their compatible products with ",[134,135,136],"a",{"href":28},[121,137,138],{},"GET \u002Fapi\u002Ftemplates",".",[141,142,144],"h2",{"id":143},"headers","Headers",[114,146,148],{"className":116,"code":147,"language":118,"meta":119,"style":119},"Content-Type: application\u002Fjson\nX-API-Key: YOUR_API_KEY\n",[121,149,150,155],{"__ignoreMap":119},[124,151,152],{"class":126,"line":127},[124,153,154],{},"Content-Type: application\u002Fjson\n",[124,156,158],{"class":126,"line":157},2,[124,159,160],{},"X-API-Key: YOUR_API_KEY\n",[141,162,164],{"id":163},"request-body","Request body",[166,167,168,184],"table",{},[169,170,171],"thead",{},[172,173,174,178,181],"tr",{},[175,176,177],"th",{},"Field",[175,179,180],{},"Type",[175,182,183],{},"Description",[185,186,187,201,219,236,248,260,273,285,297,310,322],"tbody",{},[172,188,189,195,198],{},[190,191,192],"td",{},[121,193,194],{},"name",[190,196,197],{},"string",[190,199,200],{},"Campaign name shown in Scribeless.",[172,202,203,208,210],{},[190,204,205],{},[121,206,207],{},"delivery_method",[190,209,197],{},[190,211,212,215,216,139],{},[121,213,214],{},"directMail"," or ",[121,217,218],{},"bulkShipping",[172,220,221,226,228],{},[190,222,223],{},[121,224,225],{},"frequency",[190,227,197],{},[190,229,230,215,233,139],{},[121,231,232],{},"oneTime",[121,234,235],{},"recurring",[172,237,238,243,245],{},[190,239,240],{},[121,241,242],{},"product_id",[190,244,197],{},[190,246,247],{},"Product ID for the mail format.",[172,249,250,255,257],{},[190,251,252],{},[121,253,254],{},"template_id",[190,256,197],{},[190,258,259],{},"Published template ID to render.",[172,261,262,267,270],{},[190,263,264],{},[121,265,266],{},"include_envelope",[190,268,269],{},"boolean",[190,271,272],{},"Optional. Whether to include an envelope where supported.",[172,274,275,280,282],{},[190,276,277],{},[121,278,279],{},"envelope_sealed",[190,281,269],{},[190,283,284],{},"Optional. Whether the envelope should be sealed.",[172,286,287,292,294],{},[190,288,289],{},[121,290,291],{},"stamp_on_envelope",[190,293,269],{},[190,295,296],{},"Optional. Whether the stamp goes on the envelope.",[172,298,299,304,307],{},[190,300,301],{},[121,302,303],{},"shipping_address",[190,305,306],{},"object",[190,308,309],{},"Required for bulk shipping campaigns.",[172,311,312,317,319],{},[190,313,314],{},[121,315,316],{},"return_address",[190,318,306],{},[190,320,321],{},"Optional return address for direct mail.",[172,323,324,329,331],{},[190,325,326],{},[121,327,328],{},"tracking_email",[190,330,197],{},[190,332,333],{},"Optional notification email.",[141,335,337],{"id":336},"example-request","Example request",[114,339,343],{"className":340,"code":341,"language":342,"meta":119,"style":119},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"name\": \"API postcard campaign\",\n    \"delivery_method\": \"directMail\",\n    \"frequency\": \"oneTime\",\n    \"product_id\": \"PRODUCT_ID\",\n    \"template_id\": \"TEMPLATE_ID\",\n    \"include_envelope\": true,\n    \"stamp_on_envelope\": true,\n    \"return_address\": {\n      \"type\": \"return\",\n      \"first_name\": \"Ada\",\n      \"last_name\": \"Lovelace\",\n      \"company\": \"Example Co\",\n      \"address1\": \"1 Example Street\",\n      \"city\": \"London\",\n      \"state\": \"London\",\n      \"postal_code\": \"SW1A 1AA\",\n      \"country\": \"GB\"\n    }\n  }'\n","bash",[121,344,345,372,386,400,411,417,423,429,435,441,447,453,459,465,471,477,483,489,495,501,507,513,519],{"__ignoreMap":119},[124,346,347,351,355,358,362,365,368],{"class":126,"line":127},[124,348,350],{"class":349},"sBMFI","curl",[124,352,354],{"class":353},"sfazB"," --request",[124,356,357],{"class":353}," POST",[124,359,361],{"class":360},"sMK4o"," '",[124,363,364],{"class":353},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns",[124,366,367],{"class":360},"'",[124,369,371],{"class":370},"sTEyZ"," \\\n",[124,373,374,377,379,382,384],{"class":126,"line":157},[124,375,376],{"class":353},"  --header",[124,378,361],{"class":360},[124,380,381],{"class":353},"Content-Type: application\u002Fjson",[124,383,367],{"class":360},[124,385,371],{"class":370},[124,387,389,391,393,396,398],{"class":126,"line":388},3,[124,390,376],{"class":353},[124,392,361],{"class":360},[124,394,395],{"class":353},"X-API-Key: YOUR_API_KEY",[124,397,367],{"class":360},[124,399,371],{"class":370},[124,401,403,406,408],{"class":126,"line":402},4,[124,404,405],{"class":353},"  --data",[124,407,361],{"class":360},[124,409,410],{"class":353},"{\n",[124,412,414],{"class":126,"line":413},5,[124,415,416],{"class":353},"    \"name\": \"API postcard campaign\",\n",[124,418,420],{"class":126,"line":419},6,[124,421,422],{"class":353},"    \"delivery_method\": \"directMail\",\n",[124,424,426],{"class":126,"line":425},7,[124,427,428],{"class":353},"    \"frequency\": \"oneTime\",\n",[124,430,432],{"class":126,"line":431},8,[124,433,434],{"class":353},"    \"product_id\": \"PRODUCT_ID\",\n",[124,436,438],{"class":126,"line":437},9,[124,439,440],{"class":353},"    \"template_id\": \"TEMPLATE_ID\",\n",[124,442,444],{"class":126,"line":443},10,[124,445,446],{"class":353},"    \"include_envelope\": true,\n",[124,448,450],{"class":126,"line":449},11,[124,451,452],{"class":353},"    \"stamp_on_envelope\": true,\n",[124,454,456],{"class":126,"line":455},12,[124,457,458],{"class":353},"    \"return_address\": {\n",[124,460,462],{"class":126,"line":461},13,[124,463,464],{"class":353},"      \"type\": \"return\",\n",[124,466,468],{"class":126,"line":467},14,[124,469,470],{"class":353},"      \"first_name\": \"Ada\",\n",[124,472,474],{"class":126,"line":473},15,[124,475,476],{"class":353},"      \"last_name\": \"Lovelace\",\n",[124,478,480],{"class":126,"line":479},16,[124,481,482],{"class":353},"      \"company\": \"Example Co\",\n",[124,484,486],{"class":126,"line":485},17,[124,487,488],{"class":353},"      \"address1\": \"1 Example Street\",\n",[124,490,492],{"class":126,"line":491},18,[124,493,494],{"class":353},"      \"city\": \"London\",\n",[124,496,498],{"class":126,"line":497},19,[124,499,500],{"class":353},"      \"state\": \"London\",\n",[124,502,504],{"class":126,"line":503},20,[124,505,506],{"class":353},"      \"postal_code\": \"SW1A 1AA\",\n",[124,508,510],{"class":126,"line":509},21,[124,511,512],{"class":353},"      \"country\": \"GB\"\n",[124,514,516],{"class":126,"line":515},22,[124,517,518],{"class":353},"    }\n",[124,520,522,525],{"class":126,"line":521},23,[124,523,524],{"class":353},"  }",[124,526,527],{"class":360},"'\n",[141,529,531],{"id":530},"response","Response",[110,533,534,535,538,539,542,543,139],{},"Successful requests return the created campaign object. Use its ",[121,536,537],{},"id"," as ",[121,540,541],{},"campaignId"," when calling ",[121,544,545],{},"POST \u002Fapi\u002Frecipients",[114,547,551],{"className":548,"code":549,"language":550,"meta":119,"style":119},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"CAMPAIGN_ID\",\n  \"name\": \"API postcard campaign\",\n  \"status\": \"pending\",\n  \"delivery_method\": \"directMail\",\n  \"frequency\": \"oneTime\",\n  \"billing_method\": \"oneTime\",\n  \"product_id\": \"PRODUCT_ID\",\n  \"template_id\": \"TEMPLATE_ID\"\n}\n","json",[121,552,553,557,582,601,621,639,657,676,695,713],{"__ignoreMap":119},[124,554,555],{"class":126,"line":127},[124,556,410],{"class":360},[124,558,559,562,565,568,571,574,577,579],{"class":126,"line":157},[124,560,561],{"class":360},"  \"",[124,563,537],{"class":564},"spNyl",[124,566,567],{"class":360},"\"",[124,569,570],{"class":360},":",[124,572,573],{"class":360}," \"",[124,575,576],{"class":353},"CAMPAIGN_ID",[124,578,567],{"class":360},[124,580,581],{"class":360},",\n",[124,583,584,586,588,590,592,594,597,599],{"class":126,"line":388},[124,585,561],{"class":360},[124,587,194],{"class":564},[124,589,567],{"class":360},[124,591,570],{"class":360},[124,593,573],{"class":360},[124,595,596],{"class":353},"API postcard campaign",[124,598,567],{"class":360},[124,600,581],{"class":360},[124,602,603,605,608,610,612,614,617,619],{"class":126,"line":402},[124,604,561],{"class":360},[124,606,607],{"class":564},"status",[124,609,567],{"class":360},[124,611,570],{"class":360},[124,613,573],{"class":360},[124,615,616],{"class":353},"pending",[124,618,567],{"class":360},[124,620,581],{"class":360},[124,622,623,625,627,629,631,633,635,637],{"class":126,"line":413},[124,624,561],{"class":360},[124,626,207],{"class":564},[124,628,567],{"class":360},[124,630,570],{"class":360},[124,632,573],{"class":360},[124,634,214],{"class":353},[124,636,567],{"class":360},[124,638,581],{"class":360},[124,640,641,643,645,647,649,651,653,655],{"class":126,"line":419},[124,642,561],{"class":360},[124,644,225],{"class":564},[124,646,567],{"class":360},[124,648,570],{"class":360},[124,650,573],{"class":360},[124,652,232],{"class":353},[124,654,567],{"class":360},[124,656,581],{"class":360},[124,658,659,661,664,666,668,670,672,674],{"class":126,"line":425},[124,660,561],{"class":360},[124,662,663],{"class":564},"billing_method",[124,665,567],{"class":360},[124,667,570],{"class":360},[124,669,573],{"class":360},[124,671,232],{"class":353},[124,673,567],{"class":360},[124,675,581],{"class":360},[124,677,678,680,682,684,686,688,691,693],{"class":126,"line":431},[124,679,561],{"class":360},[124,681,242],{"class":564},[124,683,567],{"class":360},[124,685,570],{"class":360},[124,687,573],{"class":360},[124,689,690],{"class":353},"PRODUCT_ID",[124,692,567],{"class":360},[124,694,581],{"class":360},[124,696,697,699,701,703,705,707,710],{"class":126,"line":437},[124,698,561],{"class":360},[124,700,254],{"class":564},[124,702,567],{"class":360},[124,704,570],{"class":360},[124,706,573],{"class":360},[124,708,709],{"class":353},"TEMPLATE_ID",[124,711,712],{"class":360},"\"\n",[124,714,715],{"class":126,"line":443},[124,716,717],{"class":360},"}\n",[110,719,720,721,139],{},"You can fetch the campaign later with ",[134,722,723],{"href":43},[121,724,725],{},"GET \u002Fapi\u002Fcampaigns\u002F{campaignId}",[141,727,729],{"id":728},"notes","Notes",[731,732,733,737,744,747,750,767],"ul",{},[734,735,736],"li",{},"Product and template selection must be compatible. For example, a postcard campaign must use a postcard product and a published postcard template.",[734,738,739,740,743],{},"Campaign variables in the template must match the recipient fields or ",[121,741,742],{},"variables"," you send later.",[734,745,746],{},"If you do not already know the required product and template IDs, create the campaign in the platform UI and use the recipient API against that campaign.",[734,748,749],{},"Do not send billing fields when creating public API campaigns. Billing is handled by your Scribeless account setup.",[734,751,752,753,756,757,762,763,766],{},"Approved partner invoice-billed workflows should create a normal one-time campaign with ",[121,754,755],{},"frequency: \"oneTime\""," and then call ",[134,758,759],{"href":85},[121,760,761],{},"POST \u002Fapi\u002Frecipients\u002Fcheckout"," after adding recipients. Do not send ",[121,764,765],{},"billing_method: \"oneTimeInvoice\"","; it is not accepted by this endpoint.",[734,768,769,770,139],{},"For campaign status definitions, see the ",[134,771,775],{"href":772,"rel":773},"https:\u002F\u002Fhelp.scribeless.co\u002Fen\u002Farticles\u002F8800855-campaign-recipient-statuses",[774],"nofollow","Campaign and recipient statuses Help Center article",[777,778,779],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":119,"searchDepth":157,"depth":157,"links":781},[782,783,784,785,786],{"id":143,"depth":157,"text":144},{"id":163,"depth":157,"text":164},{"id":336,"depth":157,"text":337},{"id":530,"depth":157,"text":531},{"id":728,"depth":157,"text":729},"Create a Scribeless campaign through the API.","md",null,{},true,{"title":38,"description":787},"CUekTFGppIXBR70Sq7RMOyqavwuiHdr5SsON8zOBRpE",[795,797],{"title":27,"path":28,"stem":29,"description":796,"children":-1},"List, fetch, and create Scribeless templates for campaign creation.",{"title":42,"path":43,"stem":44,"description":798,"children":-1},"Get a Scribeless campaign by ID.",1780671947975]