> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Create Campaign

- Component: `appmixer.woodpecker.core.CreateCampaign`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.woodpecker 1.1.2](https://connectors.appmixer.com/connector/appmixer.woodpecker/1.1.2.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.woodpecker/1.1.2/component/appmixer.woodpecker.core.CreateCampaign>

Create a new email campaign (one email step; delivery on workdays 8:00-18:00). Requires a connected email account (mailbox) in Woodpecker.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Name (`name`) | text | Campaign name. |
| Email Account ID (`emailAccountId`) | number | ID of a connected Woodpecker email account (mailbox) the campaign sends from. Use the List Mailboxes component to find it. |
| Subject (`subject`) | text | Subject of the first campaign email. |
| Message (`message`) | textarea | HTML body of the first campaign email, e.g. Hi {{FIRST_NAME}} . |
| Timezone (`timezone`) | text | Sending timezone (regional ID, e.g. Europe/Prague). Defaults to Europe/London. |
| Daily Enroll Limit (`dailyEnroll`) | number | Maximum number of prospects enrolled per day. Defaults to 20. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Campaign ID (`id`) | integer | - |
| Name (`name`) | string | - |
| Status (`status`) | string | - |
| Created (`created`) | string | - |
| From Name (`from_name`) | string | - |
| Timezone (`timezone`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.woodpecker.core.CreateCampaign",
  "label": "Create Campaign",
  "description": "Create a new email campaign (one email step; delivery on workdays 8:00-18:00). Requires a connected email account (mailbox) in Woodpecker.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:woodpecker"
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "emailAccountId": {
            "type": [
              "integer",
              "string"
            ]
          },
          "subject": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "dailyEnroll": {
            "type": "integer"
          }
        },
        "required": [
          "name",
          "emailAccountId",
          "subject",
          "message"
        ]
      },
      "inspector": {
        "inputs": {
          "name": {
            "type": "text",
            "label": "Name",
            "index": 1,
            "tooltip": "Campaign name."
          },
          "emailAccountId": {
            "type": "number",
            "label": "Email Account ID",
            "index": 2,
            "tooltip": "ID of a connected Woodpecker email account (mailbox) the campaign sends from. Use the List Mailboxes component to find it."
          },
          "subject": {
            "type": "text",
            "label": "Subject",
            "index": 3,
            "tooltip": "Subject of the first campaign email."
          },
          "message": {
            "type": "textarea",
            "label": "Message",
            "index": 4,
            "tooltip": "HTML body of the first campaign email, e.g. <div>Hi {{FIRST_NAME}}</div>."
          },
          "timezone": {
            "type": "text",
            "label": "Timezone",
            "index": 5,
            "tooltip": "Sending timezone (regional ID, e.g. Europe/Prague). Defaults to Europe/London."
          },
          "dailyEnroll": {
            "type": "number",
            "label": "Daily Enroll Limit",
            "index": 6,
            "tooltip": "Maximum number of prospects enrolled per day. Defaults to 20."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "title": "Campaign ID",
            "example": 12345
          },
          "name": {
            "type": "string",
            "title": "Name",
            "example": "Q1 Outreach"
          },
          "status": {
            "type": "string",
            "title": "Status",
            "example": "RUNNING"
          },
          "created": {
            "type": "string",
            "title": "Created",
            "example": "2025-01-15T10:30:00Z"
          },
          "from_name": {
            "type": "string",
            "title": "From Name",
            "example": "Jane Doe"
          },
          "timezone": {
            "type": "string",
            "title": "Timezone",
            "example": "America/New_York"
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
