> ## 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. > Skips one step of a running campaign for a list of leads. # Skip Step for Leads Send up to 100 leads per call, each as a lead id or an email. For each lead the step never runs: the lead moves on to the next step after that step's own delay. Leads that already ran the step are unaffected — nothing already sent changes. The call answers per item and never fails on one: a lead that already had the step skipped answers `already_skipped`, an item that matches no lead of the campaign answers `not_found`. Only a request that must be fixed as a whole is refused, such as more than 100 items (`400`, never truncated) or a condition step (`422`). A skip cannot be undone, here or in the lemlist app. To skip a step for every lead of the campaign, including leads added later, use [Skip Step for Everyone](/api-reference/endpoints/campaigns/skip-step-for-everyone) instead. ## OpenAPI ````yaml post /campaigns/{campaignId}/steps/{stepId}/skip-for-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}/steps/{stepId}/skip-for-leads: parameters: - name: campaignId in: path required: true description: The unique identifier of the campaign example: cam_A1B2C3D4E5F6G7H8I9 schema: type: string - name: stepId in: path required: true description: >- The unique identifier of the step, from GET /campaigns/{campaignId}/sequences example: stp_A1B2C3D4E5F6G7H8I9 schema: type: string post: tags: - Campaigns summary: Skip Step for Leads description: >- Skip one step of a running campaign for a list of leads, at most 100 per call. Each item is a lead id or an email. Cannot be undone. parameters: [] requestBody: required: true content: application/json: schema: type: object required: - leads properties: leads: type: array minItems: 1 maxItems: 100 description: >- The leads to skip the step for: 1 to 100 items. An email is matched inside the campaign, case-insensitively. A repeated item is read once. An email is not URL-decoded: send it as it is stored. items: type: string description: A lead id (lea_...) or the lead's email example: leads: - lea_A1B2C3D4E5F6G7H8I - jane@example.com - ghost@example.com responses: '200': description: >- One `results` row per distinct item sent, echoing it as sent. Per-item outcomes never fail the call: `skipped`, `already_skipped` (an idempotent no-op) or `not_found` (no lead of this campaign matches). Counts are per lead: two items naming the same lead both echo its status, and the lead counts once. content: application/json: schema: type: object properties: total: type: integer description: skipped + alreadySkipped + the items in notFound skipped: type: integer description: Leads skipped by this call alreadySkipped: type: integer description: >- Leads that already had the step skipped: nothing changed for them notFound: type: array items: type: string description: The items that matched no lead of the campaign, as sent results: type: array items: type: object properties: lead: type: string description: 'The item as sent: a lead id or an email' status: type: string enum: - skipped - already_skipped - not_found example: total: 3 skipped: 2 alreadySkipped: 0 notFound: - ghost@example.com results: - lead: lea_A1B2C3D4E5F6G7H8I status: skipped - lead: jane@example.com status: skipped - lead: ghost@example.com status: not_found '400': description: >- The request must be fixed as a whole: a malformed path identifier, a body that is not JSON, `leads` missing, empty, not an array of strings or with an item over the length limit (`ROUTE_BAD_REQUEST`); more than 100 items (`STEP_SKIP_TOO_MANY_LEADS`, never truncated); or no API key supplied (plain text). content: application/json: example: error: At most 100 leads per call code: STEP_SKIP_TOO_MANY_LEADS text/plain: example: no api key provided '401': description: Unauthorized - invalid or missing API key content: text/plain: example: The authentication you supplied is incorrect '404': description: >- `STEP_SKIP_CAMPAIGN_NOT_FOUND` or `STEP_SKIP_STEP_NOT_FOUND` - the campaign or the step does not exist in this workspace. A lead that is not in the campaign is a `not_found` item, never a 404. content: application/json: example: error: Step not found in this campaign code: STEP_SKIP_STEP_NOT_FOUND '405': description: Method not allowed - this endpoint only accepts POST '422': description: >- `STEP_SKIP_STEP_IS_CONDITION` - a condition step can never be skipped. content: application/json: example: error: A condition step cannot be skipped code: STEP_SKIP_STEP_IS_CONDITION '429': description: Rate limit exceeded - 20 requests per 2 seconds per API key components: securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.