> ## Documentation Index > Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt > Use this file to discover all available pages before exploring further. # Purchase Domain > Orders a domain, or a transfer of a domain you own elsewhere, and bills the team. > [!NOTE] > > This endpoint uses the [Domain object](https://developer.lemlist.com/api-reference/objects-definitions/domain.md). > [!WARNING] > > 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. ## Before the first purchase 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). ## After the call 1. The domain is billed, then registered and set up in the background. Follow its `status` with [List Domains](https://developer.lemlist.com/api-reference/endpoints/domains/list-domains.md). 2. Order its mailboxes with [Order Mailboxes](https://developer.lemlist.com/api-reference/endpoints/domains/order-mailboxes.md). You can call it right away: the mailboxes wait for the domain, and are only billed once it is set up. > [!NOTE] > > 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. ## Retrying 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. ## Transfers 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. > [!WARNING] > > Requires the **Manage domains** permission on the user of the API key. ## OpenAPI ````yaml post /domains-core/purchase openapi: 3.0.0 info: title: lemlist API version: 1.0.0 description: >- Welcome to the lemlist Developer Documentation. lemlist is very customizable and open. You'll find on this page all the API and integration you can do with lemlist. # Rate Limit lemlist's API rate limits requests in order to prevent abuse and overload of our services. Rate limits are applied on all routes and per API key performing the request. The rate limits are **20** requests per **2** seconds. The response provides any information you may need about it: | Header | Description | | --- | --- | | Retry-After | The number of seconds in which you can retry | | X-RateLimit-Limit | The maximum requests in that time | | X-RateLimit-Remaining | The number of remaining requests you can make | | X-RateLimit-Reset | The date when the rate limit will reset | _Example of values for the rate limit headers_ ``` json { "Retry-After": 2, "X-RateLimit-Limit": 20, "X-RateLimit-Remaining": 7, "X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)" } ``` # Definitions ## Team A team is the entity of lemlist that can handle users and billing. ## Credits Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via the enrich route. Each enrichment feature needs a certain amount of credits to run. ## User You use a user account to connect to lemlist and send messages via the connected emails or LinkedIn account. ## Campaign A campaign is the entity to automate outreach. A campaign has multiple sequences composed of steps. ## Lead A lead is a person that you try to contact via a campaign. ## Activity An activity is the history of all the steps. ## Unsubscribe An unsubscribe occurs when a person decides they don't want to receive emails from you anymore. # Authentication All API routes use the dedicated subdomain `api.lemlist.com`. lemlist uses API keys to allow access to the API. You can get your lemlist API key at our [integration page](https://app.lemlist.com/settings/integrations). You need to add the `Authorization` header using the `Basic` authentication type. `login:password` **where the login is always empty and the password is the API key**. ⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl command.** > To authorize, use this code: ``` shell curl https://api.lemlist.com/api/team \ --user ":YourApiKey" ``` **Make sure to replace** **`YourApiKey`** **with your API key.** # Give feedback If you want to report a bug, ask for data, or share with us a use case, please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will help us centralize your needs! servers: - url: https://api.lemlist.com/api security: - basicAuth: [] tags: - name: Enrichment Providers description: >- The data providers lemlist can call to find an email or a phone. Internal providers are paid with lemlist credits and always available. External providers run on your own account: connect one by saving its API key, and it becomes available to your waterfalls. `GET /enrichments/providers` is the catalog of provider ids accepted by the waterfall endpoints. - name: Enrichment Waterfalls description: >- Control which data providers lemlist calls when enriching a contact, and in which order. A waterfall is an ordered list of providers for one enrichment `type` (`email` or `phone`). Providers are tried one after the other until one returns a result. Every team has exactly one default waterfall per type (`isDefault: true`). While its `editor` is `lemlist` it follows the lemlist behaviour: providers you connected with your own API key are tried first, then internal providers in a random order. Once a team member edits its provider list, `editor` becomes that user's id and the list is followed as is; resetting it hands it back to `lemlist`. Custom waterfalls (`isDefault: false`) carry `conditions` on the contact being enriched, keyed by contact property; every key present must match. When a contact is enriched, lemlist runs a single waterfall: the custom waterfall of the requested type whose conditions match the contact, or the default waterfall when none does. If several match, the one with the most condition keys wins, then the most recently updated. Only that waterfall runs; when it finds nothing, the enrichment ends without falling back to another one. paths: /domains-core/purchase: post: tags: - Domains summary: Purchase Domain description: >- Orders a domain, or a transfer of a domain you own elsewhere, and bills the team. The domain is then set up in the background. operationId: purchaseDomain requestBody: required: true content: application/json: schema: type: object properties: domain: type: string description: Domain to buy or transfer example: getacme.com 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`. isTransfer: type: boolean default: false description: >- Transfer a domain registered elsewhere instead of registering a new one authCode: type: string description: >- Transfer authorization code from the current registrar. Required when `isTransfer` is `true`. 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 type: type: string enum: - TXT - CNAME - A - AAAA - NS - MX - SRV value: type: string example: example.com ttl: type: integer example: 3600 priority: type: integer required: - hostName - type - value billingContact: $ref: '#/components/schemas/DomainBillingContact' required: - domain responses: '200': description: >- Domain ordered, or already ordered by the team (`alreadyOwned: true`, nothing billed) content: application/json: schema: type: object properties: domain: $ref: '#/components/schemas/Domain' alreadyOwned: type: boolean description: >- True when the team already had a live order for this domain: the call billed nothing and returns that order. required: - domain - alreadyOwned example: domain: _id: dom_Kd8Wq2Lr5Tx9Mz3Pv domain: getacme.com registrar: google status: ordered createdAt: '2026-01-15T10:30:00.000Z' emailCount: 0 alreadyOwned: false '400': 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: $ref: '#/components/schemas/ApiErrorMessage' example: error: >- A domain billing contact is required before purchasing. Provide the billingContact field, then retry. '401': description: Unauthorized - invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: Unauthorized '403': description: >- The API key user lacks the Manage domains permission, or the team cannot buy domains content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: You do not have permission to perform this action '409': 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: $ref: '#/components/schemas/ApiErrorMessage' example: error: This domain was already purchased or is not available anymore. '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: Internal error components: schemas: DomainBillingContact: 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 lastName: type: string example: Doe email: type: string format: email description: Must not be an address on the domain being bought. example: john@example.com phone: type: string description: International format. The phone country must match a real number. example: '+15555550123' name: type: string description: Organization name example: Acme Inc line1: type: string description: Street address example: 1 Main Street city: type: string example: Springfield postalCode: type: string description: Required for most countries example: '12345' countryCode: type: string description: ISO 3166-1 alpha-2 country of the address example: US 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 companyIdentificationCode: type: string description: >- SIREN/SIRET. Required to register a `.fr` or `.be` domain with `google` or `m365`. vatIdentificationCode: type: string description: VAT number, used for `.fr` and `.be` domains required: - firstName - lastName - email - phone - name - line1 - city - countryCode 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 domain: type: string description: Domain name, lowercase example: getacme.com 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. 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. createdAt: type: string format: date-time description: Order date emailCount: type: integer description: Number of mailboxes ordered on the domain example: 0 required: - _id - domain - registrar - status - createdAt - emailCount ApiErrorMessage: type: object description: Error answered as a plain message by the contact and company endpoints. properties: error: type: string description: Human-readable explanation. required: - error securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.