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