# Create Email Campaign

POST https://services.leadconnectorhq.com/emails/locations/{locationId}/campaigns/emails

Create a new email campaign

## Authentication

Send `Authorization: Bearer <token>` using:

- **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `emails/campaigns.write`

## Parameters

### Header Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `Version` | string | Yes | API Version |

### Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `locationId` | string | Yes | Location ID |

## OpenAPI Specification

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LeadConnector API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://services.leadconnectorhq.com"
    }
  ],
  "paths": {
    "/emails/locations/{locationId}/campaigns/emails": {
      "post": {
        "summary": "Create Email Campaign",
        "operationId": "createEmailCampaign",
        "description": "Create a new email campaign",
        "parameters": [
          {
            "name": "locationId",
            "required": true,
            "in": "path",
            "description": "Location ID",
            "schema": {
              "example": "ve9EPM428h8vShlRW1KT",
              "type": "string"
            }
          },
          {
            "name": "Version",
            "in": "header",
            "description": "API Version",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "v3"
              ]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateEmailCampaignPublicV2BodyDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateEmailCampaignPublicV2ResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestDTO"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedDTO"
                }
              }
            }
          },
          "403": {
            "description": "The token does not have access to this location",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidLocationDTO"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundDTO"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnprocessableDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "Location-Access": [
              "emails/campaigns.write"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account.",
        "type": "http"
      },
      "Agency-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.",
        "type": "http"
      },
      "Agency-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency.",
        "type": "http"
      }
    },
    "schemas": {
      "CreateEmailCampaignPublicV2BodyDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Campaign name",
            "example": "Untitled campaign name"
          },
          "editorType": {
            "type": "string",
            "description": "Editor type for the campaign content. Use `html` for code-editor campaigns or `text` for plain-text campaigns.",
            "enum": [
              "html",
              "text"
            ],
            "example": "html"
          },
          "templateId": {
            "type": "string",
            "description": "Existing template ID to create the campaign from. Omit this field to create a blank campaign.",
            "example": "507f1f77bcf86cd799439011"
          },
          "editorContent": {
            "type": "string",
            "description": "Optional initial editor content to persist immediately after campaign creation. Provide HTML or plain-text string content.",
            "example": "<html><body>Hello World</body></html>"
          },
          "parentFolderId": {
            "type": "string",
            "description": "Parent folder ID",
            "example": "67f15c2ae99226d5bcccb8f0"
          },
          "timeZone": {
            "type": "string",
            "description": "Timezone for the campaign",
            "example": "Asia/Kolkata"
          },
          "userId": {
            "type": "string",
            "description": "ID of the user performing this action",
            "example": "507f1f77bcf86cd799439099"
          },
          "userName": {
            "type": "string",
            "description": "Name of the user performing this action",
            "example": "John Doe"
          }
        },
        "required": [
          "name",
          "editorType",
          "timeZone",
          "userId"
        ],
        "title": "CreateEmailCampaignPublicV2BodyDto"
      },
      "CreateEmailCampaignPublicV2ResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Campaign ID",
            "example": "67f15c2ae99226d5bcccb8f3"
          },
          "source": {
            "type": "string",
            "description": "Source of the campaign",
            "example": "email-campaign"
          },
          "sourceId": {
            "type": "string",
            "description": "Source ID of the campaign",
            "example": "bulkRequest_abc123"
          },
          "name": {
            "type": "string",
            "description": "Campaign name",
            "example": "February Newsletter"
          },
          "status": {
            "type": "string",
            "description": "Campaign status",
            "example": "sent",
            "enum": [
              "all",
              "sent",
              "failed",
              "archived",
              "draft",
              "processing",
              "scheduled",
              "cancelled",
              "paused"
            ]
          },
          "campaignType": {
            "type": "string",
            "description": "Campaign type",
            "example": "bulk-email"
          },
          "campaignCategory": {
            "type": "string",
            "description": "Campaign category",
            "example": "email-campaign"
          },
          "variations": {
            "description": "AB test variation identifiers (available only for AB test campaigns)",
            "example": [
              {
                "sourceId": "9MhVcU7dTdLI7XOU1Vdt",
                "isWinner": true
              }
            ],
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sourceId": {
                  "type": "string",
                  "description": "Variation source ID for stats lookup",
                  "example": "9MhVcU7dTdLI7XOU1Vdt"
                },
                "isWinner": {
                  "type": "boolean",
                  "description": "Whether this is the winning variation",
                  "example": true
                }
              },
              "required": [
                "sourceId",
                "isWinner"
              ],
              "title": "EmailCampaignVariationPublicV2Dto"
            }
          },
          "deleted": {
            "type": "boolean",
            "description": "Whether the campaign is deleted",
            "example": false
          },
          "createdAt": {
            "type": "string",
            "description": "Created at timestamp",
            "example": "2025-07-24T11:55:43.598Z"
          },
          "updatedAt": {
            "type": "string",
            "description": "Last updated timestamp",
            "example": "2026-02-09T04:49:12.322Z"
          },
          "traceId": {
            "type": "string",
            "description": "Trace ID of request",
            "example": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
          }
        },
        "required": [
          "id",
          "deleted",
          "createdAt",
          "updatedAt"
        ],
        "title": "CreateEmailCampaignPublicV2ResponseDto"
      },
      "BadRequestDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 400
          },
          "message": {
            "type": "string",
            "example": "Bad Request"
          }
        },
        "title": "BadRequestDTO"
      },
      "UnauthorizedDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 401
          },
          "message": {
            "type": "string",
            "example": "Invalid token: access token is invalid"
          },
          "error": {
            "type": "string",
            "example": "Unauthorized"
          }
        },
        "title": "UnauthorizedDTO"
      },
      "InvalidLocationDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "description": "HTTP status code for invalid location access",
            "example": 403
          },
          "message": {
            "type": "string",
            "description": "Error message describing the location access failure",
            "example": "The token does not have access to this location"
          }
        },
        "title": "InvalidLocationDTO"
      },
      "NotFoundDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "description": "HTTP status code for not found",
            "example": 404
          },
          "message": {
            "type": "string",
            "description": "Error message describing the not found failure",
            "example": "Not Found"
          },
          "error": {
            "type": "string",
            "description": "Error type identifier",
            "example": "The requested resource was not found"
          }
        },
        "title": "NotFoundDTO"
      },
      "UnprocessableDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 422
          },
          "message": {
            "example": [
              "Unprocessable Entity"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "error": {
            "type": "string",
            "example": "Unprocessable Entity"
          }
        },
        "title": "UnprocessableDTO"
      }
    }
  }
}
```

## Code Examples

**cURL**

```bash
curl -L -X POST 'https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Version: v3' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "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"
}'
```

**Node.js**

```javascript
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <TOKEN>',
    Version: 'v3',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "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"
  })
};

try {
  const response = await fetch('https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails', options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

**Python**

```python
import requests

url = "https://services.leadconnectorhq.com/emails/locations/{locationId}/campaigns/emails"

headers = {
    "Authorization": "Bearer <TOKEN>",
    "Version": "v3"
}

payload = {
    "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"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())
```

**PHP**

```php
<?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Version: v3',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "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"
}',
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

**Java**

```java
HttpResponse<String> response = Unirest
  .post("https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails")
  .header("Authorization", "Bearer <TOKEN>")
  .header("Version", "v3")
  .header("Content-Type", "application/json")
  .body("{\"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\"}")
  .asString();
```

**Go**

```go
package main

import (
  "fmt"
  "net/http"
  "io"
  "strings"
)

func main() {
  url := "https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails"
  payload := strings.NewReader(`{
  "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"
}`)
  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Authorization", "Bearer <TOKEN>")
  req.Header.Add("Version", "v3")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}
```

**Ruby**

```ruby
require 'uri'
require 'net/http'

url = URI("https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <TOKEN>"
request["Version"] = "v3"
request["Content-Type"] = "application/json"
request.body = '{
  "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"
}'

response = http.request(request)
puts response.read_body
```

**PowerShell**

```powershell
$headers = @{
  "Authorization" = "Bearer <TOKEN>"
  "Version" = "v3"
}

$body = '{
  "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"
}'

$response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/emails/locations/<locationId>/campaigns/emails' -Method 'POST' -Headers $headers -Body $body -ContentType 'application/json'
$response | ConvertTo-Json
```