> ## 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.
## 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` |
The `images` and `videos` fields are ignored when `type` is not `linkedin`. Ingestion errors return the same `LINKEDIN_MEDIA_*` codes documented on [Add Step to Sequence](/api-reference/endpoints/sequences/add-step-to-sequence#linkedin-media-constraints).
## 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: []
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: >-
The ID of the contact company or lead associated with the
task.
type:
type: string
description: The type of task.
enum:
- email
- manual
- phone
- linkedin
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).
title:
type: string
description: >-
Optional title of the task. Defaults to an empty string if
omitted.
default: ''
message:
type: string
description: >-
Optional message/description of the task. Defaults to an
empty string if omitted.
default: ''
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. Ignored when
`type` is not `linkedin`. 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. Ignored when
`type` is not `linkedin`. Allowed MIME types: `video/mp4`,
`video/quicktime`. Up to 20 MB per file, and up to 6 items
total combined with `images`.
required:
- leadId
- type
- assignedTo
- dueDate
example:
type: phone
assignedTo: usr_7YzNqVRMCfdeHEzMn
dueDate: '2025-02-10T09:58:57.169Z'
message: this is my message
title: this is my title
leadId: lea_zUwSUPSxozD9fLVGw
responses:
'200':
description: Success
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: 'Possible errors: Bad team / Bad method'
content:
text/plain:
example: Bad team
'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.
properties:
_id:
type: string
description: Unique task identifier
type:
type: string
description: Task type
leadId:
type: string
description: Associated lead ID
campaignId:
type: string
description: Campaign ID
userId:
type: string
description: Assigned user ID
status:
type: string
description: Task status
enum:
- pending
- completed
- ignored
dueDate:
type: string
format: date-time
description: Due date timestamp
createdAt:
type: string
format: date-time
description: Creation timestamp
completedAt:
type: string
format: date-time
description: Completion timestamp
securitySchemes:
basicAuth:
type: http
scheme: basic
````