> ## 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.
> Updates the settings and configuration of an existing campaign.
# Update 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.
;
};
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`).
## OpenAPI
````yaml patch /campaigns/{campaignId}
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/{campaignId}:
parameters:
- name: campaignId
in: path
required: true
description: The unique identifier of the campaign
example: cam_A1B2C3D4E5F6G7H8I9
schema:
type: string
patch:
tags:
- Campaigns
summary: Update Campaign
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The campaign name
stopOnEmailReplied:
type: boolean
description: Stop the campaign when a lead replies by email
stopOnMeetingBooked:
type: boolean
description: Stop the campaign when a meeting is booked
stopOnLinkClicked:
type: boolean
description: Stop the campaign when a link is clicked
leadsPausedByInterest:
type: boolean
description: Pause leads based on interest
opportunityReplied:
type: boolean
description: Create an opportunity when a lead replies
opportunityClicked:
type: boolean
description: Create an opportunity when a lead clicks a link
autoLeadInterest:
type: boolean
description: Automatically detect lead interest
disableTrackOpen:
type: boolean
description: Disable tracking of email opens
disableTrackClick:
type: boolean
description: Disable tracking of link clicks
disableTrackReply:
type: boolean
description: Disable tracking of email replies
disableOutOfOffice:
type: boolean
description: Disable out-of-office detection
sequenceSharing:
type: boolean
description: Enable sequence sharing for the campaign
stopOnLinkClickedFilter:
type: string
description: Filter for which link clicks should stop the campaign
sendUserIds:
type: array
items:
type: string
description: >-
Array of user IDs (usr_xxx format) to assign as campaign
senders. Cannot be used on campaigns with a dynamic sender
strategy (contactOwner, leadImporter, customField). Each
sender is validated against the campaign's sending channels
(email, LinkedIn, SMS, WhatsApp): senders without
capabilities for at least one channel are excluded, and all
channels must be covered by at least one sender.
autoReview:
type: boolean
description: >-
Automatically launch (review) leads as soon as they are
added to the campaign, instead of requiring manual review.
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.
example:
name: New campaign name
stopOnEmailReplied: true
stopOnMeetingBooked: true
stopOnLinkClicked: false
leadsPausedByInterest: false
opportunityReplied: true
opportunityClicked: false
autoLeadInterest: true
disableTrackOpen: false
disableTrackClick: false
disableTrackReply: false
disableOutOfOffice: false
sequenceSharing: false
sendUserIds:
- usr_2aBCdEfGHiJkLmNOp
- usr_7xYzAbCdEfGhIjKlM
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:
name:
type: string
description: The campaign name
stopOnEmailReplied:
type: boolean
description: Stop the campaign when a lead replies by email
stopOnMeetingBooked:
type: boolean
description: Stop the campaign when a meeting is booked
stopOnLinkClicked:
type: boolean
description: Stop the campaign when a link is clicked
leadsPausedByInterest:
type: boolean
description: Pause leads based on interest
opportunityReplied:
type: boolean
description: Create an opportunity when a lead replies
opportunityClicked:
type: boolean
description: Create an opportunity when a lead clicks a link
autoLeadInterest:
type: boolean
description: Automatically detect lead interest
disableTrackOpen:
type: boolean
description: Disable tracking of email opens
disableTrackClick:
type: boolean
description: Disable tracking of link clicks
disableTrackReply:
type: boolean
description: Disable tracking of email replies
disableOutOfOffice:
type: boolean
description: Disable out-of-office detection
sequenceSharing:
type: boolean
description: Enable sequence sharing for the campaign
stopOnLinkClickedFilter:
type: string
description: Filter for which link clicks should stop the campaign
sendUsers:
type: array
description: >-
Configured senders for the campaign. Only present when
sendUserIds was provided in the request. Senders that lack
capabilities for any campaign sending channel are
excluded.
items:
type: object
properties:
id:
type: string
description: User ID of the sender
mailboxes:
type: array
description: Connected email mailboxes
items:
type: object
properties:
sendUserMailboxId:
type: string
email:
type: string
phoneNumbers:
type: array
description: Connected phone numbers
items:
type: string
whatsappAccountIds:
type: array
description: Connected WhatsApp account IDs
items:
type: string
example:
name: New campaign name
stopOnEmailReplied: true
stopOnMeetingBooked: true
stopOnLinkClicked: false
leadsPausedByInterest: false
opportunityReplied: true
opportunityClicked: false
autoLeadInterest: true
disableTrackOpen: false
disableTrackClick: false
disableTrackReply: false
disableOutOfOffice: false
sequenceSharing: false
sendUsers:
- id: usr_2aBCdEfGHiJkLmNOp
mailboxes:
- sendUserMailboxId: smb_1aBcDeFgHiJkLmNoP
email: john@acme.com
phoneNumbers:
- '+15551234567'
whatsappAccountIds:
- wha_3xYzAbCdEfGhIjKlM
- id: usr_7xYzAbCdEfGhIjKlM
mailboxes:
- sendUserMailboxId: smb_9zYxWvUtSrQpOnMlK
email: jane@acme.com
phoneNumbers: []
whatsappAccountIds: []
'400':
description: Bad request
content:
text/plain:
schema:
type: string
examples:
badTeam:
summary: Bad team
value: Bad team
dynamicStrategy:
summary: Cannot update senders for dynamic strategy campaigns
value: >-
Cannot update senders on campaigns with a dynamic sender
strategy (contactOwner, leadImporter, customField)
noValidSenders:
summary: No valid sender IDs
value: None of the provided sender IDs are members of this team
noCapableSenders:
summary: No senders with required capabilities
value: >-
None of the provided senders have the required capabilities
for this campaign
missingChannels:
summary: Campaign channels not covered
value: >-
The provided senders do not cover the following campaign
channels: linkedin, sms
'401':
description: Unauthorized
'404':
description: Campaign not found
content:
text/plain:
example: Campaign not found
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````