CampaignsVersion: v3New

Create Email Campaign

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

Create a new email campaign

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

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

Body

application/json

namestringrequired

Campaign name

Example:Untitled campaign name

editorTypestringrequired

Editor type for the campaign content. Use html for code-editor campaigns or text for plain-text campaigns.

Available optionshtmltext

Example:html

templateIdstring

Existing template ID to create the campaign from. Omit this field to create a blank campaign.

Example:507f1f77bcf86cd799439011

editorContentstring

Optional initial editor content to persist immediately after campaign creation. Provide HTML or plain-text string content.

Example:<html><body>Hello World</body></html>

parentFolderIdstring

Parent folder ID

Example:67f15c2ae99226d5bcccb8f0

timeZonestringrequired

Timezone for the campaign

Example:Asia/Kolkata

userIdstringrequired

ID of the user performing this action

Example:507f1f77bcf86cd799439099

userNamestring

Name of the user performing this action

Example:John Doe

Response

application/json

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

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

traceIdstring

Trace ID of request

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