> ## 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. # Order Mailboxes > Orders mailboxes on one of the team's domains and bills the team. > [!NOTE] > > This endpoint uses the [Domain mailbox object](https://developer.lemlist.com/api-reference/objects-definitions/domain-mailbox.md). > [!WARNING] > > This call bills the team: each mailbox is a monthly seat on the domain's mailbox subscription, prorated on the first invoice. Nothing can be canceled through the API; use the lemlist app. The mailbox type is the domain's `registrar`: Google Workspace, Microsoft 365 or SMTP. The order is checked as a whole: one invalid mailbox refuses it all, and nothing is billed. You can order right after [Purchase Domain](https://developer.lemlist.com/api-reference/endpoints/domains/purchase-domain.md). The mailboxes stay `ordered` until the domain is set up, then they are billed and created. Follow them with [List Domain Mailboxes](https://developer.lemlist.com/api-reference/endpoints/domains/list-domain-mailboxes.md). ## Rules by provider | Provider | Rules | | - | - | | `google` | The first mailbox set up becomes the Google Workspace super admin. Pick it with `workspaceAdmin: true`, otherwise lemlist picks one. The order is refused while the domain's nameservers do not point to lemlist. | | `m365` | The username `admin` is reserved by Microsoft. Every assigned user needs a first and last name in lemlist. | | `infraforge` | At most 10 mailboxes per domain. Set a `sendername`. | > [!NOTE] > > Pass `assignToUser` for each mailbox: without it the mailbox goes to the user of the API key. > > This call is not idempotent. Calling it again with the same usernames answers `409` (`Some emails are already taken`): check List Domain Mailboxes before retrying. > [!WARNING] > > Requires the **Manage domains** permission on the user of the API key. ## OpenAPI ````yaml post /domains-core/{domainId}/mailboxes 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/{domainId}/mailboxes: post: tags: - Domains summary: Order Mailboxes description: >- Orders mailboxes on one of the team's domains and bills the team. The mailboxes are created in the background. operationId: orderDomainMailboxes parameters: - name: domainId in: path required: true description: The domain, from List Domains or Purchase Domain example: dom_Kd8Wq2Lr5Tx9Mz3Pv schema: type: string requestBody: required: true content: application/json: schema: type: object properties: emails: type: array minItems: 1 items: type: object properties: username: type: string description: >- Local part of the address, lowercased: `john` for `john@getacme.com` example: john sendername: type: string description: >- Display name of an `infraforge` (SMTP) mailbox. Google Workspace and Microsoft 365 mailboxes take the name of the assigned user. example: John Doe assignToUser: type: string description: >- Team member who will send from the mailbox. Defaults to the API key user, so pass it for every mailbox when ordering for several people. example: usr_Ye6Ta3Uo8Ic1Mn7Bh workspaceAdmin: type: boolean description: >- `google` domains only: the mailbox that becomes the Google Workspace super admin. Only applies while the domain has no admin yet; without it, lemlist picks one of the ordered mailboxes. required: - username required: - emails responses: '200': description: Mailboxes ordered content: application/json: schema: type: object properties: added: type: integer mailboxes: type: array items: type: object properties: _id: type: string email: type: string format: email assignToUser: type: string example: added: 2 mailboxes: - _id: dem_Rb4Nc7Fy1Hs6Jq0Wt email: john@getacme.com assignToUser: usr_Ye6Ta3Uo8Ic1Mn7Bh - _id: dem_Zp2Gx8Vm4Lk9Ds5Qe email: jane@getacme.com assignToUser: usr_Wf3Kp9Rd2Nz6Xc4Lj '400': description: Malformed body, unknown `domainId`, or the API key has no user content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: 'Match error: Expected object, got undefined' '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 mailboxes content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: You do not have permission to perform this action '409': description: >- The order is refused, nothing billed: invalid or duplicate address, address already taken, assignee outside the team, canceled domain, nameservers not pointing to lemlist (Google), Google Workspace held elsewhere, reserved username or assignee without a last name (Microsoft 365), more than 10 SMTP mailboxes on the domain content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: Some emails are already taken '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: Internal error '502': description: The Google Workspace status could not be checked; retry later content: application/json: schema: $ref: '#/components/schemas/ApiErrorMessage' example: error: >- Unable to verify your workspace status. Please try again in a moment. components: schemas: 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.