> ## 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. # Create Task > Create a manual task (opportunity) associated with a contact/company or lead. export const SnippetObjectReference = ({objectName, objectPath = null}) => { const lowerCaseObjectName = objectName.toLowerCase(); if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') { return This endpoint uses the {objectName} object. Make sure to also check the {lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object to understand the distinction between the two. ; } return This endpoint uses the {objectName} object. ; }; Create a manual task (opportunity) associated with a contact/company or lead. The task must be assigned to a team member and have a due date. Optional fields let you set a title, message, and priority. ## Draft of message tasks On `email`, `linkedin` and `whatsapp` tasks, lemlist also creates the draft of the message to send. Set its body with `taskData.content` and, on an `email` task, its subject with `taskData.subject`. `message` is the task instruction. ## LinkedIn task attachments When creating a task with `type: "linkedin"`, you can attach images and videos to the LinkedIn message by passing public HTTPS URLs in the `images` and `videos` arrays. lemlist downloads each file and re-hosts it before attaching it to the task. | Constraint | Value | | - | - | | Maximum items per task | 6 (combined across `images` + `videos`) | | Maximum file size | 20 MB per file | | Allowed image MIME types | `image/png`, `image/jpeg`, `image/gif` | | Allowed video MIME types | `video/mp4`, `video/quicktime` | On other types, `images` and `videos` are not downloaded, but they are still validated and count toward the limit of 6. Ingestion errors return the same `LINKEDIN_MEDIA_*` codes and HTTP statuses as [Add Step to Sequence](/api-reference/endpoints/sequences/add-step-to-sequence#linkedin-media-constraints), with `error` holding a JSON-encoded array of `{ url, index, code, message }` items. ## OpenAPI ````yaml post /tasks 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: /tasks: post: tags: - Tasks summary: Create Task description: >- Create a manual task (opportunity) associated with a contact/company or lead. parameters: [] requestBody: content: application/json: schema: type: object properties: recordId: type: string description: >- ID of the record the task is about: a contact (`ctc_`), a company (`cpn_`) or a lead (`lea_`). Required unless the legacy `leadId` is sent. A company task can only be of type `manual`. leadId: type: string deprecated: true description: >- Legacy name of `recordId`, still accepted for backward compatibility. Use `recordId` instead. When both are sent, `leadId` is used. type: type: string description: The type of task. enum: - email - manual - phone - linkedin - whatsapp assignedTo: type: string description: The ID of the team member assigned to the task (userId). dueDate: type: string format: date-time description: >- The due date in ISO 8601 format (e.g., 2025-02-12T00:00:00.000Z). A date in the past is accepted: the task is created already due. title: type: string description: >- Optional title of the task. Defaults to an empty string if omitted. maxLength: 400 default: '' message: type: string description: >- Optional instruction of the task, returned as `content` in the response. Defaults to an empty string if omitted. On a `linkedin` task for a lead (`lea_` ID), it also pre-fills the draft when `taskData.content` is omitted. maxLength: 32000 default: '' taskData: type: object description: >- Draft of the message to send on `email`, `linkedin` and `whatsapp` tasks, and fallback number on `phone` tasks. properties: subject: type: string maxLength: 400 description: >- Subject of the email. Only used on `email` tasks, ignored on other types. content: type: string description: >- Draft of the message to send. Only used on `email`, `linkedin` and `whatsapp` tasks, ignored on other types. Must stay under 1 MB, measured in bytes once UTF-8 encoded (1,000,000 bytes). phone: type: string description: >- On a `phone` task, number the lemlist dialer offers when neither the contact nor the lead has one. Ignored on other types. priority: type: string description: Priority level of the task. enum: - '' - '0' - '1' - '2' default: '' images: type: array items: type: string format: uri description: >- Public HTTPS URLs of images to attach to a `linkedin` task. lemlist downloads each file and re-hosts it. On other types they are not downloaded, but still count toward the limit of 6. Allowed MIME types: `image/png`, `image/jpeg`, `image/gif`. Up to 20 MB per file, and up to 6 items total combined with `videos`. videos: type: array items: type: string format: uri description: >- Public HTTPS URLs of videos to attach to a `linkedin` task. lemlist downloads each file and re-hosts it. On other types they are not downloaded, but still count toward the limit of 6. Allowed MIME types: `video/mp4`, `video/quicktime`. Up to 20 MB per file, and up to 6 items total combined with `images`. required: - type - assignedTo - dueDate anyOf: - title: recordId required: - recordId - title: leadId (legacy) required: - leadId example: recordId: ctc_ZpFy8SXl51PsctTGf type: phone assignedTo: usr_6nVZY7je1zSBXZgZK dueDate: '2025-02-10T09:58:57.169Z' title: Call to follow up on the demo message: Ask whether the team had time to review the proposal. responses: '200': description: >- The created task. The `message` you sent is returned as `content` and `assignedTo` as `userId`. A `linkedin` or `whatsapp` task comes back with its internal type, `linkedinSend` or `whatsappMessage`. `priority` comes back as a number (`0`, `1` or `2`) and is omitted when empty. content: application/json: schema: $ref: '#/components/schemas/Task' example: _id: opp_LyXDV8KHzctQdLFpG type: manual title: Keep an eye on him priority: 1 leadId: lea_fiDpiGV585wy3Oii2 campaignId: cam_bSn8EORHQxbWPjHvu contactId: ctc_xW8Ou6C03Csv8vatp dueDate: '2025-11-10T09:58:57.169Z' userId: usr_ahfFktBBHUIxbVG5P content: does he have bandwidth to help us? would be grand '400': description: >- The body is `{ "error": "" }`, where the message is one of: - `One of your fields is invalid or missing` - `type`, `dueDate` or `assignedTo` is missing or invalid (`assignedTo` must be a user ID), `priority` is not one of the accepted values, `title` or `message` is not a string, `images` / `videos` is not an array of strings, `taskData` is not an object, or `recordId` / `leadId` is not a well-formed ID. - `recordId is required` - neither `recordId` nor `leadId` was sent. - `recordId is invalid` - the ID does not start with `ctc_`, `cpn_` or `lea_`. - A message starting with `Match error:` - `title` is longer than 400 characters, `message` is longer than 32,000 characters, `taskData.subject` is not a string or is longer than 400 characters on an `email` task, `taskData.content` is not a string on an `email`, `linkedin` or `whatsapp` task, `taskData.phone` is not a string, or a company task is not of type `manual`. - `No contact, company or lead found for this id in the team` - the record does not exist in your team. - `The assignee is not a member of the team` - `assignedTo` is not a member of your team. - `The message content is too big (max 1 MB)` - `taskData.content` reaches 1,000,000 bytes once UTF-8 encoded, on an `email`, `linkedin` or `whatsapp` task. - `dueDate must be a valid future ISO 8601 date` - `dueDate` is exactly the Unix epoch (`1970-01-01T00:00:00.000Z`). Other past dates are accepted. - `LINKEDIN_MEDIA_TOO_MANY` - more than 6 `images` and `videos` combined, whatever the task `type`. - On a `linkedin` task, a media URL that fails ingestion sets `error` to a JSON-encoded array of items, each with a `url`, `index`, `code` and `message`. The status follows the first item's code: 400 for `LINKEDIN_MEDIA_UNSAFE_URL`, the other codes answer with the statuses listed on [Add Step to Sequence](/api-reference/endpoints/sequences/add-step-to-sequence#linkedin-media-constraints). When no API key is supplied, the answer is the plain text `no api key provided`. content: application/json: example: error: recordId is required text/plain: example: no api key provided '401': description: The authentication you supplied is incorrect content: text/plain: example: The authentication you supplied is incorrect '405': description: Method not allowed components: schemas: Task: type: object description: >- A manual action assigned to a user to complete. Only the fields set on the task are returned. properties: _id: type: string description: Unique task identifier type: type: string description: >- Task type as stored, never `null`. Tasks created through the API use `email`, `manual`, `phone`, `linkedinSend` or `whatsappMessage`. Campaign tasks carry the type of their step (for example `linkedinInvite`, `whatsappVoiceNote` or `sms`), and reply and click tasks use `opportunityReplied` and `opportunityClicked`. title: type: string description: Task title content: type: string description: >- Task instruction, sent as `message` when the task is created or updated. text: type: string description: >- Text of the lead's LinkedIn reply, when it has one, on `opportunityReplied` tasks. priority: type: integer enum: - 0 - 1 - 2 description: '`0` low, `1` medium, `2` high. Absent when the task has no priority.' dueDate: type: string format: date-time description: Due date. Tasks carry no creation date. userId: type: string description: ID of the assigned user, sent as `assignedTo`. leadId: type: string description: Associated lead ID contactId: type: string description: Associated contact ID campaignId: type: string description: Campaign ID. A task on a lead carries the campaign of that lead. sequenceId: type: string description: Sequence ID leadFirstName: type: string description: First name of the lead or contact leadLastName: type: string description: Last name of the lead or contact leadCompanyName: type: string description: >- Company name of the lead or contact. On a company task, the name (or domain) of the company, the only field that identifies it: the response carries no `companyId`. manual: type: boolean description: >- `true` on tasks created by hand in lemlist or through the API, on campaign tasks whose step has its manual option on, and on out-of-office tasks. Absent otherwise, never `false`. securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.