[{"data":1,"prerenderedAt":754},["ShallowReactive",2],{"navigation_docs":3,"-partner-workflows-account-status":104,"-partner-workflows-account-status-surround":749},[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":80,"body":106,"description":742,"extension":743,"links":744,"meta":745,"navigation":746,"path":81,"seo":747,"stem":82,"__hash__":748},"docs\u002F5.partner-workflows\u002F2.account-status.md",{"type":107,"value":108,"toc":733},"minimark",[109,113,130,133,138,147,151,199,203,206,385,389,507,511,514,650,654,682,686,729],[110,111,112],"p",{},"Check whether the account connected to an API key is ready to list templates, create campaigns, and complete approved partner billing setup.",[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","GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faccount\u002Fstatus\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[110,131,132],{},"This endpoint is most useful for approved partner integrations that provision or operate customer accounts. To become an approved partner, contact the Scribeless team.",[134,135,137],"h2",{"id":136},"headers","Headers",[114,139,141],{"className":116,"code":140,"language":118,"meta":119,"style":119},"X-API-Key: YOUR_API_KEY\n",[121,142,143],{"__ignoreMap":119},[124,144,145],{"class":126,"line":127},[124,146,140],{},[134,148,150],{"id":149},"example-request","Example request",[114,152,156],{"className":153,"code":154,"language":155,"meta":119,"style":119},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request GET 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faccount\u002Fstatus' \\\n  --header 'X-API-Key: YOUR_API_KEY'\n","bash",[121,157,158,185],{"__ignoreMap":119},[124,159,160,164,168,171,175,178,181],{"class":126,"line":127},[124,161,163],{"class":162},"sBMFI","curl",[124,165,167],{"class":166},"sfazB"," --request",[124,169,170],{"class":166}," GET",[124,172,174],{"class":173},"sMK4o"," '",[124,176,177],{"class":166},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faccount\u002Fstatus",[124,179,180],{"class":173},"'",[124,182,184],{"class":183},"sTEyZ"," \\\n",[124,186,188,191,193,196],{"class":126,"line":187},2,[124,189,190],{"class":166},"  --header",[124,192,174],{"class":173},[124,194,195],{"class":166},"X-API-Key: YOUR_API_KEY",[124,197,198],{"class":173},"'\n",[134,200,202],{"id":201},"response","Response",[110,204,205],{},"Successful requests return readiness flags for the API key's team.",[114,207,211],{"className":208,"code":209,"language":210,"meta":119,"style":119},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"teamId\": \"TEAM_ID\",\n  \"templatesReady\": true,\n  \"billByInvoice\": false,\n  \"canListTemplates\": true,\n  \"canCreateCampaigns\": true,\n  \"canCreateRecurringCampaign\": false,\n  \"billingSetupUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET\",\n  \"links\": {\n    \"templatesUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Ftemplates\"\n  }\n}\n","json",[121,212,213,218,244,259,274,288,302,316,337,352,373,379],{"__ignoreMap":119},[124,214,215],{"class":126,"line":127},[124,216,217],{"class":173},"{\n",[124,219,220,223,227,230,233,236,239,241],{"class":126,"line":187},[124,221,222],{"class":173},"  \"",[124,224,226],{"class":225},"spNyl","teamId",[124,228,229],{"class":173},"\"",[124,231,232],{"class":173},":",[124,234,235],{"class":173}," \"",[124,237,238],{"class":166},"TEAM_ID",[124,240,229],{"class":173},[124,242,243],{"class":173},",\n",[124,245,247,249,252,254,256],{"class":126,"line":246},3,[124,248,222],{"class":173},[124,250,251],{"class":225},"templatesReady",[124,253,229],{"class":173},[124,255,232],{"class":173},[124,257,258],{"class":173}," true,\n",[124,260,262,264,267,269,271],{"class":126,"line":261},4,[124,263,222],{"class":173},[124,265,266],{"class":225},"billByInvoice",[124,268,229],{"class":173},[124,270,232],{"class":173},[124,272,273],{"class":173}," false,\n",[124,275,277,279,282,284,286],{"class":126,"line":276},5,[124,278,222],{"class":173},[124,280,281],{"class":225},"canListTemplates",[124,283,229],{"class":173},[124,285,232],{"class":173},[124,287,258],{"class":173},[124,289,291,293,296,298,300],{"class":126,"line":290},6,[124,292,222],{"class":173},[124,294,295],{"class":225},"canCreateCampaigns",[124,297,229],{"class":173},[124,299,232],{"class":173},[124,301,258],{"class":173},[124,303,305,307,310,312,314],{"class":126,"line":304},7,[124,306,222],{"class":173},[124,308,309],{"class":225},"canCreateRecurringCampaign",[124,311,229],{"class":173},[124,313,232],{"class":173},[124,315,273],{"class":173},[124,317,319,321,324,326,328,330,333,335],{"class":126,"line":318},8,[124,320,222],{"class":173},[124,322,323],{"class":225},"billingSetupUrl",[124,325,229],{"class":173},[124,327,232],{"class":173},[124,329,235],{"class":173},[124,331,332],{"class":166},"https:\u002F\u002Fplatform.scribeless.co\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET",[124,334,229],{"class":173},[124,336,243],{"class":173},[124,338,340,342,345,347,349],{"class":126,"line":339},9,[124,341,222],{"class":173},[124,343,344],{"class":225},"links",[124,346,229],{"class":173},[124,348,232],{"class":173},[124,350,351],{"class":173}," {\n",[124,353,355,358,361,363,365,367,370],{"class":126,"line":354},10,[124,356,357],{"class":173},"    \"",[124,359,360],{"class":162},"templatesUrl",[124,362,229],{"class":173},[124,364,232],{"class":173},[124,366,235],{"class":173},[124,368,369],{"class":166},"https:\u002F\u002Fplatform.scribeless.co\u002Ftemplates",[124,371,372],{"class":173},"\"\n",[124,374,376],{"class":126,"line":375},11,[124,377,378],{"class":173},"  }\n",[124,380,382],{"class":126,"line":381},12,[124,383,384],{"class":173},"}\n",[134,386,388],{"id":387},"fields","Fields",[390,391,392,408],"table",{},[393,394,395],"thead",{},[396,397,398,402,405],"tr",{},[399,400,401],"th",{},"Field",[399,403,404],{},"Type",[399,406,407],{},"Description",[409,410,411,424,436,447,458,469,484,495],"tbody",{},[396,412,413,418,421],{},[414,415,416],"td",{},[121,417,226],{},[414,419,420],{},"string",[414,422,423],{},"Scribeless team ID for the API key.",[396,425,426,430,433],{},[414,427,428],{},[121,429,251],{},[414,431,432],{},"boolean",[414,434,435],{},"Whether the team has templates ready for campaign creation.",[396,437,438,442,444],{},[414,439,440],{},[121,441,266],{},[414,443,432],{},[414,445,446],{},"Whether approved partner invoice billing is ready for this team.",[396,448,449,453,455],{},[414,450,451],{},[121,452,281],{},[414,454,432],{},[414,456,457],{},"Whether the API key can list templates.",[396,459,460,464,466],{},[414,461,462],{},[121,463,295],{},[414,465,432],{},[414,467,468],{},"Whether the team can create campaigns through the API.",[396,470,471,475,477],{},[414,472,473],{},[121,474,309],{},[414,476,432],{},[414,478,479,480,483],{},"Whether the team can create recurring campaigns through the API. This is ",[121,481,482],{},"true"," when the team has templates and a recurring subscription configured.",[396,485,486,490,492],{},[414,487,488],{},[121,489,323],{},[414,491,420],{},[414,493,494],{},"Setup URL for approved partner invoice billing, when setup is required. This field is omitted when setup is not required.",[396,496,497,502,504],{},[414,498,499],{},[121,500,501],{},"links.templatesUrl",[414,503,420],{},[414,505,506],{},"Platform URL where the team can manage templates.",[134,508,510],{"id":509},"account-readiness-phases","Account readiness phases",[110,512,513],{},"Use the response to decide which setup step the customer needs next.",[390,515,516,532],{},[393,517,518],{},[396,519,520,523,526,529],{},[399,521,522],{},"Phase",[399,524,525],{},"How to identify",[399,527,528],{},"Meaning",[399,530,531],{},"Partner action",[409,533,534,560,580,601,632],{},[396,535,536,539,551,554],{},[414,537,538],{},"Newly provisioned",[414,540,541,544,545,544,548,550],{},[121,542,543],{},"templatesReady: false",", ",[121,546,547],{},"canCreateCampaigns: false",[121,549,323],{}," present",[414,552,553],{},"The team exists and the API key works, but setup is incomplete.",[414,555,556,557,559],{},"Store the ",[121,558,226],{}," and API key. Send the customer to billing setup and template setup.",[396,561,562,565,574,577],{},[414,563,564],{},"Billing ready, templates missing",[414,566,567,544,569,571,572],{},[121,568,543],{},[121,570,547],{},", no ",[121,573,323],{},[414,575,576],{},"Billing is configured, but no usable published template exists yet.",[414,578,579],{},"Send the customer to the templates page.",[396,581,582,585,595,598],{},[414,583,584],{},"Templates ready, billing setup needed",[414,586,587,544,590,544,593,550],{},[121,588,589],{},"templatesReady: true",[121,591,592],{},"canCreateCampaigns: true",[121,594,323],{},[414,596,597],{},"Campaigns can be created, but payment setup may still be required before fulfilment.",[414,599,600],{},"Allow campaign and recipient setup, then send the customer through checkout before fulfilment.",[396,602,603,606,615,618],{},[414,604,605],{},"One-time invoice ready",[414,607,608,544,610,544,613],{},[121,609,589],{},[121,611,612],{},"billByInvoice: true",[121,614,592],{},[414,616,617],{},"The customer can use approved partner invoice-billed one-time campaigns.",[414,619,620,621,624,625,631],{},"Create a one-time campaign with ",[121,622,623],{},"frequency: \"oneTime\"",", add recipients, then call ",[626,627,628],"a",{"href":85},[121,629,630],{},"POST \u002Fapi\u002Frecipients\u002Fcheckout",".",[396,633,634,637,644,647],{},[414,635,636],{},"Recurring ready",[414,638,639,544,641],{},[121,640,589],{},[121,642,643],{},"canCreateRecurringCampaign: true",[414,645,646],{},"The customer has a recurring subscription configured.",[414,648,649],{},"Create recurring campaigns. You do not need to call checkout recipients for recurring campaign billing.",[134,651,653],{"id":652},"usage","Usage",[655,656,657,671,676],"ul",{},[658,659,660,661,663,664,666,667,670],"li",{},"If ",[121,662,251],{}," or ",[121,665,295],{}," is ",[121,668,669],{},"false",", ask the customer to finish template setup in Scribeless.",[658,672,660,673,675],{},[121,674,323],{}," is present, the customer needs to complete billing setup before invoice-billed partner checkout can complete.",[658,677,678,679,681],{},"Do not store ",[121,680,323],{}," permanently. Fetch account status again before sending the customer back to setup.",[134,683,685],{"id":684},"status-codes","Status codes",[390,687,688,697],{},[393,689,690],{},[396,691,692,695],{},[399,693,694],{},"Status",[399,696,528],{},[409,698,699,709,719],{},[396,700,701,706],{},[414,702,703],{},[121,704,705],{},"200",[414,707,708],{},"Account status returned.",[396,710,711,716],{},[414,712,713],{},[121,714,715],{},"401",[414,717,718],{},"Missing, malformed, invalid, or unauthorized API key.",[396,720,721,726],{},[414,722,723],{},[121,724,725],{},"500",[414,727,728],{},"Account status could not be checked. Retry or contact support if it persists.",[730,731,732],"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":187,"depth":187,"links":734},[735,736,737,738,739,740,741],{"id":136,"depth":187,"text":137},{"id":149,"depth":187,"text":150},{"id":201,"depth":187,"text":202},{"id":387,"depth":187,"text":388},{"id":509,"depth":187,"text":510},{"id":652,"depth":187,"text":653},{"id":684,"depth":187,"text":685},"Check whether a Scribeless account is ready for API-driven sending.","md",null,{},true,{"title":80,"description":742},"UG8qd9NfoFouMdTCaMu1euMqIi589fNPIilDoRRti70",[750,752],{"title":76,"path":77,"stem":78,"description":751,"children":-1},"Provision a Scribeless customer team from an approved partner account.",{"title":84,"path":85,"stem":86,"description":753,"children":-1},"Complete checkout for approved partner one-time campaign recipients.",1780671949188]