> ## 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.
> Duplicates an existing campaign with all its sequences, schedules, and templates.
# Duplicate 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.
;
};
Creates a full copy of the campaign including its sequence steps, schedules, and AI variable templates. CRM settings are not duplicated. The duplicated campaign is created in draft state with all lead counts reset to zero.
You can optionally provide a custom `name` in the request body. If omitted, the duplicated campaign will be named `"{original name} Copy"`.
## OpenAPI
````yaml post /campaigns/{campaignId}/duplicate
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}/duplicate:
parameters:
- name: campaignId
in: path
required: true
description: The unique identifier of the campaign to duplicate
example: cam_A1B2C3D4E5F6G7H8I9
schema:
type: string
post:
tags:
- Campaigns
summary: Duplicate Campaign
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: >-
Custom name for the duplicated campaign. If not provided,
the original name with ' Copy' suffix is used.
example:
name: My duplicated campaign
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
description: Success
content:
application/json:
schema:
type: object
properties:
_id:
type: string
name:
type: string
sequenceId:
type: string
archived:
type: boolean
labels:
type: array
items:
type: string
createdAt:
type: string
format: date-time
createdBy:
type: string
status:
type: string
senders:
type: array
items: {}
hasError:
type: boolean
errors:
type: array
items:
type: string
example:
_id: cam_X1Y2Z3A4B5C6D7E8F9
name: My duplicated campaign
sequenceId: seq_A1B2C3D4E5F6G7H8I9
labels: []
createdAt: '2024-01-15T10:30:00.000Z'
createdBy: usr_A1B2C3D4E5F6G7H8I9
status: draft
senders: []
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Bad team
'401':
description: Unauthorized
'404':
description: Campaign not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Campaign not found
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````