> ## 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. > Pushes companies to your connected CRM, linking each one to the CRM record found and creating it there when none matches. # Create Companies in the CRM Pushes companies to your connected CRM — the **Create in CRM** action of the Companies page. Each company is searched in the CRM first: linked to the record found, created in the CRM otherwise. Target the companies with `idsOrDomains` (lemlist ids or domains) **or** with `listId` for a whole company list, static or dynamic: 10,000 companies at most either way, a domain counting every company that carries it. ## Asynchronous: read the outcome later The call queues the work and answers at once with what was **queued**, not with what the CRM returned. Each company's outcome lands on its `crmSync` block shortly after: * `GET /companies?idsOrDomains=...` returns each company with its `crmSync` block (`searching`, `crmRecordId`, `notFoundAt`, `errors`), 100 companies per call. * `GET /companies?listId=...&crmSyncStatus=` lists the companies of a list by state: `searching` while the search runs, then `synced` (linked or created), or `error` (refused by the CRM, with its reason). Without `listId`, the filter reads every company of the team: do not poll it. ## What the counts mean * `alreadyLinked`: already linked to a CRM record, synced with it again instead of searched. * `toCreate`: searched in the CRM first, then linked or created. * `notSearchable`: nothing the CRM can be searched with (no domain or LinkedIn URL), left untouched. * `alreadyInProgress`: a CRM search was already queued for them, not queued twice. * `notFound`: the references sent that match no company of your team. ## Who can call it The API key must belong to a team **admin**, like the action in the app. On Salesforce, the connection must grant the object created (Account). ## OpenAPI ````yaml post /companies/crm/create 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: /companies/crm/create: post: tags: - Companies summary: Create Companies in the CRM description: >- Pushes companies to your connected CRM — the **Create in CRM** action of the Companies page. Each company is searched in the CRM first: linked to the record found, created in the CRM otherwise. Target the companies with `idsOrDomains` (lemlist ids or domains) **or** with `listId` for a whole company list: 10,000 companies at most either way, a domain counting every company that carries it. **Asynchronous:** the call queues the work and answers at once with what was queued, not with what the CRM returned. Each company's outcome lands on its `crmSync` block shortly after: read it with `GET /companies?idsOrDomains=...` (100 per call), or, after a list, list its companies by state with `listId` and `crmSyncStatus`: `searching` while the search runs, then `synced` once linked or created, or `error` with its reason when the CRM refused it. Without `listId`, `crmSyncStatus` reads every company of the team: do not poll it. - A company already linked to a CRM record is synced with it again (`alreadyLinked`). - A company with nothing to search the CRM with is left untouched (`notSearchable`). - A company whose CRM search is already queued is not queued twice (`alreadyInProgress`). Requires a connected CRM (HubSpot, Salesforce, Pipedrive, Attio or Zoho) and an API key of a team **admin**. On Salesforce, the connection must grant the object created (Account). requestBody: required: true content: application/json: schema: type: object properties: idsOrDomains: type: array items: type: string minItems: 1 maxItems: 10000 description: >- lemlist company ids (`cpn_xxx`) or domains, 10,000 at most. A domain designates every company carrying it: 10,000 companies at most in total. Send either `idsOrDomains` or `listId`. example: - cpn_xW8Ou6C03Csv8vatp - acme.com listId: type: string description: >- A company list id (`clt_xxx`): acts on every company of the list, static or dynamic, 10,000 at most. Use it instead of `idsOrDomains`. example: clt_Ab12Cd34Ef56Gh78I responses: '200': description: >- Queued — **not done yet.** The counts say what was queued; each record's outcome lands on its `crmSync` block shortly after. content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: alreadyLinked: type: integer description: >- Companies already linked to a CRM record: synced with it again instead of searched. toCreate: type: integer description: >- Companies searched in the CRM first: linked to the record found, created in the CRM otherwise. notSearchable: type: integer description: >- Records with nothing the CRM can be searched with: no email address or LinkedIn URL for a contact, no domain or LinkedIn URL for a company (Pipedrive also searches by name). Left untouched. alreadyInProgress: type: integer description: >- Companies whose CRM search was already queued: not queued twice. notFound: type: array items: type: string description: >- The references sent that match no company of your team, as sent. Always empty with `listId`. required: - alreadyLinked - toCreate - notSearchable - alreadyInProgress - notFound required: - success - data example: success: true data: alreadyLinked: 2 toCreate: 6 notSearchable: 1 alreadyInProgress: 0 notFound: - unknown-domain.io '400': description: >- Invalid request. Possible error codes: `INVALID_SELECTION` (neither or both of `idsOrDomains` and `listId`, or an empty `idsOrDomains`), `TOO_MANY_RECORDS` (more than 10,000 references), `TOO_MANY_MATCHES` (the domains match more than 10,000 companies in total), `INVALID_LIST_ID` (not a `clt_xxx` id), `LIST_ENTITY_MISMATCH` (the list does not hold companies), `LIST_TOO_LARGE` (the list holds more than 10,000 companies), `NO_CRM_CONNECTED` (no CRM connected to the team), `VALIDATION_ERROR` (a field of the wrong type), `AS_LEAD_NOT_SUPPORTED` (`asLead` sent: Leads are contacts only), `CRM_OBJECT_NOT_ALLOWED` (the Salesforce connection does not grant the object to create). content: application/json: example: success: false error: code: NO_CRM_CONNECTED message: No CRM connected for this team '401': description: The authentication you supplied is incorrect. content: text/plain: example: The authentication you supplied is incorrect '403': description: >- The API key does not belong to a team admin (`CREATE_IN_CRM_NOT_ALLOWED`). content: application/json: example: success: false error: code: CREATE_IN_CRM_NOT_ALLOWED message: Only a team admin can create records in the CRM '404': description: The team has no list with this `listId` (`LIST_NOT_FOUND`). content: application/json: example: success: false error: code: LIST_NOT_FOUND message: List not found components: securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.