[{"data":1,"prerenderedAt":768},["ShallowReactive",2],{"navigation_docs":3,"-address-finder-find-address":157,"-address-finder-find-address-surround":763},[4,26,32,53,90,107,136],{"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,82,86],{"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},"List recipients","\u002Frecipients\u002Flist-recipients","4.recipients\u002F7.list-recipients",{"title":87,"path":88,"stem":89},"Create bulk HTML recipients","\u002Frecipients\u002Fcreate-bulk-html-recipients","4.recipients\u002F8.create-bulk-html-recipients",{"title":91,"path":92,"stem":93,"children":94,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[95,99,103],{"title":96,"path":97,"stem":98},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":100,"path":101,"stem":102},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":104,"path":105,"stem":106},"Prepaid credit","\u002Fpartner-workflows\u002Fprepaid-credit","5.partner-workflows\u002F3.prepaid-credit",{"title":108,"path":109,"stem":110,"children":111,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[112,116,120,124,128,132],{"title":113,"path":114,"stem":115},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":117,"path":118,"stem":119},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":121,"path":122,"stem":123},"Recipient events","\u002Fwebhooks\u002Frecipient-events","6.webhooks\u002F2.recipient-events",{"title":125,"path":126,"stem":127},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F3.qr-code-scans",{"title":129,"path":130,"stem":131},"Receive deliveries","\u002Fwebhooks\u002Freceive-deliveries","6.webhooks\u002F4.receive-deliveries",{"title":133,"path":134,"stem":135},"Test and resend","\u002Fwebhooks\u002Ftest-and-resend","6.webhooks\u002F5.test-and-resend",{"title":137,"path":138,"stem":139,"children":140,"page":25},"Address Finder","\u002Faddress-finder","7.address-finder",[141,145,149,153],{"title":142,"path":143,"stem":144},"Find an address","\u002Faddress-finder\u002Ffind-address","7.address-finder\u002F1.find-address",{"title":146,"path":147,"stem":148},"Fetch lookup","\u002Faddress-finder\u002Ffetch-lookup","7.address-finder\u002F2.fetch-lookup",{"title":150,"path":151,"stem":152},"List lookups","\u002Faddress-finder\u002Flist-lookups","7.address-finder\u002F3.list-lookups",{"title":154,"path":155,"stem":156},"Usage","\u002Faddress-finder\u002Fusage","7.address-finder\u002F4.usage",{"id":158,"title":142,"body":159,"description":756,"extension":757,"links":758,"meta":759,"navigation":760,"path":143,"seo":761,"stem":144,"__hash__":762},"docs\u002F7.address-finder\u002F1.find-address.md",{"type":160,"value":161,"toc":748},"minimark",[162,166,183,186,208,213,229,233,236,279,282,463,466,470,570,574,581,641,645,667,671,744],[163,164,165],"p",{},"Address Finder finds a person's business mailing address from their LinkedIn profile, or from their company and location. Use it when you know who to write to, but not where to send the letter.",[167,168,173],"pre",{"className":169,"code":170,"language":171,"meta":172,"style":172},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Flookups\n","http","",[174,175,176],"code",{"__ignoreMap":172},[177,178,181],"span",{"class":179,"line":180},"line",1,[177,182,170],{},[163,184,185],{},"Address Finder is available on request. Contact the Scribeless team to turn it on for your team.",[163,187,188,189,195,196,199,200,203,204,207],{},"A lookup runs in the background and usually takes 30 to 90 seconds. This endpoint starts the lookup and returns its ID. Then call ",[190,191,192],"a",{"href":147},[174,193,194],{},"GET \u002Fapi\u002Faddress-finder\u002Flookups\u002F{lookupId}"," until ",[174,197,198],{},"status"," is ",[174,201,202],{},"completed"," or ",[174,205,206],{},"failed",".",[209,210,212],"h2",{"id":211},"headers","Headers",[167,214,216],{"className":169,"code":215,"language":171,"meta":172,"style":172},"X-API-Key: YOUR_API_KEY\nContent-Type: application\u002Fjson\n",[174,217,218,223],{"__ignoreMap":172},[177,219,220],{"class":179,"line":180},[177,221,222],{},"X-API-Key: YOUR_API_KEY\n",[177,224,226],{"class":179,"line":225},2,[177,227,228],{},"Content-Type: application\u002Fjson\n",[209,230,232],{"id":231},"body","Body",[163,234,235],{},"Send one of these input sets:",[237,238,239,245,264],"ul",{},[240,241,242,207],"li",{},[174,243,244],{},"linkedin_url",[240,246,247,203,250,253,254,257,258,203,261,207],{},[174,248,249],{},"company_domain",[174,251,252],{},"email",", with ",[174,255,256],{},"location",", ",[174,259,260],{},"address.city",[174,262,263],{},"address.postal_code",[240,265,266,267,257,270,272,273,203,276,207],{},"A full street address (",[174,268,269],{},"address.address1",[174,271,260],{}," and a country), with ",[174,274,275],{},"full_name",[174,277,278],{},"company_name",[163,280,281],{},"Add other fields when you have them. More inputs give better results.",[283,284,285,301],"table",{},[286,287,288],"thead",{},[289,290,291,295,298],"tr",{},[292,293,294],"th",{},"Field",[292,296,297],{},"Type",[292,299,300],{},"Description",[302,303,304,317,328,340,351,365,376,393,418,451],"tbody",{},[289,305,306,311,314],{},[307,308,309],"td",{},[174,310,244],{},[307,312,313],{},"string",[307,315,316],{},"LinkedIn profile URL of the person. Maximum length is 500 characters.",[289,318,319,323,325],{},[307,320,321],{},[174,322,275],{},[307,324,313],{},[307,326,327],{},"Full name of the person.",[289,329,330,335,337],{},[307,331,332],{},[174,333,334],{},"job_title",[307,336,313],{},[307,338,339],{},"Job title of the person.",[289,341,342,346,348],{},[307,343,344],{},[174,345,252],{},[307,347,313],{},[307,349,350],{},"Work email of the person.",[289,352,353,357,359],{},[307,354,355],{},[174,356,249],{},[307,358,313],{},[307,360,361,362,207],{},"Company website domain, for example ",[174,363,364],{},"acme.com",[289,366,367,371,373],{},[307,368,369],{},[174,370,278],{},[307,372,313],{},[307,374,375],{},"Company name.",[289,377,378,382,384],{},[307,379,380],{},[174,381,256],{},[307,383,313],{},[307,385,386,387,203,390,207],{},"Free-text location, for example ",[174,388,389],{},"London",[174,391,392],{},"Austin, TX",[289,394,395,400,402],{},[307,396,397],{},[174,398,399],{},"country",[307,401,313],{},[307,403,404,405,203,408,411,412,415,416,207],{},"Two-letter country code, for example ",[174,406,407],{},"GB",[174,409,410],{},"US",". ",[174,413,414],{},"UK"," is accepted as ",[174,417,407],{},[289,419,420,425,428],{},[307,421,422],{},[174,423,424],{},"address",[307,426,427],{},"object",[307,429,430,431,257,434,257,437,257,440,257,443,257,446,257,449,207],{},"A known address to check. Fields: ",[174,432,433],{},"address1",[174,435,436],{},"address2",[174,438,439],{},"address3",[174,441,442],{},"city",[174,444,445],{},"state",[174,447,448],{},"postal_code",[174,450,399],{},[289,452,453,458,460],{},[307,454,455],{},[174,456,457],{},"external_id",[307,459,313],{},[307,461,462],{},"Your own reference for the lookup, for example a CRM contact ID. Maximum length is 160 characters.",[163,464,465],{},"Text fields have a maximum length of 200 characters. Unknown fields are rejected.",[209,467,469],{"id":468},"example-request","Example request",[167,471,475],{"className":472,"code":473,"language":474,"meta":172,"style":172},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Flookups' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --data '{\n    \"linkedin_url\": \"https:\u002F\u002Fwww.linkedin.com\u002Fin\u002Fjane-doe\",\n    \"company_domain\": \"acme.com\",\n    \"external_id\": \"crm-contact-123\"\n  }'\n","bash",[174,476,477,504,518,532,543,549,555,561],{"__ignoreMap":172},[177,478,479,483,487,490,494,497,500],{"class":179,"line":180},[177,480,482],{"class":481},"sBMFI","curl",[177,484,486],{"class":485},"sfazB"," --request",[177,488,489],{"class":485}," POST",[177,491,493],{"class":492},"sMK4o"," '",[177,495,496],{"class":485},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Flookups",[177,498,499],{"class":492},"'",[177,501,503],{"class":502},"sTEyZ"," \\\n",[177,505,506,509,511,514,516],{"class":179,"line":225},[177,507,508],{"class":485},"  --header",[177,510,493],{"class":492},[177,512,513],{"class":485},"X-API-Key: YOUR_API_KEY",[177,515,499],{"class":492},[177,517,503],{"class":502},[177,519,521,523,525,528,530],{"class":179,"line":520},3,[177,522,508],{"class":485},[177,524,493],{"class":492},[177,526,527],{"class":485},"Content-Type: application\u002Fjson",[177,529,499],{"class":492},[177,531,503],{"class":502},[177,533,535,538,540],{"class":179,"line":534},4,[177,536,537],{"class":485},"  --data",[177,539,493],{"class":492},[177,541,542],{"class":485},"{\n",[177,544,546],{"class":179,"line":545},5,[177,547,548],{"class":485},"    \"linkedin_url\": \"https:\u002F\u002Fwww.linkedin.com\u002Fin\u002Fjane-doe\",\n",[177,550,552],{"class":179,"line":551},6,[177,553,554],{"class":485},"    \"company_domain\": \"acme.com\",\n",[177,556,558],{"class":179,"line":557},7,[177,559,560],{"class":485},"    \"external_id\": \"crm-contact-123\"\n",[177,562,564,567],{"class":179,"line":563},8,[177,565,566],{"class":485},"  }",[177,568,569],{"class":492},"'\n",[209,571,573],{"id":572},"response","Response",[163,575,576,577,580],{},"Successful requests return ",[174,578,579],{},"202"," with the lookup ID.",[167,582,586],{"className":583,"code":584,"language":585,"meta":172,"style":172},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"LOOKUP_ID\",\n  \"status\": \"queued\"\n}\n","json",[174,587,588,592,618,636],{"__ignoreMap":172},[177,589,590],{"class":179,"line":180},[177,591,542],{"class":492},[177,593,594,597,601,604,607,610,613,615],{"class":179,"line":225},[177,595,596],{"class":492},"  \"",[177,598,600],{"class":599},"spNyl","id",[177,602,603],{"class":492},"\"",[177,605,606],{"class":492},":",[177,608,609],{"class":492}," \"",[177,611,612],{"class":485},"LOOKUP_ID",[177,614,603],{"class":492},[177,616,617],{"class":492},",\n",[177,619,620,622,624,626,628,630,633],{"class":179,"line":520},[177,621,596],{"class":492},[177,623,198],{"class":599},[177,625,603],{"class":492},[177,627,606],{"class":492},[177,629,609],{"class":492},[177,631,632],{"class":485},"queued",[177,634,635],{"class":492},"\"\n",[177,637,638],{"class":179,"line":534},[177,639,640],{"class":492},"}\n",[209,642,644],{"id":643},"lookups-and-your-limit","Lookups and your limit",[237,646,647,650,653,659],{},[240,648,649],{},"Each new lookup uses one lookup from your team's limit, also when no address is found.",[240,651,652],{},"The limit is a total. It does not reset each month. Contact the Scribeless team to add more lookups.",[240,654,655,656,658],{},"The same inputs for the same team return the first lookup again and do not use another lookup. ",[174,657,457],{}," is not part of this check.",[240,660,661,662,207],{},"Check how many lookups you have left with ",[190,663,664],{"href":155},[174,665,666],{},"GET \u002Fapi\u002Faddress-finder\u002Fusage",[209,668,670],{"id":669},"status-codes","Status codes",[283,672,673,683],{},[286,674,675],{},[289,676,677,680],{},[292,678,679],{},"Status",[292,681,682],{},"Meaning",[302,684,685,694,704,714,724,734],{},[289,686,687,691],{},[307,688,689],{},[174,690,579],{},[307,692,693],{},"Lookup started.",[289,695,696,701],{},[307,697,698],{},[174,699,700],{},"400",[307,702,703],{},"Invalid body, or not enough inputs to search.",[289,705,706,711],{},[307,707,708],{},[174,709,710],{},"401",[307,712,713],{},"Missing, malformed, invalid, or unauthorized API key.",[289,715,716,721],{},[307,717,718],{},[174,719,720],{},"403",[307,722,723],{},"Address Finder is not enabled for your team.",[289,725,726,731],{},[307,727,728],{},[174,729,730],{},"429",[307,732,733],{},"Your team has used all its lookups.",[289,735,736,741],{},[307,737,738],{},[174,739,740],{},"502",[307,742,743],{},"Address Finder is temporarily unavailable. Retry later.",[745,746,747],"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":172,"searchDepth":225,"depth":225,"links":749},[750,751,752,753,754,755],{"id":211,"depth":225,"text":212},{"id":231,"depth":225,"text":232},{"id":468,"depth":225,"text":469},{"id":572,"depth":225,"text":573},{"id":643,"depth":225,"text":644},{"id":669,"depth":225,"text":670},"Start an Address Finder lookup for a person's business mailing address.","md",null,{},true,{"title":142,"description":756},"wc-droY-UAsBqbyZjtACDaaOLoG-spA1fGSE-pC00ps",[764,766],{"title":133,"path":134,"stem":135,"description":765,"children":-1},"Send test events, inspect delivery history, and resend webhook deliveries.",{"title":146,"path":147,"stem":148,"description":767,"children":-1},"Get the status and result of an Address Finder lookup.",1794418776001]