Skip to main content
CampaignsVersion: v3New

Duplicate Email Campaign

POST/emails/locations/{locationId}/campaigns/emails/{campaignId}/duplicate

Clone this campaign and its content into a new draft. The copy is not scheduled. Omit name to keep the source name.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:emails/campaigns.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Idempotency-Keystring

Unique key per intended write (max 255 chars). Retrying with the same key and body within 24 hours returns the first response instead of creating another resource. Reusing the key with a different body returns 422; a retry while the first request is still running returns 409.

Example:0f8fad5b-d9cb-469f-a165-70867728950e
Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3

Body

namestring

Name for the new copy. Omit to keep the source name. Must not be empty when provided.

Example:Christmas 2026 (copy)
userIdstring

Optional user ID recorded as the creator of the copy. Does not affect authorization.

Example:ve9EPM428h8vShlRW1KT

Response

Success

idstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3
sourcestring

Source of the campaign

Example:email-campaign
sourceIdstring

Source ID of the campaign

Example:bulkRequest_abc123
namestring

Campaign name

Example:February Newsletter
statusstring

Campaign status. Status lifecycle: draft (created, editable) → Schedule Campaign → scheduled (waiting for sendAt or the next batch) → processing (sending) → sent. RSS campaigns have no scheduled state: while active, including between feed checks, they report processing or the status of their latest send. failed = sending errored. Pause Email Campaign: scheduled/processing → paused; Resume Email Campaign: paused → processing. Cancel Email Campaign: scheduled/processing/paused → cancelled. draft, paused and cancelled campaigns can be (re)scheduled with Schedule Campaign. archived = archived campaign (any underlying status).

Available optionsallsentfailedarchiveddraftprocessingscheduledcancelledpaused
Example:sent
campaignTypestring

Campaign type

Example:bulk-email
campaignCategorystring

Campaign category

Example:email-campaign
variationsobject[]

AB test variation identifiers (available only for AB test campaigns)

deletedbooleanrequired

Whether the campaign is deleted

Example:false
createdAtstringrequired

Created at timestamp

Example:2025-07-24T11:55:43.598Z
updatedAtstringrequired

Last updated timestamp

Example:2026-02-09T04:49:12.322Z
editorContentUrlstring

URL of the rendered campaign HTML after this write. Issue a GET against it to see the result; a new URL is issued on every content save.

Example:https://firebasestorage.googleapis.com/v0/b/bucket/o/index.html?alt=media&token=abc
traceIdstring

Trace ID of request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4