{
"error": "A domain billing contact is required before purchasing. Provide the billingContact field, then retry."
}
{
"error": "Unauthorized"
}
{
"error": "You do not have permission to perform this action"
}
{
"error": "This domain was already purchased or is not available anymore."
}
{
"error": "Internal error"
}
This call bills the team: the domain goes on its own yearly subscription, charged to the team’s payment method. Nothing can be canceled through the API; use the lemlist app or contact support.
The registrar needs a registrant contact. On the team’s first purchase, send billingContact: it is checked (address, then the registrar itself for google and m365), stored on the team and reused for every later purchase. Send it again only to change it.A .fr or .be domain with google or m365 also needs billingContact.companyIdentificationCode (SIREN/SIRET). Some extensions only accept a registrant from given countries (a .fr needs an address in the EU/EEA).
The domain is billed, then registered and set up in the background. Follow its status with List Domains.
Order its mailboxes with Order Mailboxes. You can call it right away: the mailboxes wait for the domain, and are only billed once it is set up.
A domain can be bought without mailboxes. Don’t leave a google domain without mailboxes for long: Google may delete a Workspace that holds no license, and adding mailboxes then requires support.
Calling again for a domain the team already ordered bills nothing and returns that order with alreadyOwned: true. A retry after a timeout is safe.If the team has no valid payment method, or the payment fails, the order is canceled after about a day. That domain name can then no longer be ordered through lemlist: contact support.
Set isTransfer: true with the authCode from your current registrar and provider: "google", the only provider that supports transfers. dnsRecords lists the records to recreate on the zone once the transfer completes. A transfer can take several days. If the registrar refuses the code, fix it in the lemlist app.
Requires the Manage domains permission on the user of the API key.
Mailbox provider of the domain, permanent: google (Google Workspace), m365 (Microsoft 365) or infraforge (SMTP). Pick one listed in the Search Domains providers. A transfer requires google.
Registrant contact of the team, sent to the registrar. Stored on the team and reused for every later purchase; sending it again overwrites the stored one.
Show child attributes
Response
Domain ordered, or already ordered by the team (alreadyOwned: true, nothing billed)
True when the team already had a live order for this domain: the call billed nothing and returns that order.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"lemlist Developer Docs","description":"lemlist API documentation to help you integrate and automate your email outreach.","colors":{"primary":"#316bff","light":"#316bff","dark":"#316bff"},"logo":{"light":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c","dark":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/dark.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=e35c628bd52e1f84bda9094bf3daffab"},"favicon":{"light":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d","dark":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d"},"api":{"params":{"expanded":"closed"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","python","javascript","ruby","php"],"prefill":true},"mdx":{"auth":{"method":"basic","name":"Basic"}}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://lemlist.typeform.com/to/mfVlkyGf","label":"Send your feedback"}],"primary":{"type":"button","label":"Open App","href":"https://app.lemlist.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/lemlist","youtube":"https://www.youtube.com/c/lemlist"}},"search":{"prompt":"Search..."},"seo":{"metatags":{"robots":"index","charset":"UTF-8","viewport":"width=device-width, initial-scale=1.0","description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","keywords":"outbound, outreach, sales, automation","googlebot":"index, follow","google-site-verification":"verification_token","generator":"Mintlify","theme-color":"#000000","color-scheme":"light dark","format-detection":"telephone=no","referrer":"origin","refresh":"30","rating":"general","revisit-after":"7 days","language":"en","og:title":"Lemlist Developer Docs","og:type":"website","og:url":"https://developer.lemlist.com","og:image":"https://developer.lemlist.com/thumbnails/dark.jpeg","og:description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","og:site_name":"lemlist Developer Docs","og:locale":"en_US"},"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":700},"body":{"family":"Inter","weight":500}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","codeblocks":{"theme":"dracula"},"latex":false},"integrations":{"ga4":{"measurementId":"G-XRXQRF7W03"},"gtm":{"tagId":"GTM-PRZ945S"}},"errors":{"404":{"redirect":false,"title":"someone took the wrong turn 🌝","description":""}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/lemlist/A9DixBwcDG7hidJ9/thumbnails/dark.jpeg?fit=max\u0026auto=format\u0026n=A9DixBwcDG7hidJ9\u0026q=85\u0026s=28c3824c256d42c704eb5a45b60ad8e5"},"interaction":{"drilldown":true},"navigation":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lemlist","hasAudioNarration":false,"actualSubdomain":"lemlist","customDomains":["developer.lemlist.com"],"gitSource":{"type":"github","owner":"l3mpire","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3097cd9e177e93f8c3c7d","collectionId":"354798cf-c3fd-4a58-b6e8-7ff059a4580d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3097cd9e177e93f8c3c7d"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae456a7f49f5b7aedfd1ca8","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":274},{"language":"default","tag":"Endpoints","count":226},{"language":"default","tag":"Objects \u0026 Definitions","count":44},{"language":"default","tag":"Leads","count":22},{"language":"default","tag":"Campaigns","count":21},{"language":"default","tag":"Contacts","count":17},{"language":"default","tag":"Sequences","count":17},{"language":"default","tag":"Inbox","count":16},{"language":"default","tag":"Unsubscribes","count":15},{"language":"default","tag":"People database","count":14}]},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6920211ae3c0df65ab8a60e2","deploymentId":"68e934a81f764bc8b225533c","questionText":"How do I automatically add leads to campaign with auto launch?","status":"active","generatedBy":"manual","createdAt":"2025-11-21T08:21:46.035Z","updatedAt":"2025-11-21T08:22:06.570Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/domains/purchase-domain","slug":"/api-reference/endpoints/domains/purchase-domain","pageMetadata":{"openapi":"post /domains-core/purchase","description":"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.","title":"Purchase Domain","href":"/api-reference/endpoints/domains/purchase-domain"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const SnippetObjectReference=({objectName,objectPath=null})=>{const _components={a:`a`,..._provideComponents()},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);const lowerCaseObjectName=objectName.toLowerCase();if(lowerCaseObjectName===`lead`||lowerCaseObjectName===`leads`){return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`. Make sure to also check the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${lowerCaseObjectName===`lead`?`contact`:`lead`}`,children:[lowerCaseObjectName===`lead`?`Contact`:`Lead`,` object`]}),` to understand the distinction between the two.`]})}return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`.`]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Note,Warning,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`SnippetObjectReference`,children:_jsx(SnippetObjectReference,{objectName:`Domain`,objectPath:`domain`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`This call bills the team: the domain goes on its own yearly subscription, charged to the team’s payment method. Nothing can be canceled through the API; use the lemlist app or contact support.`})}),`\n`,_jsx(Heading,{level:`2`,id:`before-the-first-purchase`,children:`Before the first purchase`}),`\n`,_jsxs(_components.p,{children:[`The registrar needs a registrant contact. On the team’s first purchase, send `,_jsx(_components.code,{children:`billingContact`}),`: it is checked (address, then the registrar itself for `,_jsx(_components.code,{children:`google`}),` and `,_jsx(_components.code,{children:`m365`}),`), stored on the team and reused for every later purchase. Send it again only to change it.`]}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`.fr`}),` or `,_jsx(_components.code,{children:`.be`}),` domain with `,_jsx(_components.code,{children:`google`}),` or `,_jsx(_components.code,{children:`m365`}),` also needs `,_jsx(_components.code,{children:`billingContact.companyIdentificationCode`}),` (SIREN/SIRET). Some extensions only accept a registrant from given countries (a `,_jsx(_components.code,{children:`.fr`}),` needs an address in the EU/EEA).`]}),`\n`,_jsx(Heading,{level:`2`,id:`after-the-call`,children:`After the call`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`The domain is billed, then registered and set up in the background. Follow its `,_jsx(_components.code,{children:`status`}),` with `,_jsx(_components.a,{href:`/api-reference/endpoints/domains/list-domains`,children:`List Domains`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Order its mailboxes with `,_jsx(_components.a,{href:`/api-reference/endpoints/domains/order-mailboxes`,children:`Order Mailboxes`}),`. You can call it right away: the mailboxes wait for the domain, and are only billed once it is set up.`]}),`\n`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A domain can be bought without mailboxes. Don’t leave a `,_jsx(_components.code,{children:`google`}),` domain without mailboxes for long: Google may delete a Workspace that holds no license, and adding mailboxes then requires support.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`retrying`,children:`Retrying`}),`\n`,_jsxs(_components.p,{children:[`Calling again for a domain the team already ordered bills nothing and returns that order with `,_jsx(_components.code,{children:`alreadyOwned: true`}),`. A retry after a timeout is safe.`]}),`\n`,_jsx(_components.p,{children:`If the team has no valid payment method, or the payment fails, the order is canceled after about a day. That domain name can then no longer be ordered through lemlist: contact support.`}),`\n`,_jsx(Heading,{level:`2`,id:`transfers`,children:`Transfers`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`isTransfer: true`}),` with the `,_jsx(_components.code,{children:`authCode`}),` from your current registrar and `,_jsx(_components.code,{children:`provider: \"google\"`}),`, the only provider that supports transfers. `,_jsx(_components.code,{children:`dnsRecords`}),` lists the records to recreate on the zone once the transfer completes. A transfer can take several days. If the registrar refuses the code, fix it in the lemlist app.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Requires the `,_jsx(_components.strong,{children:`Manage domains`}),` permission on the user of the API key.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{SnippetObjectReference,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"dracula"},"config":{},"pageMetadata":{"openapi":"post /domains-core/purchase","description":"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.","title":"Purchase Domain","href":"/api-reference/endpoints/domains/purchase-domain"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[158,1036,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Before the first purchase","slug":"before-the-first-purchase","depth":2,"children":[]},{"title":"After the call","slug":"after-the-call","depth":2,"children":[]},{"title":"Retrying","slug":"retrying","depth":2,"children":[]},{"title":"Transfers","slug":"transfers","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lemlist/a773d8a119273e17/scripts/playground-captions.js","/_mintlify/custom/lemlist/7d1b4a0d04d1528d/scripts/copy-page-url.js"],"openApiReferenceData":{"operation":{"summary":"Purchase Domain","description":"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.","operationId":"purchaseDomain","tags":["Domains"],"requestBody":"c715cdf5-3705-4124-91f1-350e81182d8d","responses":{"200":"3fcbbbdb-5e36-4ae6-9bee-602f8a79fe64","400":"8f6665da-05d1-4afa-a57c-deefaeb694ac","401":"243f6fa0-ba78-4bd5-918a-82fc55227170","403":"d0b9aab8-bc2b-445e-a6cc-710924615a64","409":"cce180c2-b2f3-405b-9e5c-c94e6ba950dc","500":"97f378fc-e760-4305-bb89-8fb7ccf0488a"},"method":"post","type":"path","servers":["547aba0a-4af4-46c2-8a3e-6b9c0c1a997d"],"security":["663fe906-b0b4-4794-b10b-208b55b64a2a"],"path":"/domains-core/purchase","baseUrlOptions":["https://api.lemlist.com/api"],"title":"Purchase Domain","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","ruby","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.domain":"getacme.com","body.provider":"infraforge","body.isTransfer":false,"body.authCode":"\u003cstring>","body.dnsRecords.items.0.hostName":"www","body.dnsRecords.items.0.value":"example.com","body.dnsRecords.items.0.ttl":3600,"body.dnsRecords.items.0.priority":123}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain to buy or transfer","example":"getacme.com","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"provider":{"type":"string","enum":["google","m365","infraforge"],"default":"infraforge","description":"Mailbox provider of the domain, permanent: `google` (Google Workspace), `m365` (Microsoft 365) or `infraforge` (SMTP). Pick one listed in the Search Domains `providers`. A transfer requires `google`.","uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"isTransfer":{"type":"boolean","default":false,"description":"Transfer a domain registered elsewhere instead of registering a new one","uniqueKey":"isTransfer","typeLabel":"boolean"},"authCode":{"type":"string","description":"Transfer authorization code from the current registrar. Required when `isTransfer` is `true`.","uniqueKey":"authCode","typeLabel":"string"},"dnsRecords":{"type":"array","description":"Transfer only: records to recreate on the zone once the transfer completes. Ignored for a registration.","items":{"type":"object","properties":{"hostName":{"type":"string","example":"www","isRequired":true,"uniqueKey":"dnsRecords.items.[INDEX].hostName","typeLabel":"string"},"type":{"type":"string","enum":["TXT","CNAME","A","AAAA","NS","MX","SRV"],"isRequired":true,"uniqueKey":"dnsRecords.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","example":"example.com","isRequired":true,"uniqueKey":"dnsRecords.items.[INDEX].value","typeLabel":"string"},"ttl":{"type":"integer","example":3600,"uniqueKey":"dnsRecords.items.[INDEX].ttl","typeLabel":"integer"},"priority":{"type":"integer","uniqueKey":"dnsRecords.items.[INDEX].priority","typeLabel":"integer"}},"required":["hostName","type","value"],"uniqueKey":"dnsRecords.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dnsRecords","typeLabel":"object[]"},"billingContact":{"type":"object","description":"Registrant contact of the team, sent to the registrar. Stored on the team and reused for every later purchase; sending it again overwrites the stored one.","additionalProperties":false,"properties":{"firstName":{"type":"string","example":"John","isRequired":true,"uniqueKey":"billingContact.firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","isRequired":true,"uniqueKey":"billingContact.lastName","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Must not be an address on the domain being bought.","example":"john@example.com","isRequired":true,"uniqueKey":"billingContact.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","description":"International format. The phone country must match a real number.","example":"+15555550123","isRequired":true,"uniqueKey":"billingContact.phone","typeLabel":"string"},"name":{"type":"string","description":"Organization name","example":"Acme Inc","isRequired":true,"uniqueKey":"billingContact.name","typeLabel":"string"},"line1":{"type":"string","description":"Street address","example":"1 Main Street","isRequired":true,"uniqueKey":"billingContact.line1","typeLabel":"string"},"city":{"type":"string","example":"Springfield","isRequired":true,"uniqueKey":"billingContact.city","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the address","example":"US","isRequired":true,"uniqueKey":"billingContact.countryCode","typeLabel":"string"},"postalCode":{"type":"string","description":"Required for most countries","example":"12345","uniqueKey":"billingContact.postalCode","typeLabel":"string"},"state":{"type":"string","description":"Required for US, CA, CH, IN, IT and AU: its name or ISO 3166-2 code (`CA`, `US-CA`).","example":"CA","uniqueKey":"billingContact.state","typeLabel":"string"},"companyIdentificationCode":{"type":"string","description":"SIREN/SIRET. Required to register a `.fr` or `.be` domain with `google` or `m365`.","uniqueKey":"billingContact.companyIdentificationCode","typeLabel":"string"},"vatIdentificationCode":{"type":"string","description":"VAT number, used for `.fr` and `.be` domains","uniqueKey":"billingContact.vatIdentificationCode","typeLabel":"string"}},"required":["firstName","lastName","email","phone","name","line1","city","countryCode"],"uniqueKey":"billingContact","typeLabel":"object"}},"required":["domain"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"domain":"getacme.com","provider":"infraforge","isTransfer":false,"authCode":"\u003cstring>","dnsRecords":[{"hostName":"www","value":"example.com","ttl":3600,"priority":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3fcbbbdb-5e36-4ae6-9bee-602f8a79fe64":{"description":"Domain ordered, or already ordered by the team (`alreadyOwned: true`, nothing billed)","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"object","description":"A domain the team bought or is transferring through lemlist.","properties":{"_id":{"type":"string","description":"Unique domain identifier","example":"dom_Kd8Wq2Lr5Tx9Mz3Pv","isRequired":true,"uniqueKey":"domain._id","typeLabel":"string"},"domain":{"type":"string","description":"Domain name, lowercase","example":"getacme.com","isRequired":true,"uniqueKey":"domain.domain","typeLabel":"string"},"registrar":{"type":"string","enum":["google","m365","infraforge"],"description":"Mailbox provider chosen at purchase. It is permanent: a `google` domain only gets Google Workspace mailboxes, `m365` only Microsoft 365, `infraforge` only SMTP.","isRequired":true,"uniqueKey":"domain.registrar","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["ordered","paid","registered","pending","automating","active"],"description":"Setup progress. `ordered`: waiting for payment. `paid`: being registered or transferred. `registered`: DNS being set up. `pending`: DNS checks and mailboxes in progress. `automating`: Google Workspace post-setup (DKIM, mailbox connection) running. `active`: ready.","isRequired":true,"uniqueKey":"domain.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Order date","isRequired":true,"uniqueKey":"domain.createdAt","typeLabel":"string\u003cdate-time>"},"emailCount":{"type":"integer","description":"Number of mailboxes ordered on the domain","example":0,"isRequired":true,"uniqueKey":"domain.emailCount","typeLabel":"integer"}},"required":["_id","domain","registrar","status","createdAt","emailCount"],"isRequired":true,"uniqueKey":"domain","typeLabel":"object"},"alreadyOwned":{"type":"boolean","description":"True when the team already had a live order for this domain: the call billed nothing and returns that order.","isRequired":true,"uniqueKey":"alreadyOwned","typeLabel":"boolean"}},"required":["domain","alreadyOwned"],"uniqueKey":"","typeLabel":"object"},"example":{"domain":{"_id":"dom_Kd8Wq2Lr5Tx9Mz3Pv","domain":"getacme.com","registrar":"google","status":"ordered","createdAt":"2026-01-15T10:30:00.000Z","emailCount":0},"alreadyOwned":false},"examples":{"Example":{"title":"Example","value":{"domain":{"_id":"dom_Kd8Wq2Lr5Tx9Mz3Pv","domain":"getacme.com","registrar":"google","status":"ordered","createdAt":"2026-01-15T10:30:00.000Z","emailCount":0},"alreadyOwned":false}}},"exampleType":"examples"}},"exampleType":"examples"},"8f6665da-05d1-4afa-a57c-deefaeb694ac":{"description":"Invalid request or contact: malformed field, missing or incomplete billing contact, address the registrar cannot verify, contact refused by the registrar, missing SIREN/SIRET for a `.fr`/`.be` domain, registrant country not accepted by the extension, Google Workspace unavailable in the contact country, transfer without `authCode` or with another provider than `google`, or the API key has no user","content":{"application/json":{"schema":{"type":"object","description":"Error answered as a plain message by the contact and company endpoints.","properties":{"error":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"A domain billing contact is required before purchasing. Provide the billingContact field, then retry."},"examples":{"Example":{"title":"Example","value":{"error":"A domain billing contact is required before purchasing. Provide the billingContact field, then retry."}}},"exampleType":"examples"}},"exampleType":"examples"},"243f6fa0-ba78-4bd5-918a-82fc55227170":{"description":"Unauthorized - invalid or missing API key","content":{"application/json":{"schema":{"type":"object","description":"Error answered as a plain message by the contact and company endpoints.","properties":{"error":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"d0b9aab8-bc2b-445e-a6cc-710924615a64":{"description":"The API key user lacks the Manage domains permission, or the team cannot buy domains","content":{"application/json":{"schema":{"type":"object","description":"Error answered as a plain message by the contact and company endpoints.","properties":{"error":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"You do not have permission to perform this action"},"examples":{"Example":{"title":"Example","value":{"error":"You do not have permission to perform this action"}}},"exampleType":"examples"}},"exampleType":"examples"},"cce180c2-b2f3-405b-9e5c-c94e6ba950dc":{"description":"The domain cannot be ordered: taken, already ordered through lemlist (including a past order that failed), its extension cannot be transferred, no transfer price, or it already has a Google Workspace","content":{"application/json":{"schema":{"type":"object","description":"Error answered as a plain message by the contact and company endpoints.","properties":{"error":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"This domain was already purchased or is not available anymore."},"examples":{"Example":{"title":"Example","value":{"error":"This domain was already purchased or is not available anymore."}}},"exampleType":"examples"}},"exampleType":"examples"},"97f378fc-e760-4305-bb89-8fb7ccf0488a":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Error answered as a plain message by the contact and company endpoints.","properties":{"error":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Internal error"},"examples":{"Example":{"title":"Example","value":{"error":"Internal error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"663fe906-b0b4-4794-b10b-208b55b64a2a":{"basicAuth":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"}}},"servers":{"547aba0a-4af4-46c2-8a3e-6b9c0c1a997d":{"url":"https://api.lemlist.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"api-reference/openapi/v2.json"},"subdomain":"lemlist","siteName":"lemlist Developer Docs","title":"Lemlist Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T08:34:59.739Z","originalFileLocation":"api-reference/endpoints/domains/purchase-domain.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.\">\u003cmeta data-mint-head name=\"keywords\" content=\"outbound, outreach, sales, automation\">\u003cmeta data-mint-head name=\"application-name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#316bff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"verification_token\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#000000\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin\">\u003cmeta data-mint-head name=\"refresh\" content=\"30\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"revisit-after\" content=\"7 days\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/domains/purchase-domain.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.lemlist.com/#organization\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.lemlist.com#website\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain#webpage\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain\",\"name\":\"Purchase Domain\",\"description\":\"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.\",\"dateModified\":\"2026-10-30T08:34:59.739Z\",\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/team/get-team\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Domains\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/domains/search-domains\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Purchase Domain\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain#apireference\",\"headline\":\"Purchase Domain\",\"name\":\"Purchase Domain\",\"description\":\"Orders a domain, or a transfer of a domain you own elsewhere, and bills the team.\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain\",\"mainEntityOfPage\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain#webpage\"},\"image\":\"https://developer.lemlist.com/thumbnails/dark.jpeg\",\"dateModified\":\"2026-10-30T08:34:59.739Z\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"lemlist Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"lemlist Developer Docs","nav":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/getting-started/overview"},{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Managing multiple accounts","href":"/api-reference/getting-started/multiple-accounts"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Popular Resources","pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /database/people","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"get /leads/{email}","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"}]},{"group":"Endpoints","pages":[{"group":"Team","expanded":false,"pages":[{"openapi":"get /team","title":"Get Team","href":"/api-reference/endpoints/team/get-team"},{"openapi":"get /team/senders","title":"Get Team Senders","href":"/api-reference/endpoints/team/get-team-senders"},{"openapi":"get /team/credits","title":"Get Team Credits","href":"/api-reference/endpoints/team/get-team-credits"}]},{"group":"Users","expanded":false,"pages":[{"openapi":"get /users/{userId}","title":"Get User","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /user/channels","title":"Get User Channels","href":"/api-reference/endpoints/users/get-user-channels"},{"openapi":"patch /users/{userId}/linkedin-limits","title":"Update User LinkedIn Limits","href":"/api-reference/endpoints/users/update-user-linkedin-limits"}]},{"group":"Email Accounts","expanded":false,"pages":[{"openapi":"post /user/email-accounts","title":"Connect Email Account","href":"/api-reference/endpoints/email-accounts/connect-email-account"},{"openapi":"delete /user/email-accounts/{emailAccountId}","title":"Disconnect Email Account","href":"/api-reference/endpoints/email-accounts/disconnect-email-account"},{"openapi":"post /user/email-accounts/{emailAccountId}/test","title":"Test Email Account","href":"/api-reference/endpoints/email-accounts/test-email-account"}]},{"group":"Campaigns","expanded":false,"pages":[{"openapi":"post /campaigns","title":"Create Campaign","href":"/api-reference/endpoints/campaigns/create-campaign"},{"openapi":"get /campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/endpoints/campaigns/get-campaign"},{"openapi":"get /campaigns","title":"Get Many Campaigns","href":"/api-reference/endpoints/campaigns/get-many-campaigns"},{"openapi":"patch /campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/endpoints/campaigns/update-campaign"},{"openapi":"get /campaigns/{campaignId}/statutes","title":"Get Campaign Statutes","href":"/api-reference/endpoints/campaigns/get-campaign-statutes"},{"openapi":"post /campaigns/{campaignId}/start","title":"Start Campaign","href":"/api-reference/endpoints/campaigns/start-campaign"},{"openapi":"post /campaigns/{campaignId}/pause","title":"Pause Campaign","href":"/api-reference/endpoints/campaigns/pause-campaign"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip","title":"Skip Step for Everyone","href":"/api-reference/endpoints/campaigns/skip-step-for-everyone"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip-for-leads","title":"Skip Step for Leads","href":"/api-reference/endpoints/campaigns/skip-step-for-leads"},{"openapi":"post /campaigns/{campaignId}/abm-leads","title":"Add ABM Campaign Leads","href":"/api-reference/endpoints/campaigns/add-abm-campaign-leads"},{"openapi":"post /campaigns/{campaignId}/triggers/watch-lists","title":"Add Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/add-watch-list-trigger"},{"openapi":"delete /campaigns/{campaignId}/triggers/watch-lists/{watchListId}","title":"Remove Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/remove-watch-list-trigger"},{"openapi":"post /campaigns/{campaignId}/duplicate","title":"Duplicate Campaign","href":"/api-reference/endpoints/campaigns/duplicate-campaign"},{"openapi":"get /v2/campaigns/{campaignId}/stats","title":"Get Campaign Stats","href":"/api-reference/endpoints/campaigns/get-campaign-stats"},{"openapi":"post /v2/campaigns/stats/batch","title":"Get Batch Campaign Stats","href":"/api-reference/endpoints/campaigns/get-batch-campaign-stats"},{"openapi":"get /campaigns/{campaignId}/export/start","title":"Start Campaign Stats Export","href":"/api-reference/endpoints/campaigns/start-campaign-export"},{"openapi":"get /campaigns/{campaignId}/export/{exportId}/status","title":"Get Campaign Export Status","href":"/api-reference/endpoints/campaigns/get-campaign-export-status"},{"openapi":"put /campaigns/{campaignId}/export/{exportId}/email/{email}","title":"Set Email for Campaign Export Notification","href":"/api-reference/endpoints/campaigns/set-export-email-notification"},{"openapi":"get /v2/campaigns/{campaignId}/export/leads","title":"Export Campaign Leads","href":"/api-reference/endpoints/campaigns/export-campaign-leads-v2"},{"openapi":"get /campaigns/{campaignId}/export/leads","title":"Export Campaign Leads (legacy)","href":"/api-reference/endpoints/campaigns/export-campaign-leads"},{"openapi":"get /campaigns/reports","title":"Get Campaign Reports","href":"/api-reference/endpoints/campaigns/get-campaign-reports"}]},{"group":"Senders","expanded":false,"pages":[{"openapi":"get /senders","title":"List Senders","href":"/api-reference/endpoints/senders/list-senders"},{"openapi":"get /campaigns/{campaignId}/senders","title":"Get Campaign Senders","href":"/api-reference/endpoints/senders/get-campaign-senders"},{"openapi":"post /campaigns/{campaignId}/senders","title":"Add Campaign Senders","href":"/api-reference/endpoints/senders/add-campaign-senders"},{"openapi":"put /campaigns/{campaignId}/senders","title":"Replace Campaign Senders","href":"/api-reference/endpoints/senders/replace-campaign-senders"},{"openapi":"patch /campaigns/{campaignId}/senders/{userId}","title":"Update Campaign Sender Channels","href":"/api-reference/endpoints/senders/update-campaign-sender-channels"},{"openapi":"delete /campaigns/{campaignId}/senders/{userId}","title":"Remove Campaign Sender","href":"/api-reference/endpoints/senders/remove-campaign-sender"}]},{"group":"Sequences","expanded":false,"pages":[{"openapi":"get /campaigns/{campaignId}/sequences","title":"Get Campaign Sequences","href":"/api-reference/endpoints/sequences/get-campaign-sequences"},{"openapi":"post /sequences/{sequenceId}/steps","title":"Add Step to Sequence","href":"/api-reference/endpoints/sequences/add-step-to-sequence"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}","title":"Update Sequence Step","href":"/api-reference/endpoints/sequences/update-sequence-step"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}","title":"Delete Sequence Step","href":"/api-reference/endpoints/sequences/delete-sequence-step"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/sender","title":"Get Step Sender","href":"/api-reference/endpoints/sequences/get-step-sender"},{"openapi":"put /sequences/{sequenceId}/steps/{stepId}/sender","title":"Set Step Sender","href":"/api-reference/endpoints/sequences/set-step-sender"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/sender","title":"Remove Step Sender","href":"/api-reference/endpoints/sequences/remove-step-sender"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/branches","title":"List Condition Branches","href":"/api-reference/endpoints/sequences/list-condition-branches"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/branches","title":"Add Condition Branch","href":"/api-reference/endpoints/sequences/add-condition-branch"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches","title":"Reorder Condition Branches","href":"/api-reference/endpoints/sequences/reorder-condition-branches"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Update Condition Branch","href":"/api-reference/endpoints/sequences/update-condition-branch"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Delete Condition Branch","href":"/api-reference/endpoints/sequences/delete-condition-branch"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Create A/B Test Variant","href":"/api-reference/endpoints/sequences/create-ab-test-variant"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Get A/B Test Variant","href":"/api-reference/endpoints/sequences/get-ab-test-variant"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Update A/B Test Variant","href":"/api-reference/endpoints/sequences/update-ab-test-variant"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Delete A/B Test Variant","href":"/api-reference/endpoints/sequences/delete-ab-test-variant"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test/winner","title":"Select A/B Test Winner","href":"/api-reference/endpoints/sequences/select-ab-test-winner"}]},{"group":"Message templates","expanded":false,"pages":[{"openapi":"get /message-templates","title":"List Message Templates","href":"/api-reference/endpoints/message-templates/list-message-templates"},{"openapi":"get /message-templates/tags","title":"List Message Template Tags","href":"/api-reference/endpoints/message-templates/list-message-template-tags"},{"openapi":"get /message-templates/{templateId}","title":"Get Message Template","href":"/api-reference/endpoints/message-templates/get-message-template"}]},{"group":"Snippets","expanded":false,"pages":[{"openapi":"get /snippets","title":"List Snippets","href":"/api-reference/endpoints/snippets/list-snippets"},{"openapi":"get /snippets/{snippetId}","title":"Get Snippet","href":"/api-reference/endpoints/snippets/get-snippet"}]},{"group":"Schedules","expanded":false,"pages":[{"openapi":"post /schedules","title":"Create Schedule","href":"/api-reference/endpoints/schedules/create-schedule"},{"openapi":"get /schedules/{scheduleId}","title":"Get Schedule","href":"/api-reference/endpoints/schedules/get-schedule"},{"openapi":"get /schedules","title":"Get Many Schedules","href":"/api-reference/endpoints/schedules/get-many-schedules"},{"openapi":"patch /schedules/{scheduleId}","title":"Update Schedule","href":"/api-reference/endpoints/schedules/update-schedule"},{"openapi":"delete /schedules/{scheduleId}","title":"Delete Schedule","href":"/api-reference/endpoints/schedules/delete-schedule"},{"openapi":"get /campaigns/{campaignId}/schedules/","title":"Get Campaign Schedules","href":"/api-reference/endpoints/schedules/get-campaign-schedules"},{"openapi":"post /campaigns/{campaignId}/schedules/{scheduleId}","title":"Associate Schedule with Campaign","href":"/api-reference/endpoints/schedules/associate-schedule-with-campaign"}]},{"group":"Leads","expanded":false,"pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"openapi":"get /campaigns/{campaignId}/leads/","title":"Get Campaign Leads","href":"/api-reference/endpoints/leads/get-campaign-leads"},{"openapi":"get /leads","title":"Get Lead by Email or ID","href":"/api-reference/endpoints/leads/get-lead-by-email-or-id"},{"openapi":"get /leads/{email}","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"},{"openapi":"patch /campaigns/{campaignId}/leads/{leadId}","title":"Update Lead in a Campaign","href":"/api-reference/endpoints/leads/update-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadId}","title":"Delete or Unsubscribe Lead","href":"/api-reference/endpoints/leads/delete-lead"},{"openapi":"post /leads/{leadId}/variables","title":"Add Custom Variables on Leads","href":"/api-reference/endpoints/leads/add-lead-variables"},{"openapi":"patch /leads/{leadId}/variables","title":"Update Values of Custom Variables of a Lead","href":"/api-reference/endpoints/leads/update-lead-variables"},{"openapi":"delete /leads/{leadId}/variables","title":"Erase Values of Custom Variables on a Lead","href":"/api-reference/endpoints/leads/delete-lead-variables"},{"openapi":"delete /campaigns/{campaignId}/leads/{email}","title":"Unsubscribe Lead from Campaign","href":"/api-reference/endpoints/leads/unsubscribe-lead-from-campaign"},{"openapi":"post /leads/pause/{leadId}","title":"Pause Lead","href":"/api-reference/endpoints/leads/pause-lead"},{"openapi":"post /leads/start/{leadId}","title":"Resume Paused Lead","href":"/api-reference/endpoints/leads/resume-paused-lead"},{"openapi":"post /leads/review/{leadId}","title":"Launch Lead","href":"/api-reference/endpoints/leads/launch-lead"},{"openapi":"post /leads/interested/{leadIdOrEmail}","title":"Mark Lead as Interested","href":"/api-reference/endpoints/leads/mark-lead-as-interested"},{"openapi":"post /leads/notinterested/{leadIdOrEmail}","title":"Mark Lead as Not Interested","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/interested","title":"Mark Lead as Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/notinterested","title":"Mark Lead as Not Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/skip","title":"Skip Step for Lead","href":"/api-reference/endpoints/leads/skip-step-for-lead"},{"openapi":"put /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Personalize Step for Lead","href":"/api-reference/endpoints/leads/personalize-step-for-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Reset Step Personalization for Lead","href":"/api-reference/endpoints/leads/reset-step-personalization-for-lead"},{"openapi":"post /campaigns/{campaignId}/leads/import","title":"Import Leads from CRM","href":"/api-reference/endpoints/leads/import-leads-from-crm"},{"openapi":"post /leads/audio","title":"Upload Audio for Voice Message Step","href":"/api-reference/endpoints/leads/upload-audio-for-voice-message-step"}]},{"group":"Companies","expanded":false,"pages":[{"openapi":"post /companies","title":"Add and update company","href":"/api-reference/endpoints/companies/upsert-company"},{"openapi":"get /companies/{companyId}","title":"Get Company","href":"/api-reference/endpoints/companies/get-company"},{"openapi":"get /companies","title":"Get Many Companies","href":"/api-reference/endpoints/companies/get-many-companies"},{"openapi":"delete /companies/{companyId}","title":"Delete Company","href":"/api-reference/endpoints/companies/delete-company"},{"openapi":"post /companies/merge","title":"Merge Companies","href":"/api-reference/endpoints/companies/merge-companies"},{"openapi":"post /companies/crm/search-and-connect","title":"Search \u0026 Connect Companies in the CRM","href":"/api-reference/endpoints/companies/search-and-connect-companies"},{"openapi":"post /companies/crm/create","title":"Create Companies in the CRM","href":"/api-reference/endpoints/companies/create-companies-in-crm"},{"openapi":"get /companies/lists","title":"Get Company Lists","href":"/api-reference/endpoints/companies/get-company-lists"},{"openapi":"post /companies/lists","title":"Create Company List","href":"/api-reference/endpoints/companies/create-company-list"},{"openapi":"post /companies/lists/{listId}/entities","title":"Add or Remove Companies in a List","href":"/api-reference/endpoints/companies/manage-company-list-entities"},{"openapi":"post /companies/{companyId}/notes","title":"Create Company Note","href":"/api-reference/endpoints/companies/create-company-note"},{"openapi":"get /companies/{companyId}/notes","title":"Get Company Notes","href":"/api-reference/endpoints/companies/get-company-notes"}]},{"group":"Contacts","expanded":false,"pages":[{"openapi":"post /contacts","title":"Add and update contact","href":"/api-reference/endpoints/contacts/upsert-contact"},{"openapi":"get /contacts/{idOrEmail}","title":"Get Contact","href":"/api-reference/endpoints/contacts/get-contact"},{"openapi":"get /contacts","title":"Get Many Contacts","href":"/api-reference/endpoints/contacts/get-many-contacts"},{"openapi":"delete /contacts/{idOrEmail}","title":"Delete Contact","href":"/api-reference/endpoints/contacts/delete-contact"},{"openapi":"post /contacts/merge","title":"Merge Contacts","href":"/api-reference/endpoints/contacts/merge-contacts"},{"openapi":"post /contacts/crm/search-and-connect","title":"Search \u0026 Connect Contacts in the CRM","href":"/api-reference/endpoints/contacts/search-and-connect-contacts"},{"openapi":"post /contacts/crm/create","title":"Create Contacts in the CRM","href":"/api-reference/endpoints/contacts/create-contacts-in-crm"},{"openapi":"get /contacts/lists","title":"Get Contact Lists","href":"/api-reference/endpoints/contacts/get-contact-lists"},{"openapi":"post /contacts/lists","title":"Create Contact List","href":"/api-reference/endpoints/contacts/create-contact-list"},{"openapi":"post /contacts/lists/{listId}/entities","title":"Add or Remove Contacts in a List","href":"/api-reference/endpoints/contacts/manage-contact-list-entities"},{"openapi":"get /contacts/export","title":"Export Contact List","href":"/api-reference/endpoints/contacts/export-contact-list"},{"openapi":"post /contacts/{idOrEmail}/notes","title":"Create Contact Note","href":"/api-reference/endpoints/contacts/create-contact-note"},{"openapi":"get /contacts/{idOrEmail}/notes","title":"Get Contact Notes","href":"/api-reference/endpoints/contacts/get-contact-notes"}]},{"group":"Inbox","expanded":false,"pages":[{"openapi":"get /inbox","title":"Get Many Inboxes","href":"/api-reference/endpoints/inbox/get-many-inboxes"},{"openapi":"get /inbox/{contactId}","title":"Get Contact Messages","href":"/api-reference/endpoints/inbox/get-contact-messages"},{"openapi":"post /inbox/email","title":"Send Email","href":"/api-reference/endpoints/inbox/send-email"},{"openapi":"post /inbox/linkedin","title":"Send LinkedIn Message","href":"/api-reference/endpoints/inbox/send-linkedin-message"},{"openapi":"post /inbox/whatsapp","title":"Send WhatsApp Message","href":"/api-reference/endpoints/inbox/send-whatsapp-message"},{"openapi":"post /inbox/sms","title":"Send SMS Message","href":"/api-reference/endpoints/inbox/send-sms-message"},{"openapi":"get /inbox/labels","title":"Get Many Labels","href":"/api-reference/endpoints/inbox/get-many-labels"},{"openapi":"get /inbox/labels/{labelId}","title":"Get Label","href":"/api-reference/endpoints/inbox/get-label"},{"openapi":"post /inbox/labels","title":"Create Label","href":"/api-reference/endpoints/inbox/create-label"},{"openapi":"post /inbox/conversations/labels/{contactId}","title":"Attach Labels to Conversations","href":"/api-reference/endpoints/inbox/attach-labels-to-conversations"},{"openapi":"delete /inbox/conversations/labels/{contactId}","title":"Remove Labels from Conversation","href":"/api-reference/endpoints/inbox/remove-labels-from-conversation"},{"openapi":"get /inbox/{contactId}/drafts","title":"List Drafts","href":"/api-reference/endpoints/inbox/list-drafts"},{"openapi":"get /inbox/{contactId}/drafts/{draftId}","title":"Get Draft","href":"/api-reference/endpoints/inbox/get-draft"},{"openapi":"post /inbox/{contactId}/drafts","title":"Create Draft","href":"/api-reference/endpoints/inbox/create-draft"},{"openapi":"patch /inbox/{contactId}/drafts/{draftId}","title":"Update Draft","href":"/api-reference/endpoints/inbox/update-draft"},{"openapi":"delete /inbox/{contactId}/drafts/{draftId}","title":"Delete Draft","href":"/api-reference/endpoints/inbox/delete-draft"}]},{"group":"Tasks","expanded":false,"pages":[{"title":"Create Task","openapi":"post /tasks","href":"/api-reference/endpoints/tasks/create-task"},{"openapi":"get /v2/tasks","title":"Search Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks-v2"},{"openapi":"get /v2/tasks/filters","title":"List Task Filters","href":"/api-reference/endpoints/tasks/get-task-filters"},{"openapi":"get /tasks","title":"Get Many Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks"},{"openapi":"patch /tasks","title":"Update Task","href":"/api-reference/endpoints/tasks/update-task"},{"openapi":"post /tasks/ignore","title":"Ignore Tasks","href":"/api-reference/endpoints/tasks/ignore-tasks"}]},{"group":"Activities","expanded":false,"pages":[{"openapi":"get /activities","title":"Get Many Activities","href":"/api-reference/endpoints/activities/get-many-activities"},{"openapi":"delete /activities/{activityId}/recording-transcript","title":"Delete Activity Recording \u0026 Transcript","href":"/api-reference/endpoints/activities/delete-activity-recording-transcript"}]},{"group":"Calls","expanded":false,"pages":[{"openapi":"post /calls","title":"Log a Call","href":"/api-reference/endpoints/calls/log-call"},{"openapi":"patch /calls/{id}","title":"Update a Call","href":"/api-reference/endpoints/calls/update-call"},{"openapi":"get /calls/{id}","title":"Get a Call","href":"/api-reference/endpoints/calls/get-call"},{"openapi":"get /call-statuses","title":"Get Call Statuses","href":"/api-reference/endpoints/calls/get-call-statuses"}]},{"group":"CRMs","expanded":false,"pages":[{"openapi":"get /team/crmUsers","title":"Get Team CRM Users","href":"/api-reference/endpoints/crm/get-team-crm-users"},{"openapi":"get /crm/filters","title":"Get CRM Filters","href":"/api-reference/endpoints/crm/get-crm-filters"},{"openapi":"get /v2/crm/logs","title":"Get CRM Logs","href":"/api-reference/endpoints/crm/get-crm-logs"}]},{"group":"Unsubscribes","expanded":false,"pages":[{"group":"Variables","pages":[{"openapi":"get /v2/unsubscribes/variables","title":"List Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/list-unsubscribed-variables"},{"openapi":"get /v2/unsubscribes/variables/{value}","title":"Get Unsubscribed Variable","href":"/api-reference/endpoints/unsubscribes/get-unsubscribed-variable"},{"openapi":"post /v2/unsubscribes/variables/{value}","title":"Unsubscribe Variable","href":"/api-reference/endpoints/unsubscribes/unsubscribe-variable"},{"openapi":"post /v2/unsubscribes/variables","title":"Bulk Unsubscribe Variables","href":"/api-reference/endpoints/unsubscribes/bulk-unsubscribe-variables"},{"openapi":"delete /v2/unsubscribes/variables/{value}","title":"Re-subscribe Variable","href":"/api-reference/endpoints/unsubscribes/resubscribe-variable"},{"openapi":"get /v2/unsubscribes/exports/variables","title":"Export Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-variables"}]},{"group":"Contacts","pages":[{"openapi":"get /v2/unsubscribes/contacts/{contactId}","title":"Get Contact Subscription Status","href":"/api-reference/endpoints/unsubscribes/get-contact-subscription-status"},{"openapi":"post /v2/unsubscribes/contacts/{contactId}","title":"Unsubscribe Contact","href":"/api-reference/endpoints/unsubscribes/unsubscribe-contact"},{"openapi":"delete /v2/unsubscribes/contacts/{contactId}","title":"Re-subscribe Contact","href":"/api-reference/endpoints/unsubscribes/resubscribe-contact"},{"openapi":"get /v2/unsubscribes/exports/contacts","title":"Export Unsubscribed Contacts","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-contacts"}]},{"group":"Legacy","pages":[{"openapi":"post /unsubscribes/{email}","title":"Add Unsubscribe Email or Domain","href":"/api-reference/endpoints/unsubscribes/add-unsubscribe-email-or-domain"},{"openapi":"get /unsubscribes/{email}","title":"Get Unsubscribe by Email","href":"/api-reference/endpoints/unsubscribes/get-unsubscribe-by-email"},{"openapi":"get /unsubscribes","title":"Get Many Unsubscribes","href":"/api-reference/endpoints/unsubscribes/get-many-unsubscribes"},{"openapi":"delete /unsubscribes/{email}","title":"Delete Unsubscribe Email","href":"/api-reference/endpoints/unsubscribes/delete-unsubscribe-email"},{"openapi":"get /unsubs/export","title":"Export Unsubscribes","href":"/api-reference/endpoints/unsubscribes/export-unsubscribes"}]}]},{"group":"Webhooks","expanded":false,"pages":[{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"delete /hooks/{hookId}","title":"Delete Webhook","href":"/api-reference/endpoints/webhooks/delete-webhook"},{"openapi":"get /hooks","title":"Get Many Webhooks","href":"/api-reference/endpoints/webhooks/get-many-webhooks"}]},{"group":"People database","expanded":false,"pages":[{"openapi":"post /database/people","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /database/people/linkedin-post-engagement","title":"Search LinkedIn post engagers","href":"/api-reference/endpoints/people-database/search-linkedin-post-engagers"},{"openapi":"post /database/companies","title":"Search Companies Database","href":"/api-reference/endpoints/people-database/search-companies-database"},{"openapi":"get /database/people/export","title":"Export People database","href":"/api-reference/endpoints/people-database/export-people-database"},{"openapi":"get /database/companies/export","title":"Export Companies database","href":"/api-reference/endpoints/people-database/export-companies-database"},{"openapi":"get /database/filters","title":"Get Database Filters","href":"/api-reference/endpoints/people-database/get-database-filters"},{"openapi":"get /database/personas","title":"List Personas","href":"/api-reference/endpoints/people-database/list-personas"},{"openapi":"post /database/personas","title":"Create Persona","href":"/api-reference/endpoints/people-database/create-persona"},{"openapi":"delete /database/personas/{personaId}","title":"Delete Persona","href":"/api-reference/endpoints/people-database/delete-persona"},{"openapi":"get /database/saved-searches","title":"List Saved Searches","href":"/api-reference/endpoints/people-database/list-saved-searches"},{"openapi":"post /database/saved-searches","title":"Create Saved Search","href":"/api-reference/endpoints/people-database/create-saved-search"},{"openapi":"get /database/saved-searches/{savedSearchId}","title":"Get Saved Search","href":"/api-reference/endpoints/people-database/get-saved-search"},{"openapi":"patch /database/saved-searches/{savedSearchId}","title":"Update Saved Search","href":"/api-reference/endpoints/people-database/update-saved-search"},{"openapi":"delete /database/saved-searches/{savedSearchId}","title":"Delete Saved Search","href":"/api-reference/endpoints/people-database/delete-saved-search"}]},{"group":"Contact sourcing","expanded":false,"pages":[{"openapi":"post /contact-sourcing","title":"Run Contact Sourcing","href":"/api-reference/endpoints/contact-sourcing/run-contact-sourcing"},{"openapi":"get /contact-sourcing","title":"Get Contact Sourcing Run","href":"/api-reference/endpoints/contact-sourcing/get-contact-sourcing-run"},{"openapi":"post /contact-sourcing/contacts","title":"Add a Sourced Contact","href":"/api-reference/endpoints/contact-sourcing/add-sourced-contact"}]},{"group":"Enrich","expanded":false,"pages":[{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /v2/enrichments/bulk","title":"Bulk Enrich Data","href":"/api-reference/endpoints/enrich/bulk-enrich-data"},{"openapi":"post /leads/{leadId}/enrich","title":"Enrich Lead","href":"/api-reference/endpoints/enrich/enrich-lead"},{"openapi":"get /enrich/{enrichId}","title":"Get Enrichment Result","href":"/api-reference/endpoints/enrich/get-enrichment-result"}]},{"group":"Enrichment Providers","expanded":false,"pages":[{"openapi":"get /v2/enrichments/providers","title":"List Enrichment Providers","href":"/api-reference/endpoints/enrichment-providers/list-enrichment-providers"},{"openapi":"put /v2/enrichments/providers/{providerId}/connection","title":"Connect Provider","href":"/api-reference/endpoints/enrichment-providers/connect-provider"},{"openapi":"delete /v2/enrichments/providers/{providerId}/connection","title":"Disconnect Provider","href":"/api-reference/endpoints/enrichment-providers/disconnect-provider"}]},{"group":"Enrichment Waterfalls","expanded":false,"pages":[{"openapi":"get /v2/enrichments/waterfalls","title":"List Enrichment Waterfalls","href":"/api-reference/endpoints/enrichment-waterfalls/list-enrichment-waterfalls"},{"openapi":"get /v2/enrichments/waterfalls/{waterfallId}","title":"Get Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/get-enrichment-waterfall"},{"openapi":"patch /v2/enrichments/waterfalls/{waterfallId}","title":"Update Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/update-enrichment-waterfall"},{"openapi":"put /v2/enrichments/waterfalls/{waterfallId}/reset","title":"Reset Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/reset-enrichment-waterfall"}]},{"group":"lemwarm","expanded":false,"pages":[{"openapi":"post /lemwarm/{userMailboxId}/start","title":"Start lemwarm","href":"/api-reference/endpoints/lemwarm/start-lemwarm"},{"openapi":"post /lemwarm/{userMailboxId}/pause","title":"Pause lemwarm","href":"/api-reference/endpoints/lemwarm/pause-lemwarm"},{"openapi":"get /lemwarm/{userMailboxId}/settings","title":"Get lemwarm Settings","href":"/api-reference/endpoints/lemwarm/get-lemwarm-settings"},{"openapi":"patch /lemwarm/{userMailboxId}/settings","title":"Update lemwarm Settings","href":"/api-reference/endpoints/lemwarm/update-lemwarm-settings"},{"openapi":"get /lemwarm/errors","title":"Get warmup errors","href":"/api-reference/endpoints/lemwarm/get-warmup-errors"}]},{"group":"Self-recovery","expanded":false,"pages":[{"openapi":"get /self-recovery/config","title":"Get Self-recovery Config","href":"/api-reference/endpoints/self-recovery/get-config"},{"openapi":"patch /self-recovery/config","title":"Update Self-recovery Config","href":"/api-reference/endpoints/self-recovery/update-config"},{"openapi":"get /self-recovery/history","title":"List Self-recovery History","href":"/api-reference/endpoints/self-recovery/get-history"}]},{"group":"Signal Agents","expanded":false,"pages":[{"openapi":"get /watchlist","title":"List Signal Agents","href":"/api-reference/endpoints/watch-list/list-watch-lists"},{"openapi":"post /watchlist","title":"Create Signal Agent","href":"/api-reference/endpoints/watch-list/create-watch-list"},{"openapi":"patch /watchlist","title":"Update Signal Agent","href":"/api-reference/endpoints/watch-list/update-watch-list"},{"openapi":"post /watchlist/crm-lists","title":"Monitor CRM Lists with a Signal Agent","href":"/api-reference/endpoints/watch-list/associate-crm-lists"},{"openapi":"delete /watchlist","title":"Delete Signal Agent","href":"/api-reference/endpoints/watch-list/delete-watch-list"},{"openapi":"get /watchlist/history","title":"Get Signal Agent configuration history","href":"/api-reference/endpoints/watch-list/get-history"},{"openapi":"get /watchlist/signals","title":"Get Signal Agent signals","href":"/api-reference/endpoints/watch-list/get-signals"},{"openapi":"put /watchlist/signals","title":"Mark signals handled or ignored","href":"/api-reference/endpoints/watch-list/mark-signals"},{"openapi":"post /watchlist/{watchListId}/external-signals","title":"Push external signals","href":"/api-reference/endpoints/watch-list/push-external-signals"},{"openapi":"get /watchlist/library","title":"List available signal types","href":"/api-reference/endpoints/watch-list/get-library"},{"openapi":"get /watchlist/filters","title":"List allowed filters per signal type","href":"/api-reference/endpoints/watch-list/get-filters"},{"openapi":"get /watchlist/filter-values","title":"Autocomplete filter values","href":"/api-reference/endpoints/watch-list/get-filter-values"}]},{"group":"Deliverability alerts","expanded":false,"pages":[{"openapi":"get /deliverability/alerts","title":"List Deliverability Alerts","href":"/api-reference/endpoints/deliverability-alerts/list-alerts"},{"openapi":"post /deliverability/alerts","title":"Create Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/create-alert"},{"openapi":"get /deliverability/alerts/{alertId}","title":"Get Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/get-alert"},{"openapi":"patch /deliverability/alerts/{alertId}","title":"Update Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/update-alert"},{"openapi":"delete /deliverability/alerts/{alertId}","title":"Delete Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/delete-alert"},{"openapi":"get /deliverability/incidents","title":"List Deliverability Incidents","href":"/api-reference/endpoints/deliverability-alerts/list-incidents"}]},{"group":"Sender picture","expanded":false,"pages":[{"openapi":"get /sender-picture/mailboxes","title":"Get Sender Picture Status","href":"/api-reference/endpoints/sender-picture/get-sender-picture-status"},{"openapi":"post /sender-picture/sync","title":"Sync Sender Picture","href":"/api-reference/endpoints/sender-picture/sync-sender-picture"}]},{"group":"Domains","expanded":false,"pages":[{"openapi":"post /domains-core/search","description":"Checks whether a domain can be bought through lemlist, with its price and the providers that can register it.","title":"Search Domains","href":"/api-reference/endpoints/domains/search-domains"},{"openapi":"post /domains-core/purchase","title":"Purchase Domain","href":"/api-reference/endpoints/domains/purchase-domain"},{"openapi":"get /domains-core/team-domains","description":"Lists the team's domains bought or being transferred through lemlist.","title":"List Domains","href":"/api-reference/endpoints/domains/list-domains"},{"openapi":"post /domains-core/{domainId}/mailboxes","title":"Order Mailboxes","href":"/api-reference/endpoints/domains/order-mailboxes"},{"openapi":"get /domains-core/mailboxes","title":"List Domain Mailboxes","href":"/api-reference/endpoints/domains/list-domain-mailboxes"},{"openapi":"patch /domains-core/mailboxes/{mailboxId}","title":"Update Domain Mailbox","href":"/api-reference/endpoints/domains/update-domain-mailbox"}]},{"group":"Fields","expanded":false,"pages":[{"openapi":"get /fields","title":"List Fields","href":"/api-reference/endpoints/fields/list-fields"},{"openapi":"post /fields","title":"Create or Update Field","href":"/api-reference/endpoints/fields/create-field"},{"openapi":"delete /fields/{entity}/{name}","title":"Delete Field","href":"/api-reference/endpoints/fields/delete-field"}]}]},{"group":"Objects \u0026 Definitions","pages":[{"title":"Team","href":"/api-reference/objects-definitions/team"},{"title":null,"href":"/api-reference/objects-definitions/credits"},{"title":"User","href":"/api-reference/objects-definitions/user"},{"title":"Campaign","href":"/api-reference/objects-definitions/campaign"},{"title":"Lead","href":"/api-reference/objects-definitions/lead"},{"title":"Activity","href":"/api-reference/objects-definitions/activity"},{"title":"Unsubscribe","href":"/api-reference/objects-definitions/unsubscribe"},{"title":"Enrichment","href":"/api-reference/objects-definitions/enrich"},{"title":"Task","href":"/api-reference/objects-definitions/task"},{"title":"Inbox Conversation","href":"/api-reference/objects-definitions/inbox-conversation"},{"title":"Inbox Message","href":"/api-reference/objects-definitions/inbox-message"},{"title":"Contact","href":"/api-reference/objects-definitions/contact"},{"title":"Self-recovery config","href":"/api-reference/objects-definitions/self-recovery-config"},{"title":"Self-recovery case","href":"/api-reference/objects-definitions/self-recovery-case"},{"group":"People Database","expanded":false,"pages":[{"title":"Database","href":"/api-reference/objects-definitions/database"},{"title":"People","href":"/api-reference/objects-definitions/people-database"},{"title":"Company","href":"/api-reference/objects-definitions/company-database"},{"title":"Persona","href":"/api-reference/objects-definitions/persona"},{"title":"Saved search","href":"/api-reference/objects-definitions/saved-search"}]},{"title":"CRM Filter","href":"/api-reference/objects-definitions/crm-filter"},{"title":null,"href":"/api-reference/objects-definitions/company"},{"title":"Lemwarm Settings","href":"/api-reference/objects-definitions/lemwarm"},{"title":"Warmup Error","href":"/api-reference/objects-definitions/warmup-error"},{"title":"Campaign Status","href":"/api-reference/objects-definitions/campaign-status"},{"title":"Channel","href":"/api-reference/objects-definitions/channel"},{"title":"Sequence","href":"/api-reference/objects-definitions/sequence"},{"title":"Step","href":"/api-reference/objects-definitions/step"},{"title":"Message template","href":"/api-reference/objects-definitions/message-template"},{"title":"Snippet","href":"/api-reference/objects-definitions/snippet"},{"title":"Schedule","href":"/api-reference/objects-definitions/schedule"},{"title":"Label","href":"/api-reference/objects-definitions/label"},{"title":"Report","href":"/api-reference/objects-definitions/report"},{"title":"Webhook","href":"/api-reference/objects-definitions/webhook"},{"title":"Mailbox","href":"/api-reference/objects-definitions/mailbox"},{"title":"Domain","href":"/api-reference/objects-definitions/domain"},{"title":"Domain mailbox","href":"/api-reference/objects-definitions/domain-mailbox"},{"title":"Company Note","href":"/api-reference/objects-definitions/company-note"},{"title":"Contact Note","href":"/api-reference/objects-definitions/contact-note"},{"title":"CRM Log","href":"/api-reference/objects-definitions/crm-log"},{"title":"Signal Agents / Signal","href":"/api-reference/objects-definitions/signal"},{"title":"Signal Agents / Watch List","href":"/api-reference/objects-definitions/watch-list"},{"title":"Deliverability alert","href":"/api-reference/objects-definitions/deliverability-alert"},{"title":"Deliverability incident","href":"/api-reference/objects-definitions/deliverability-incident"},{"title":"Sender picture","href":"/api-reference/objects-definitions/sender-picture"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/setup"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]}]},"title":"Lemlist Developer Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}