Create Email Campaign
POST/emails/locations/:locationId/campaigns/emails
Create a new email campaign
Request
API Version
v3Location ID
- application/json
- Body
- Example (auto)
Bodyrequired
Campaign name
Editor type for the campaign content. Use html for code-editor campaigns or text for plain-text campaigns.
htmltextExisting template ID to create the campaign from. Omit this field to create a blank campaign.
Optional initial editor content to persist immediately after campaign creation. Provide HTML or plain-text string content.
Parent folder ID
Timezone for the campaign
ID of the user performing this action
Name of the user performing this action
{
"name": "Untitled campaign name",
"editorType": "html",
"templateId": "507f1f77bcf86cd799439011",
"editorContent": "<html><body>Hello World</body></html>",
"parentFolderId": "67f15c2ae99226d5bcccb8f0",
"timeZone": "Asia/Kolkata",
"userId": "507f1f77bcf86cd799439099",
"userName": "John Doe"
}
Success
- application/json
- Schema
- Example (auto)
Schema
Campaign ID
Source of the campaign
Source ID of the campaign
Campaign name
Campaign status
allsentfailedarchiveddraftprocessingscheduledcancelledpausedCampaign type
Campaign category
AB test variation identifiers (available only for AB test campaigns)
Whether the campaign is deleted
Created at timestamp
Last updated timestamp
Trace ID of request
{
"id": "67f15c2ae99226d5bcccb8f3",
"source": "email-campaign",
"sourceId": "bulkRequest_abc123",
"name": "February Newsletter",
"status": "sent",
"campaignType": "bulk-email",
"campaignCategory": "email-campaign",
"variations": [
{
"sourceId": "9MhVcU7dTdLI7XOU1Vdt",
"isWinner": true
}
],
"deleted": false,
"createdAt": "2025-07-24T11:55:43.598Z",
"updatedAt": "2026-02-09T04:49:12.322Z",
"traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}