[{"data":1,"prerenderedAt":606},["ShallowReactive",2],{"navigation_docs":3,"-campaigns-activate-campaign":112,"-campaigns-activate-campaign-surround":601},[4,26,32,53,82,95],{"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,45,49],{"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},"List campaigns","\u002Fcampaigns\u002Flist-campaigns","3.campaigns\u002F3.list-campaigns",{"title":50,"path":51,"stem":52},"Activate campaign","\u002Fcampaigns\u002Factivate-campaign","3.campaigns\u002F4.activate-campaign",{"title":54,"path":55,"stem":56,"children":57,"page":25},"Recipients","\u002Frecipients","4.recipients",[58,62,66,70,74,78],{"title":59,"path":60,"stem":61},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":63,"path":64,"stem":65},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":67,"path":68,"stem":69},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":71,"path":72,"stem":73},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":75,"path":76,"stem":77},"Checkout recipients","\u002Frecipients\u002Fcheckout-recipients","4.recipients\u002F5.checkout-recipients",{"title":79,"path":80,"stem":81},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F6.png-api",{"title":83,"path":84,"stem":85,"children":86,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[87,91],{"title":88,"path":89,"stem":90},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":92,"path":93,"stem":94},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":96,"path":97,"stem":98,"children":99,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[100,104,108],{"title":101,"path":102,"stem":103},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":105,"path":106,"stem":107},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":109,"path":110,"stem":111},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F2.qr-code-scans",{"id":113,"title":50,"body":114,"description":594,"extension":595,"links":596,"meta":597,"navigation":598,"path":51,"seo":599,"stem":52,"__hash__":600},"docs\u002F3.campaigns\u002F4.activate-campaign.md",{"type":115,"value":116,"toc":585},"minimark",[117,130,146,153,158,161,193,200,204,213,217,253,257,305,309,315,441,450,454,463,476,482,486,568,581],[118,119,120,121,125,126,129],"p",{},"Activate a recurring campaign that is ",[122,123,124],"code",{},"pending"," or ",[122,127,128],{},"paused",".",[131,132,137],"pre",{"className":133,"code":134,"language":135,"meta":136,"style":136},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002F{campaignId}\u002Factivate\n","http","",[122,138,139],{"__ignoreMap":136},[140,141,144],"span",{"class":142,"line":143},"line",1,[140,145,134],{},[118,147,148,149,152],{},"Activation validates the campaign, derives its billing method, bills its existing pending recipients, and then changes its status to ",[122,150,151],{},"ready",". A ready recurring campaign accepts and bills new recipients through the normal recurring workflow.",[154,155,157],"h2",{"id":156},"prerequisites","Prerequisites",[118,159,160],{},"The campaign must:",[162,163,164,168,175,180,183,186],"ul",{},[165,166,167],"li",{},"belong to the team for the API key;",[165,169,170,171,174],{},"use ",[122,172,173],{},"frequency: \"recurring\"",";",[165,176,170,177,174],{},[122,178,179],{},"delivery_method: \"directMail\"",[165,181,182],{},"have a return address;",[165,184,185],{},"use a compatible published template and product;",[165,187,188,189,125,191,129],{},"have a status of ",[122,190,124],{},[122,192,128],{},[118,194,195,196,199],{},"The team must have recurring campaigns enabled and a supported billing setup. Campaign creation returns ",[122,197,198],{},"403"," before activation when recurring campaigns are not enabled.",[154,201,203],{"id":202},"headers","Headers",[131,205,207],{"className":133,"code":206,"language":135,"meta":136,"style":136},"X-API-Key: YOUR_API_KEY\n",[122,208,209],{"__ignoreMap":136},[140,210,211],{"class":142,"line":143},[140,212,206],{},[154,214,216],{"id":215},"path-parameters","Path parameters",[218,219,220,236],"table",{},[221,222,223],"thead",{},[224,225,226,230,233],"tr",{},[227,228,229],"th",{},"Parameter",[227,231,232],{},"Type",[227,234,235],{},"Description",[237,238,239],"tbody",{},[224,240,241,247,250],{},[242,243,244],"td",{},[122,245,246],{},"campaignId",[242,248,249],{},"string",[242,251,252],{},"Scribeless campaign ID.",[154,254,256],{"id":255},"example-request","Example request",[131,258,262],{"className":259,"code":260,"language":261,"meta":136,"style":136},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002FCAMPAIGN_ID\u002Factivate' \\\n  --header 'X-API-Key: YOUR_API_KEY'\n","bash",[122,263,264,291],{"__ignoreMap":136},[140,265,266,270,274,277,281,284,287],{"class":142,"line":143},[140,267,269],{"class":268},"sBMFI","curl",[140,271,273],{"class":272},"sfazB"," --request",[140,275,276],{"class":272}," POST",[140,278,280],{"class":279},"sMK4o"," '",[140,282,283],{"class":272},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002FCAMPAIGN_ID\u002Factivate",[140,285,286],{"class":279},"'",[140,288,290],{"class":289},"sTEyZ"," \\\n",[140,292,294,297,299,302],{"class":142,"line":293},2,[140,295,296],{"class":272},"  --header",[140,298,280],{"class":279},[140,300,301],{"class":272},"X-API-Key: YOUR_API_KEY",[140,303,304],{"class":279},"'\n",[154,306,308],{"id":307},"response","Response",[118,310,311,312,129],{},"A successful request returns the updated campaign with ",[122,313,314],{},"status: \"ready\"",[131,316,320],{"className":317,"code":318,"language":319,"meta":136,"style":136},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"CAMPAIGN_ID\",\n  \"status\": \"ready\",\n  \"frequency\": \"recurring\",\n  \"delivery_method\": \"directMail\",\n  \"billing_method\": \"subscription\"\n}\n","json",[122,321,322,327,353,373,394,415,435],{"__ignoreMap":136},[140,323,324],{"class":142,"line":143},[140,325,326],{"class":279},"{\n",[140,328,329,332,336,339,342,345,348,350],{"class":142,"line":293},[140,330,331],{"class":279},"  \"",[140,333,335],{"class":334},"spNyl","id",[140,337,338],{"class":279},"\"",[140,340,341],{"class":279},":",[140,343,344],{"class":279}," \"",[140,346,347],{"class":272},"CAMPAIGN_ID",[140,349,338],{"class":279},[140,351,352],{"class":279},",\n",[140,354,356,358,361,363,365,367,369,371],{"class":142,"line":355},3,[140,357,331],{"class":279},[140,359,360],{"class":334},"status",[140,362,338],{"class":279},[140,364,341],{"class":279},[140,366,344],{"class":279},[140,368,151],{"class":272},[140,370,338],{"class":279},[140,372,352],{"class":279},[140,374,376,378,381,383,385,387,390,392],{"class":142,"line":375},4,[140,377,331],{"class":279},[140,379,380],{"class":334},"frequency",[140,382,338],{"class":279},[140,384,341],{"class":279},[140,386,344],{"class":279},[140,388,389],{"class":272},"recurring",[140,391,338],{"class":279},[140,393,352],{"class":279},[140,395,397,399,402,404,406,408,411,413],{"class":142,"line":396},5,[140,398,331],{"class":279},[140,400,401],{"class":334},"delivery_method",[140,403,338],{"class":279},[140,405,341],{"class":279},[140,407,344],{"class":279},[140,409,410],{"class":272},"directMail",[140,412,338],{"class":279},[140,414,352],{"class":279},[140,416,418,420,423,425,427,429,432],{"class":142,"line":417},6,[140,419,331],{"class":279},[140,421,422],{"class":334},"billing_method",[140,424,338],{"class":279},[140,426,341],{"class":279},[140,428,344],{"class":279},[140,430,431],{"class":272},"subscription",[140,433,434],{"class":279},"\"\n",[140,436,438],{"class":142,"line":437},7,[140,439,440],{"class":279},"}\n",[118,442,443,444,446,447,129],{},"Scribeless derives ",[122,445,422],{}," from the team's billing setup. Clients cannot select the activation billing method. Campaigns in an invoice-billed lifecycle cannot be activated and return ",[122,448,449],{},"409",[154,451,453],{"id":452},"billing-and-retries","Billing and retries",[118,455,456,457,459,460,462],{},"Activation bills existing ",[122,458,124],{}," recipients before it marks the campaign as ",[122,461,151],{},". If billing fails, the campaign does not become ready and its recipients remain pending.",[118,464,465,466,469,470,472,473,475],{},"A ",[122,467,468],{},"502"," response is safe to retry. A ",[122,471,449],{}," can mean that activation is not allowed or that a previous payment is still processing. Read the error message before you retry a ",[122,474,449],{}," response.",[118,477,478,479,481],{},"Do not create recipients while an activation request is in progress. Wait for activation to return the campaign with ",[122,480,314],{}," before you create more recipients.",[154,483,485],{"id":484},"status-codes","Status codes",[218,487,488,498],{},[221,489,490],{},[224,491,492,495],{},[227,493,494],{},"Status",[227,496,497],{},"Meaning",[237,499,500,510,520,530,540,550,559],{},[224,501,502,507],{},[242,503,504],{},[122,505,506],{},"200",[242,508,509],{},"Campaign activated.",[224,511,512,517],{},[242,513,514],{},[122,515,516],{},"400",[242,518,519],{},"The campaign is not recurring direct mail, has no return address, or has an incompatible template or product.",[224,521,522,527],{},[242,523,524],{},[122,525,526],{},"401",[242,528,529],{},"The API key is missing, malformed, invalid, or unauthorized.",[224,531,532,537],{},[242,533,534],{},[122,535,536],{},"402",[242,538,539],{},"The team has no active recurring subscription, or payment is still required.",[224,541,542,547],{},[242,543,544],{},[122,545,546],{},"404",[242,548,549],{},"The campaign does not exist or does not belong to the team.",[224,551,552,556],{},[242,553,554],{},[122,555,449],{},[242,557,558],{},"The campaign is already active, has a terminal status, is invoice-billed, or has a payment still processing.",[224,560,561,565],{},[242,562,563],{},[122,564,468],{},[242,566,567],{},"Upstream billing failed. Recipients remain pending, and the request can be retried.",[118,569,570,571,574,575,129],{},"To activate during creation, set ",[122,572,573],{},"activate: true"," when you call ",[576,577,578],"a",{"href":39},[122,579,580],{},"POST \u002Fapi\u002Fcampaigns",[582,583,584],"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":136,"searchDepth":293,"depth":293,"links":586},[587,588,589,590,591,592,593],{"id":156,"depth":293,"text":157},{"id":202,"depth":293,"text":203},{"id":215,"depth":293,"text":216},{"id":255,"depth":293,"text":256},{"id":307,"depth":293,"text":308},{"id":452,"depth":293,"text":453},{"id":484,"depth":293,"text":485},"Activate an API-created recurring Scribeless campaign.","md",null,{},true,{"title":50,"description":594},"NHcsRnZW5Ih9_icRPtVnlDZcXraQiTJ5iOLTApCKE0w",[602,604],{"title":46,"path":47,"stem":48,"description":603,"children":-1},"Get Scribeless campaigns available to the authenticated team.",{"title":59,"path":60,"stem":61,"description":605,"children":-1},"Create one or more recipients for a Scribeless campaign.",1787244312521]