> ## 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. # Add ABM Campaign Leads > Adds People Database people to an ABM campaign. > [!NOTE] > > Beta: this endpoint requires the ABM beta on your team. Without it, the call > answers `403` with `BETA_NOT_ENABLED`. Takes People Database ids, from a People Database search or a contact-sourcing run's `contacts[].leadId`, and adds each person to the campaign as a lead. ## Filed under the campaign's company Each new contact is filed under the company the ABM campaign engages, whatever the person's profile lists as their current employer. That keeps every lead of an ABM campaign on its account. Someone your workspace already has as a contact of another company is skipped and left where they are: the response lists them in `skipped`. | Code | Meaning | | - | - | | `200` | Done. `addedCount` leads added, `alreadyInCampaignCount` already there, `skipped` people not added. | | `400` | `leadIds` is missing, empty or too long, or `campaignId` is malformed. | | `403` | The ABM beta is not enabled, or the API key's user cannot create contacts. Nothing is written. | | `404` | The campaign is not an ABM campaign of your team, or its company no longer exists. | ## OpenAPI ````yaml post /campaigns/{campaignId}/abm-leads 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: /campaigns/{campaignId}/abm-leads: parameters: - name: campaignId in: path required: true description: The ABM campaign, opened with Engage on a company example: cam_A1B2C3D4E5F6G7H8I9 schema: type: string post: tags: - Campaigns summary: Add ABM Campaign Leads description: >- **Beta**: requires the ABM beta on your team, otherwise the call answers `403 BETA_NOT_ENABLED`. Adds People Database people to an account-based (ABM) campaign. Each person becomes a contact filed under the campaign's company, whatever their profile lists as their current employer, then a lead of the campaign. Someone your workspace already has as a contact of another company is skipped, never moved. parameters: [] requestBody: required: true content: application/json: schema: type: object required: - leadIds properties: leadIds: type: array minItems: 1 maxItems: 199 description: >- People Database ids, from People Database search results or a contact-sourcing run's `contacts[].leadId`. items: type: string example: leadIds: - '123456789' - '987654321' responses: '200': description: >- What the call did. A skipped person is a normal outcome, not an error. content: application/json: example: data: addedCount: 1 alreadyInCampaignCount: 0 skipped: - leadId: '987654321' code: ABS_CONTACT_SOURCING_CONTACT_ON_ANOTHER_COMPANY '400': description: >- `leadIds` is missing, empty or longer than the limit, or `campaignId` is malformed. content: application/json: example: error: Too many leads selected code: ABS_ENGAGE_TOO_MANY_LEADS '403': description: >- The ABM beta is not enabled for your team (`BETA_NOT_ENABLED`), or the API key's user does not have the "Create contacts" permission (`ABS_CONTACT_SOURCING_CONTACT_CREATE_NOT_ALLOWED`). Nothing is written. content: application/json: example: error: Beta is not enabled code: BETA_NOT_ENABLED '404': description: >- The campaign is not an ABM campaign of your team (`ABS_ENGAGE_CAMPAIGN_NOT_ABM`), or its company no longer exists. content: application/json: example: error: This campaign is not an ABM campaign code: ABS_ENGAGE_CAMPAIGN_NOT_ABM components: securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.