---
updatedAt: 2026-04-23T13:15:27.000Z
agentTools:
  projectIndex: https://api-docs.omnisend.com/llms.txt
---

# Create campaign

Create a new campaign draft.

**Boosters (`type: booster`):**
- The parent campaign (`boosterSettings.campaignID`) must be a regular email campaign in 'draft' or 'sent' status; 'scheduled' and 'started' parents return 409.
- Each parent campaign supports at most one booster; creating another returns 409. Delete the existing booster first to replace it.
- `sendingSettings` is only allowed when the parent is already sent; for a draft parent provide `boosterSettings.delay` instead (max 240 hours) and the booster is scheduled automatically when the parent sends.

**Scopes:**
`campaigns.write`

**Rate Limiting:**
This endpoint is rate limited to 400 requests per minute.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "contact": {},
    "description": "API for managing campaigns.",
    "title": "Campaigns API",
    "version": "2026-preview"
  },
  "paths": {
    "/campaigns": {
      "post": {
        "description": "Create a new campaign draft.\n\n**Boosters (`type: booster`):**\n- The parent campaign (`boosterSettings.campaignID`) must be a regular email campaign in 'draft' or 'sent' status; 'scheduled' and 'started' parents return 409.\n- Each parent campaign supports at most one booster; creating another returns 409. Delete the existing booster first to replace it.\n- `sendingSettings` is only allowed when the parent is already sent; for a draft parent provide `boosterSettings.delay` instead (max 240 hours) and the booster is scheduled automatically when the parent sends.\n\n**Scopes:**\n`campaigns.write`\n\n**Rate Limiting:**\nThis endpoint is rate limited to 400 requests per minute.",
        "parameters": [
          {
            "$ref": "#/components/parameters/APIVersionHeader"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCampaignRequest"
              }
            }
          },
          "description": "Campaign data",
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created campaign",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Campaign"
                }
              }
            }
          },
          "400": {
            "description": "Request contains invalid or missing fields",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblem"
                }
              }
            }
          },
          "401": {
            "description": "Authentication is missing or invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "403": {
            "description": "Insufficient permissions for this operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "404": {
            "description": "Booster only: parent campaign not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "409": {
            "description": "Booster only: booster already exists for this campaign, or parent campaign status does not allow booster operations",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "410": {
            "description": "API version has been retired",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "422": {
            "description": "Campaign channel is not supported, or the store has no verified sender email to use when content.email.senderEmail is omitted",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateLimitProblem"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected error occurred",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          }
        },
        "security": [
          {
            "Bearer": [
              "campaigns.write"
            ]
          },
          {
            "ApiKeyAuth": []
          }
        ],
        "summary": "Create campaign",
        "tags": [
          "Campaigns"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.omnisend.com/api"
    }
  ],
  "components": {
    "parameters": {
      "APIVersionHeader": {
        "description": "API version that specifies the response format and behaviour",
        "in": "header",
        "name": "Omnisend-Version",
        "required": true,
        "schema": {
          "type": "string",
          "default": "2026-03-15"
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "description": "API key authentication. Use format: Omnisend-API-Key {api-key}",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      },
      "Bearer": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://app.omnisend.com/oauth2/token",
            "scopes": {
              "campaigns.read": "Read access to campaigns",
              "campaigns.write": "Write access to campaigns"
            }
          }
        }
      }
    },
    "schemas": {
      "ABTest": {
        "description": "A/B test configuration. Variants are keyed by \"a\" and \"b\"; the parent campaign's `content` field is omitted because variants carry their own content. `result` is populated once a winner is selected and is `null` otherwise.",
        "properties": {
          "result": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestResult"
              }
            ],
            "description": "Winner information (read-only). Null until winner is selected."
          },
          "settings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestSettings"
              }
            ],
            "description": "Test configuration"
          },
          "variants": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestVariants"
              }
            ],
            "description": "Variants keyed by \"a\" and \"b\""
          }
        },
        "type": "object"
      },
      "ABTestDecisionTime": {
        "description": "Decision time before selecting a winner. Same shape as booster delay.",
        "properties": {
          "amount": {
            "description": "Amount of time units to wait",
            "example": 4,
            "type": "integer"
          },
          "unit": {
            "description": "Time unit: \"h\" for hours, \"d\" for days",
            "enum": [
              "h",
              "d"
            ],
            "example": "h",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ABTestResult": {
        "description": "A/B test result (read-only).",
        "properties": {
          "isManuallySelected": {
            "description": "Whether the winner was manually selected (read-only)",
            "example": false,
            "readOnly": true,
            "type": "boolean"
          },
          "selectedAt": {
            "description": "When the winner was selected (read-only)",
            "example": "2026-01-15T10:30:00Z",
            "readOnly": true,
            "type": "string"
          },
          "winnerVariantID": {
            "description": "Campaign ID of the winning variant (read-only). Matches variants.a.id or variants.b.id.",
            "example": "000000000000000000000011",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "ABTestSettings": {
        "description": "A/B test settings.",
        "properties": {
          "decisionTime": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestDecisionTime"
              }
            ],
            "description": "Time to wait before selecting the winner"
          },
          "testSizePercent": {
            "description": "Percentage of audience for the test phase (10-100)",
            "example": 30,
            "type": "integer"
          },
          "winningMetric": {
            "description": "Winner determination metric",
            "enum": [
              "openRate",
              "clickRate"
            ],
            "example": "openRate",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ABTestVariant": {
        "description": "A/B test variant. Email-specific fields live under `content.email`.",
        "properties": {
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestVariantContent"
              }
            ],
            "description": "Variant content grouped by channel"
          },
          "id": {
            "description": "Variant campaign ID (read-only). Used for reporting API access.",
            "example": "000000000000000000000010",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "ABTestVariantContent": {
        "description": "A/B test variant content grouped by channel.",
        "properties": {
          "email": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestVariantEmail"
              }
            ],
            "description": "Email content for this variant"
          }
        },
        "type": "object"
      },
      "ABTestVariantEmail": {
        "description": "Email content fields for an A/B test variant.",
        "properties": {
          "contentID": {
            "description": "Email content unique identifier referencing the variant's email design",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "preheader": {
            "description": "Preheader text",
            "example": "Check it out",
            "type": "string"
          },
          "replyToEmail": {
            "description": "Reply-to email address",
            "example": "support@example.com",
            "type": "string"
          },
          "senderEmail": {
            "description": "Sender email address",
            "example": "hello@example.com",
            "type": "string"
          },
          "senderName": {
            "description": "Sender display name",
            "example": "My Store",
            "type": "string"
          },
          "subject": {
            "description": "Email subject line",
            "example": "Welcome!",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ABTestVariants": {
        "description": "A/B test variants object with keys \"a\" and \"b\".",
        "properties": {
          "a": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestVariant"
              }
            ],
            "description": "Variant A (null if not yet configured)"
          },
          "b": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTestVariant"
              }
            ],
            "description": "Variant B (null if not yet configured)"
          }
        },
        "type": "object"
      },
      "Audience": {
        "description": "Campaign audience",
        "properties": {
          "excludedCountries": {
            "description": "Countries excluded from the SMS audience, as ISO 3166-1 alpha-2 codes (e.g. \"US\").\nOnly applicable to SMS campaigns. Recipients in these countries are not sent to.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "excludedSegmentIDs": {
            "description": "Segments to exclude from the audience",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "includedSegmentIDs": {
            "description": "Segments to include. Empty includes all subscribers",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "BoosterDelay": {
        "description": "Delay between the parent campaign send and the booster send.",
        "properties": {
          "amount": {
            "description": "Amount of time units before the booster is sent",
            "example": 48,
            "type": "integer"
          },
          "unit": {
            "description": "Time unit: \"h\" for hours, \"d\" for days",
            "enum": [
              "h",
              "d"
            ],
            "example": "h",
            "type": "string"
          }
        },
        "type": "object"
      },
      "BoosterSettings": {
        "description": "Booster-specific settings.",
        "properties": {
          "campaignID": {
            "description": "Parent campaign ID this booster follows up on",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "delay": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BoosterDelay"
              }
            ],
            "description": "Delay between the parent's send and this booster's send"
          },
          "sendTo": {
            "description": "Audience selector. The booster targets recipients of the parent who\ndid NOT perform the implied action (`nonOpeners` did not open;\n`nonClickers` did not click).",
            "enum": [
              "nonOpeners",
              "nonClickers"
            ],
            "example": "nonOpeners",
            "type": "string"
          }
        },
        "required": [
          "campaignID",
          "sendTo"
        ],
        "type": "object"
      },
      "Campaign": {
        "description": "Campaign resource. When `type` is `booster`, the `boosterSettings` field is populated, identifying the parent campaign and the conditions under which the booster targets recipients of that parent.",
        "properties": {
          "abTest": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ABTest"
              }
            ],
            "description": "A/B test configuration. Populated only when `type` is `abTest`;\nvariants carry their own content (see `ABTest.variants`), so the\ntop-level `content` field is omitted in that case."
          },
          "audience": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audience"
              }
            ],
            "description": "Campaign audience"
          },
          "boosterSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BoosterSettings"
              }
            ],
            "description": "Booster-specific settings. Populated only when `type` is `booster` and\nidentifies the parent campaign and the conditions under which this\nbooster targets recipients of that parent."
          },
          "brandID": {
            "description": "Brand unique identifier (read-only)",
            "example": "000000000000000000000001",
            "readOnly": true,
            "type": "string"
          },
          "channel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignChannel"
              }
            ],
            "description": "Campaign message channel",
            "enum": [
              "email",
              "push",
              "sms"
            ],
            "example": "email"
          },
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Content"
              }
            ],
            "description": "Campaign content. Populated based on channel"
          },
          "createdAt": {
            "description": "Campaign creation timestamp (read-only)",
            "example": "2026-01-15T10:30:00Z",
            "readOnly": true,
            "type": "string"
          },
          "endedAt": {
            "description": "Campaign end timestamp (read-only)",
            "example": "2026-01-15T10:30:00Z",
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "description": "Campaign unique identifier (read-only)",
            "example": "000000000000000000000001",
            "readOnly": true,
            "type": "string"
          },
          "language": {
            "description": "Campaign language locale in xx_XX format",
            "example": "en_US",
            "type": "string"
          },
          "name": {
            "description": "Campaign name",
            "example": "Welcome Email Campaign",
            "type": "string"
          },
          "sendingSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SendingSettings"
              }
            ],
            "description": "Campaign sending settings"
          },
          "startedAt": {
            "description": "Campaign start timestamp (read-only)",
            "example": "2026-01-15T10:30:00Z",
            "readOnly": true,
            "type": "string"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignStatus"
              }
            ],
            "description": "Campaign status",
            "enum": [
              "error",
              "onHold",
              "sent",
              "paused",
              "started",
              "stopped",
              "expired",
              "draft",
              "scheduled",
              "canceled"
            ],
            "example": "draft"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignType"
              }
            ],
            "description": "Campaign type. `booster` identifies a follow-up campaign sent to the\naudience of a parent campaign.",
            "enum": [
              "regular",
              "abTest",
              "booster"
            ],
            "example": "regular"
          },
          "updatedAt": {
            "description": "Campaign last update timestamp (read-only)",
            "example": "2026-01-15T10:30:00Z",
            "readOnly": true,
            "type": "string"
          },
          "url": {
            "description": "Link to the campaign in the Omnisend app (read-only): the settings page of\na draft campaign (for a booster, the parent campaign's booster page) or the\nreport of a started, sent, canceled, stopped or expired campaign. Omitted\nfor scheduled, paused, on-hold and error campaigns.",
            "example": "https://app.omnisend.com/campaign/email/000000000000000000000001/settings",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "CampaignChannel": {
        "description": "Campaign message channel",
        "enum": [
          "email",
          "push",
          "sms"
        ],
        "type": "string",
        "x-enum-varnames": [
          "CampaignChannelEmail",
          "CampaignChannelPush",
          "CampaignChannelSMS"
        ]
      },
      "CampaignStatus": {
        "description": "Campaign status",
        "enum": [
          "draft",
          "scheduled",
          "started",
          "sent",
          "error",
          "canceled",
          "paused",
          "onHold",
          "expired",
          "stopped"
        ],
        "type": "string",
        "x-enum-varnames": [
          "CampaignStatusDraft",
          "CampaignStatusScheduled",
          "CampaignStatusStarted",
          "CampaignStatusSent",
          "CampaignStatusError",
          "CampaignStatusCanceled",
          "CampaignStatusPaused",
          "CampaignStatusOnHold",
          "CampaignStatusExpired",
          "CampaignStatusStopped"
        ]
      },
      "CampaignType": {
        "description": "Campaign type",
        "enum": [
          "regular",
          "abTest",
          "booster"
        ],
        "type": "string",
        "x-enum-varnames": [
          "CampaignTypeRegular",
          "CampaignTypeABTest",
          "CampaignTypeBooster"
        ]
      },
      "Content": {
        "description": "Campaign content",
        "properties": {
          "email": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Email"
              }
            ],
            "description": "Email content"
          },
          "sms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SMS"
              }
            ],
            "description": "SMS content"
          }
        },
        "type": "object"
      },
      "CreateABTest": {
        "description": "A/B test configuration for campaign creation.",
        "properties": {
          "settings": {
            "$ref": "#/components/schemas/CreateABTestSettings"
          },
          "variants": {
            "$ref": "#/components/schemas/CreateABTestVariants"
          }
        },
        "required": [
          "settings",
          "variants"
        ],
        "type": "object"
      },
      "CreateABTestDecisionTime": {
        "description": "Decision time before selecting a winner. Same shape as booster delay.",
        "properties": {
          "amount": {
            "description": "Number of time units to wait before selecting a winner",
            "example": 4,
            "minimum": 1,
            "type": "integer"
          },
          "unit": {
            "description": "Time unit: \"h\" for hours, \"d\" for days",
            "enum": [
              "h",
              "d"
            ],
            "example": "h",
            "type": "string"
          }
        },
        "required": [
          "amount",
          "unit"
        ],
        "type": "object"
      },
      "CreateABTestSettings": {
        "description": "A/B test settings for campaign creation.",
        "properties": {
          "decisionTime": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateABTestDecisionTime"
              }
            ],
            "description": "Time to wait before selecting a winner. Required unless testSizePercent is 100"
          },
          "testSizePercent": {
            "description": "Percentage of the audience used for testing (10-100). When 100, all recipients get a variant (send-all mode)",
            "example": 30,
            "maximum": 100,
            "minimum": 10,
            "type": "integer"
          },
          "winningMetric": {
            "description": "Metric used to determine the winner. Required unless testSizePercent is 100",
            "enum": [
              "openRate",
              "clickRate"
            ],
            "example": "openRate",
            "type": "string"
          }
        },
        "required": [
          "testSizePercent"
        ],
        "type": "object"
      },
      "CreateABTestVariant": {
        "description": "A/B test variant for creation. Email fields live under `content.email`.",
        "properties": {
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateABTestVariantContent"
              }
            ],
            "description": "Variant content grouped by channel"
          }
        },
        "required": [
          "content"
        ],
        "type": "object"
      },
      "CreateABTestVariantContent": {
        "description": "Variant content grouped by channel for creation.",
        "properties": {
          "email": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateABTestVariantEmail"
              }
            ],
            "description": "Email content for this variant"
          }
        },
        "required": [
          "email"
        ],
        "type": "object"
      },
      "CreateABTestVariantEmail": {
        "description": "Email content fields for an A/B test variant creation.",
        "properties": {
          "preheader": {
            "description": "Preview text shown in the inbox after the subject line",
            "example": "Check it out",
            "type": "string"
          },
          "replyToEmail": {
            "description": "Reply-to email address for recipient responses. Omit it and replies go to the sender\naddress. Set it only when a specific address is required: it must be an address\nverified for the brand, and verification status is not exposed here, so an address\nthat is guessed, or copied from another campaign, is rejected.",
            "example": "support@example.com",
            "type": "string"
          },
          "senderEmail": {
            "description": "Sender email address. Omit it and the campaign is sent from the sender address\nconfigured for the brand. Set it only when a specific address is required: which\naddresses a brand may send from follows from its sender setup and is not exposed\nhere, so an address that is guessed, or copied from another campaign, is rejected.",
            "example": "hello@example.com",
            "type": "string"
          },
          "senderName": {
            "description": "Display name of the sender",
            "example": "My Store",
            "type": "string"
          },
          "subject": {
            "description": "Email subject line",
            "example": "Welcome!",
            "type": "string"
          },
          "templateID": {
            "description": "Template unique identifier. Must reference an existing template.",
            "example": "000000000000000000000001",
            "type": "string"
          }
        },
        "required": [
          "subject",
          "templateID"
        ],
        "type": "object"
      },
      "CreateABTestVariants": {
        "description": "A/B test variants object with keys \"a\" and \"b\".",
        "properties": {
          "a": {
            "$ref": "#/components/schemas/CreateABTestVariant"
          },
          "b": {
            "$ref": "#/components/schemas/CreateABTestVariant"
          }
        },
        "required": [
          "a",
          "b"
        ],
        "type": "object"
      },
      "CreateBoosterDelay": {
        "description": "Delay settings for booster campaign",
        "properties": {
          "amount": {
            "description": "Amount of time units. Minimum 0 (SMS booster only — means \"send together with parent\").\nMaximum 240 hours (or 10 days)",
            "example": 48,
            "minimum": 0,
            "type": "integer"
          },
          "unit": {
            "description": "Time unit: \"h\" for hours, \"d\" for days",
            "enum": [
              "h",
              "d"
            ],
            "example": "h",
            "type": "string"
          }
        },
        "required": [
          "amount",
          "unit"
        ],
        "type": "object"
      },
      "CreateBoosterSettings": {
        "description": "Booster settings for campaign creation",
        "properties": {
          "campaignID": {
            "description": "Parent campaign ID to boost",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "delay": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateBoosterDelay"
              }
            ],
            "description": "Delay before sending the booster after the parent campaign is sent.\nOnly required when the parent campaign is in draft status"
          },
          "sendTo": {
            "description": "Which recipients to target: \"nonOpeners\" or \"nonClickers\"",
            "enum": [
              "nonOpeners",
              "nonClickers"
            ],
            "example": "nonOpeners",
            "type": "string"
          }
        },
        "required": [
          "campaignID",
          "sendTo"
        ],
        "type": "object"
      },
      "CreateCampaignRequest": {
        "description": "Campaign creation request",
        "properties": {
          "abTest": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateABTest"
              }
            ],
            "description": "A/B test configuration. Required when type is \"abTest\".\nVariants carry per-variant content; omit the top-level content field."
          },
          "audience": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audience"
              }
            ],
            "description": "Campaign audience. Included and excluded segments must not overlap"
          },
          "boosterSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateBoosterSettings"
              }
            ],
            "description": "Booster settings. Required when type is \"booster\""
          },
          "channel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignChannel"
              }
            ],
            "description": "Campaign message channel",
            "enum": [
              "email",
              "push",
              "sms"
            ],
            "example": "email"
          },
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateContent"
              }
            ],
            "description": "Campaign content. Required for regular campaigns (not required for booster or abTest). Populated based on channel"
          },
          "language": {
            "description": "Campaign language locale in xx_XX format. Optional; defaults to en_US when not provided. Must be a supported language when specified",
            "example": "en_US",
            "type": "string"
          },
          "name": {
            "description": "Campaign name. Required for regular and abTest campaigns (not required for booster)",
            "example": "Welcome Campaign",
            "maxLength": 250,
            "type": "string"
          },
          "sendingSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateSendingSettings"
              }
            ],
            "description": "Campaign sending settings"
          },
          "type": {
            "description": "Campaign type.\n\nWhen `type` is `booster`, there are two supported flows:\n\nFlow 1 — draft parent + draft booster:\nCreate a draft parent campaign, then create a draft booster for it\n(set `boosterSettings.delay` to control when it fires). Send the parent;\nthe booster is scheduled automatically based on the configured delay.\n\nFlow 2 — already-sent parent:\nCreate and send a parent campaign first. Once it reaches `sent` status,\ncreate the booster campaign (omit `boosterSettings.delay`) and use\n`sendingSettings.scheduledAt` to set the exact send time. Then call\nthe send endpoint on the booster.",
            "enum": [
              "regular",
              "booster",
              "abTest"
            ],
            "example": "regular",
            "type": "string"
          }
        },
        "required": [
          "channel",
          "type"
        ],
        "type": "object"
      },
      "CreateContent": {
        "description": "Campaign content for creation",
        "properties": {
          "email": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateEmail"
              }
            ],
            "description": "Email content"
          },
          "sms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateSMS"
              }
            ],
            "description": "SMS content"
          }
        },
        "type": "object"
      },
      "CreateEmail": {
        "description": "Email content for campaign creation",
        "properties": {
          "preheader": {
            "description": "Email preheader text",
            "example": "Discover what we have in store for you",
            "maxLength": 250,
            "type": "string"
          },
          "replyToEmail": {
            "description": "Reply-to email address for recipient responses. Omit it and replies go to the sender\naddress. Set it only when a specific address is required: it must be an address\nverified for the brand, and verification status is not exposed here, so an address\nthat is guessed, or copied from another campaign, is rejected.",
            "example": "support@example.com",
            "type": "string"
          },
          "senderEmail": {
            "description": "Sender email address. Omit it and the campaign is sent from the sender address\nconfigured for the brand. Set it only when a specific address is required: which\naddresses a brand may send from follows from its sender setup and is not exposed\nhere, so an address that is guessed, or copied from another campaign, is rejected.",
            "example": "hello@example.com",
            "type": "string"
          },
          "senderName": {
            "description": "Sender display name shown in the recipient's inbox",
            "example": "My Store",
            "maxLength": 250,
            "type": "string"
          },
          "subject": {
            "description": "Email subject line",
            "example": "Welcome to Omnisend!",
            "maxLength": 250,
            "type": "string"
          },
          "templateID": {
            "description": "Email template unique identifier. Required for regular email campaigns: creation is\nrejected without it, even when the campaign would be saved as a draft. Booster campaigns\nare exempt — they may still send content.email (e.g. to override the subject) but do not\nrequire a template, inheriting the parent campaign's. A/B-test campaigns carry their\ntemplate per variant under abTest.variants, not in top-level content.\nMust reference an existing template.\nSee [Email Templates API](https://api-docs.omnisend.com/reference/email-templates).",
            "example": "000000000000000000000001",
            "type": "string"
          }
        },
        "required": [
          "templateID"
        ],
        "type": "object"
      },
      "CreateSMS": {
        "description": "SMS content for campaign creation",
        "properties": {
          "compliance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateSMSCompliance"
              }
            ],
            "description": "Compliance text appended to every SMS"
          },
          "imageID": {
            "description": "Image ID obtained from the Images API.\nWhen set, the message is delivered as MMS to US/CA recipients;\nother countries receive SMS without the image.\nImage must be JPEG, JPG, PNG, or GIF and not exceed 500 KB",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "isLinkShorteningEnabled": {
            "description": "Auto-shorten links in message body. Default: true",
            "example": true,
            "type": "boolean"
          },
          "message": {
            "description": "SMS message body.\nWhen sent as SMS, the message (including the appended\ncompliance text and unsubscribe link/keyword) must not exceed 9 SMS\nsegments for either US/CA or other-country recipients.\nWhen sent as MMS, the message (including the appended\ncompliance text) must not exceed 1600 characters for US/CA recipients.",
            "example": "Hi! Check out our deals",
            "type": "string"
          }
        },
        "required": [
          "compliance",
          "message"
        ],
        "type": "object"
      },
      "CreateSMSCompliance": {
        "description": "SMS compliance text settings for creation",
        "properties": {
          "stopKeywordText": {
            "description": "STOP keyword text for US/CA recipients",
            "example": "Reply STOP to opt out",
            "maxLength": 250,
            "type": "string"
          },
          "unsubscribeLinkText": {
            "description": "Unsubscribe link text for non-US/CA recipients",
            "example": "Unsubscribe [[unsubscribe_link]]",
            "maxLength": 250,
            "type": "string"
          }
        },
        "required": [
          "stopKeywordText",
          "unsubscribeLinkText"
        ],
        "type": "object"
      },
      "CreateSendingSettings": {
        "description": "Sending settings for campaign creation",
        "properties": {
          "isTZOptimizationEnabled": {
            "description": "Whether timezone optimization is enabled.\nOnly available with immediate or scheduled strategy, and only in email campaigns",
            "example": false,
            "type": "boolean"
          },
          "optimizeFor": {
            "description": "Optimization objective for personalized sends.\nRequired when strategy is \"personalized\", must not be set otherwise",
            "enum": [
              "opens",
              "clicks",
              "orders"
            ],
            "example": "opens",
            "type": "string"
          },
          "respectQuietHours": {
            "description": "Whether personalized sends avoid contact-local hours from 22:00 through 06:59.\nDefaults to true for personalized sends and must not be set for other strategies",
            "example": true,
            "type": "boolean"
          },
          "scheduledAt": {
            "description": "Campaign scheduled send time in RFC 3339 format.\nRequired when strategy is \"scheduled\" or \"personalized\", must not be set for \"immediate\".\nFor \"scheduled\" it must be in the future and within one year from now.\nFor \"personalized\" only the calendar date in the brand timezone is used, not the time-of-day:\nthe value is normalized to the start of that day in the brand timezone. A date resolving to today\nstarts the STO window at the next whole hour when the campaign is sent; a future date (within one\nyear) starts it at brand-local midnight. Per-contact send times are then chosen within the\nfollowing 24 hours. Responses store the start as brand-local midnight, which can appear as the\nprevious UTC calendar date",
            "example": "2026-06-15T00:00:00+03:00",
            "type": "string"
          },
          "strategy": {
            "description": "Sending strategy. Default: immediate.\n\"personalized\" enables send time optimization and is only available\nfor regular email campaigns in stores whose plan includes personalized send times and that are eligible for them",
            "enum": [
              "immediate",
              "scheduled",
              "personalized"
            ],
            "example": "immediate",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Email": {
        "description": "Email content",
        "properties": {
          "contentID": {
            "description": "Email content unique identifier referencing the campaign's email design",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "preheader": {
            "description": "Email preheader text displayed after the subject line in the recipient's inbox",
            "example": "Discover what we have in store for you",
            "type": "string"
          },
          "replyToEmail": {
            "description": "Reply-to email address for recipient responses",
            "example": "support@example.com",
            "type": "string"
          },
          "senderEmail": {
            "description": "Sender email address shown in the recipient's inbox",
            "example": "hello@example.com",
            "type": "string"
          },
          "senderName": {
            "description": "Sender display name shown in the recipient's inbox",
            "example": "My Store",
            "type": "string"
          },
          "subject": {
            "description": "Email subject line displayed in the recipient's inbox",
            "example": "Welcome to Omnisend!",
            "type": "string"
          }
        },
        "type": "object"
      },
      "FieldError": {
        "description": "A single field validation failure within a validation error response.",
        "properties": {
          "code": {
            "description": "Error code indicating the type of failure",
            "example": "invalid_format",
            "type": "string"
          },
          "field": {
            "description": "Dot-separated path to the field that failed validation",
            "example": "content.email.subject",
            "type": "string"
          },
          "message": {
            "description": "Human-readable explanation of what is wrong with the field value",
            "example": "Must be a valid email address",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Problem": {
        "description": "Standard error response returned by all API endpoints on failure.",
        "properties": {
          "detail": {
            "description": "Human-readable explanation of this specific error occurrence",
            "example": "A human-readable explanation of the error.",
            "type": "string"
          },
          "instance": {
            "description": "Request trace identifier for support and debugging",
            "example": "urn:omnisend:request:00000000-0000-0000-0000-000000000001",
            "type": "string"
          },
          "status": {
            "description": "HTTP status code",
            "example": 0,
            "type": "integer"
          },
          "title": {
            "description": "Short description of the error type",
            "example": "Problem",
            "type": "string"
          },
          "type": {
            "description": "URI that identifies the error type",
            "example": "https://problems.omnisend.com/problem",
            "type": "string"
          }
        },
        "type": "object"
      },
      "RateLimitProblem": {
        "description": "Error response returned when the rate limit is exceeded. Use the retryAfter value to know when it is safe to retry the request.",
        "properties": {
          "detail": {
            "description": "Human-readable explanation of this specific error occurrence",
            "example": "A human-readable explanation of the error.",
            "type": "string"
          },
          "instance": {
            "description": "Request trace identifier for support and debugging",
            "example": "urn:omnisend:request:00000000-0000-0000-0000-000000000001",
            "type": "string"
          },
          "retryAfter": {
            "description": "Seconds to wait before retrying the request",
            "example": 60,
            "type": "integer"
          },
          "status": {
            "description": "HTTP status code",
            "example": 0,
            "type": "integer"
          },
          "title": {
            "description": "Short description of the error type",
            "example": "Problem",
            "type": "string"
          },
          "type": {
            "description": "URI that identifies the error type",
            "example": "https://problems.omnisend.com/problem",
            "type": "string"
          }
        },
        "type": "object"
      },
      "SMS": {
        "description": "SMS message content",
        "properties": {
          "compliance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SMSCompliance"
              }
            ],
            "description": "Compliance text appended to every SMS"
          },
          "imageID": {
            "description": "Image ID obtained from the Images API.\nWhen set, the message is delivered as MMS to US/CA recipients;\nother countries receive SMS without the image.\nImage must be JPEG, JPG, PNG, or GIF and not exceed 500 KB",
            "example": "000000000000000000000001",
            "type": "string"
          },
          "isLinkShorteningEnabled": {
            "description": "Auto-shorten links in message body",
            "example": true,
            "type": "boolean"
          },
          "message": {
            "description": "SMS message body.\nWhen sent as SMS, the message (including the appended\ncompliance text and unsubscribe link/keyword) must not exceed 9 SMS\nsegments for either US/CA or other-country recipients.\nWhen sent as MMS, the message (including the appended\ncompliance text) must not exceed 1600 characters for US/CA recipients.",
            "example": "Hi! Check out our new deals",
            "type": "string"
          },
          "senderName": {
            "description": "Sender display name. Max 250 chars",
            "example": "My Store",
            "type": "string"
          }
        },
        "type": "object"
      },
      "SMSCompliance": {
        "description": "SMS compliance text settings",
        "properties": {
          "stopKeywordText": {
            "description": "STOP keyword text for US/CA recipients. Max 250 chars",
            "example": "Reply STOP to opt out",
            "type": "string"
          },
          "unsubscribeLinkText": {
            "description": "Unsubscribe link text for non-US/CA recipients. Max 250 chars",
            "example": "Unsubscribe [[unsubscribe_link]]",
            "type": "string"
          }
        },
        "type": "object"
      },
      "SendingSettings": {
        "description": "Campaign sending settings",
        "properties": {
          "isTZOptimizationEnabled": {
            "description": "Whether timezone optimization is enabled.\nOnly available with immediate or scheduled strategy, and only in email campaigns",
            "example": false,
            "type": "boolean"
          },
          "optimizeFor": {
            "description": "Optimization objective for personalized sends.\nPresent when strategy is personalized",
            "enum": [
              "opens",
              "clicks",
              "orders"
            ],
            "example": "opens",
            "type": "string"
          },
          "respectQuietHours": {
            "description": "Whether personalized sends avoid contact-local hours from 22:00 through 06:59",
            "example": true,
            "type": "boolean"
          },
          "scheduledAt": {
            "description": "Scheduled send time in RFC 3339 format.\nPresent when strategy is scheduled or personalized",
            "example": "2026-03-01T10:00:00Z",
            "type": "string"
          },
          "strategy": {
            "description": "Sending strategy",
            "enum": [
              "immediate",
              "scheduled",
              "personalized"
            ],
            "example": "immediate",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ValidationProblem": {
        "description": "Error response returned when the request contains invalid input. The errors array lists every field that failed validation.",
        "properties": {
          "detail": {
            "description": "Human-readable explanation of this specific error occurrence",
            "example": "A human-readable explanation of the error.",
            "type": "string"
          },
          "errors": {
            "description": "List of fields that failed validation",
            "items": {
              "$ref": "#/components/schemas/FieldError"
            },
            "type": "array"
          },
          "instance": {
            "description": "Request trace identifier for support and debugging",
            "example": "urn:omnisend:request:00000000-0000-0000-0000-000000000001",
            "type": "string"
          },
          "status": {
            "description": "HTTP status code",
            "example": 0,
            "type": "integer"
          },
          "title": {
            "description": "Short description of the error type",
            "example": "Problem",
            "type": "string"
          },
          "type": {
            "description": "URI that identifies the error type",
            "example": "https://problems.omnisend.com/problem",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```