> ## 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.
> Creates a new campaign with auto-generated sequence and schedule.
# Create Campaign
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.
;
};
When you create a new campaign, an empty sequence and default schedule are automatically added. You can specify a name, or one will be assigned by default.
You can optionally set a `timezone` (IANA format, e.g. `America/New_York`) to control the campaign schedule's timezone. If omitted, it defaults to `Europe/Paris`.
Set `autoReview` to `true` to automatically launch leads as soon as they are added to the campaign, skipping manual review. Use `autoReviewConditions` to restrict auto-launch to leads whose email verification matches one of the given deliverability statuses (`deliverable`, `risky`, `undeliverable`, `unverified`). Passing an invalid status returns a `400` error.
The returned data includes the campaign, sequence, and schedule IDs, which you can use later to update campaign settings, add sequence steps, or modify the schedule.
## OpenAPI
````yaml post /campaigns
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:
/campaigns:
post:
tags:
- Campaigns
summary: Create Campaign
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the campaign
timezone:
type: string
description: >-
IANA timezone for the campaign schedule (e.g.
`America/New_York`). Defaults to `Europe/Paris` if omitted.
autoReview:
type: boolean
description: >-
Automatically launch (review) leads as soon as they are
added to the campaign, instead of requiring manual review.
Defaults to `false`.
autoReviewConditions:
type: array
items:
type: string
enum:
- deliverable
- risky
- undeliverable
- unverified
description: >-
Email deliverability statuses for which a lead is
auto-launched when `autoReview` is enabled. Only leads whose
email verification matches one of these statuses are
launched automatically. Invalid values are rejected with a
`400` error.
required:
- name
example:
name: My new campaign
timezone: America/New_York
autoReview: true
autoReviewConditions:
- deliverable
- risky
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
description: Success
content:
application/json:
schema:
type: object
properties:
_id:
type: string
sequenceId:
type: string
scheduleIds:
type: array
items:
type: string
teamId:
type: string
createdBy:
type: string
createdAt:
type: string
format: date-time
state:
type: string
scannedCount:
type: integer
reviewedCount:
type: integer
inSequenceLeadCount:
type: integer
variableKeys:
type: array
items: {}
senders:
type: array
items: {}
sendUsers:
type: array
items: {}
displayedVariableKeys:
type: array
items:
type: string
emoji:
type: string
stopOnEmailReplied:
type: boolean
crmOpportunitiesOnTask:
type: boolean
unsubscribe:
type: string
name:
type: string
crm:
type: string
crmUserId:
type: string
example:
_id: cam_kok3I33Sba7mcNIO7
sequenceId: seq_ScVmFnlKdP6aVmyZN
scheduleIds:
- skd_IrCdCoQ0ZUAEeUDwR
teamId: tea_edrkv2LgUK4Wf4ZzO
createdBy: usr_Sy3xIhbEi7auHFv5A
createdAt: '2025-01-16T13:53:22.726Z'
state: running
scannedCount: 0
reviewedCount: 0
inSequenceLeadCount: 0
variableKeys: []
senders: []
sendUsers: []
displayedVariableKeys:
- companyName
emoji: 🚀
stopOnEmailReplied: true
crmOpportunitiesOnTask: true
unsubscribe: campaign
name: My new campaign
crm: hubspot
crmUserId: usr_0p9Q8ZyXSTNGpsHOe
'400':
description: No API key provided
content:
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
'403':
description: User linked to this API key is blocked
content:
text/plain:
example: User linked to this API key is blocked
'404':
description: No user found for this API key
content:
text/plain:
example: No user found for this API key
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````