> ## 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. > Forces a team member, and one of their accounts, as the sender of a step. # Set Step Sender A forced sender requires at least the **Email Pro** plan. Forces the sender of one step, with the rules of the campaign editor. ## Which steps accept a forced sender | Step | `channel` | | - | - | | Email | Required, `type: "email"` | | LinkedIn steps, LinkedIn voice notes | Required, `type: "linkedin"` | | WhatsApp message, WhatsApp voice note | Required, `type: "whatsapp"` | | SMS | Required, `type: "phone"` | | Call, manual, API and phone tasks | Forbidden: the step pins a user, not an account | Delay, condition and other utility steps have no sender: the endpoint answers `409`. ## Rules * `userId` must be a team member who owns the account. * Without `channel.id`, the first healthy account of the type is used. An unhealthy account is accepted when you name it. Read its diagnostics with [Get Campaign Senders](/api-reference/endpoints/senders/get-campaign-senders). * `channel.alias` picks an alias of an email account. It needs `channel.id`. * An InMail step needs a sender with LinkedIn Premium. ## Effects * The sender pool changes as in the campaign editor: a channel type that no other step uses leaves the pool. `senderPoolChange` lists the channel types that the change enables or disables in the pool. * On a running campaign, the pending tasks of the step move to the forced sender. ## OpenAPI ````yaml put /sequences/{sequenceId}/steps/{stepId}/sender 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: /sequences/{sequenceId}/steps/{stepId}/sender: parameters: - name: sequenceId in: path required: true description: The unique identifier of the sequence example: seq_A1b2C3d4E5f6G7h8J schema: type: string - name: stepId in: path required: true description: The unique identifier of the step example: stp_A1b2C3d4E5f6G7h8I schema: type: string put: tags: - Sequences summary: Set Step Sender description: >- Forces a sender on a step, as the campaign editor does. The step then always sends from this team member, whatever sender the lead got. On a running campaign, the pending tasks of the step move to this sender. Requires the Email Pro plan. parameters: [] requestBody: required: true content: application/json: schema: type: object required: - userId additionalProperties: false properties: userId: type: string description: The team member who sends the step channel: type: object required: - type additionalProperties: false properties: type: type: string enum: - email - linkedin - whatsapp - phone description: >- The channel type of the step: `email` on an email step, `linkedin` on a LinkedIn step, `whatsapp` on a WhatsApp step, `phone` on an SMS step. id: type: string description: >- The account to send from: the mailbox id, the WhatsApp account id, or the phone number. On LinkedIn, the user id. Without `id`, the first healthy account of the type. alias: type: string description: >- Email only, with an `id`: the alias address of the mailbox to send from. description: >- Required on an email, LinkedIn, WhatsApp or SMS step. Forbidden on a call, manual, API or phone step. example: userId: usr_A1b2C3d4E5f6G7h8K channel: type: email id: usm_A1b2C3d4E5f6G7h8L responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: step: $ref: '#/components/schemas/StepSender' senderPoolChange: $ref: '#/components/schemas/SenderPoolChange' example: data: step: sequenceId: seq_A1b2C3d4E5f6G7h8J stepId: stp_A1b2C3d4E5f6G7h8I stepType: email sender: userId: usr_A1b2C3d4E5f6G7h8K channel: type: email id: usm_A1b2C3d4E5f6G7h8L alias: john@example.com senderPoolChange: enabledChannelTypes: [] disabledChannelTypes: - email '400': description: >- Bad request: the body does not match the schema, the channel does not match the step, the user is not a team member, the account does not belong to the user, or an InMail step gets a sender without LinkedIn Premium content: application/json: schema: type: object properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code example: error: >- The channel does not match the step: give a channel of the step type, or no channel on a call, manual, API or phone step code: SENDER_STEP_CHANNEL_MISMATCH '401': description: The authentication you supplied is incorrect content: text/plain: example: The authentication you supplied is incorrect '402': description: A forced sender requires at least the Email Pro plan content: text/plain: example: route is available starting emailPro plan '404': description: >- Sequence, step or campaign not found. A template sequence has no campaign. content: application/json: schema: type: object properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code example: error: Step not found code: SEQUENCE_STEP_NOT_FOUND '405': description: Method not allowed content: application/json: example: error: Route bad method code: ROUTE_BAD_METHOD '409': description: The step type has no sender content: application/json: schema: type: object properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code example: error: This step type has no sender code: SENDER_STEP_NOT_FORCEABLE components: schemas: StepSender: type: object properties: sequenceId: type: string stepId: type: string stepType: type: string description: The step type. Absent on a legacy email step. sender: type: object description: >- The forced sender of the step, in the shape of the request body. Absent when the step uses the sender strategy of the campaign. properties: userId: type: string description: The team member who sends the step channel: type: object required: - type additionalProperties: false properties: type: type: string enum: - email - linkedin - whatsapp - phone description: >- The channel type of the step: `email` on an email step, `linkedin` on a LinkedIn step, `whatsapp` on a WhatsApp step, `phone` on an SMS step. id: type: string description: >- The account to send from: the mailbox id, the WhatsApp account id, or the phone number. On LinkedIn, the user id. Without `id`, the first healthy account of the type. alias: type: string description: >- Email only, with an `id`: the alias address of the mailbox to send from. description: The forced sender of a step. SenderPoolChange: type: object description: >- The channel types that a step change enables or disables in the sender pool. A type can be in both lists when one account of the type enters the pool and another leaves it. It does not tell whether each sender has an account of the type: read the diagnostics with Get Campaign Senders. properties: enabledChannelTypes: type: array description: >- The channel types with an account that enters the pool, in alphabetical order items: type: string enum: - email - linkedin - whatsapp - phone disabledChannelTypes: type: array description: >- The channel types with an account that leaves the pool, in alphabetical order items: type: string enum: - email - linkedin - whatsapp - phone securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.