---
title: "Add campaign"
method: POST
path: "/api/v11/campaign"
tags: ["Campaign"]
---

# Add campaign

`POST /api/v11/campaign`

## Request

- Base URL: `https://indexing-dev.hawksearch.net`
- URL: `https://indexing-dev.hawksearch.net/api/v11/campaign`
- Auth: none declared. Required headers: `X-HawkSearch-ApiKey`
- TypeScript: <https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/docs/api/v11/campaign/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a campaign to HawkSearch

## Headers

- `X-HawkSearch-ApiKey` string, required

## Request body

- Campaign
  - `Id` integer
  - `SyncGuid` string, uuid
  - `Name` string, required
  - `ZoneId` integer
  - `MinWidth` integer
  - `MaxWidth` integer
  - `MaxHeight` integer
  - `SortOrder` integer
  - `RuleXml` string
  - `IsTrigger` boolean
  - `Banners` BannerCampaign[]
    - `BannerId` integer
    - `DateFrom` string, date-time
    - `DateTo` string, date-time
    - `Weight` integer
  - `Tags` string
  - `CreateDate` string, date-time
  - `ModifyDate` string, date-time

## Response `200`

OK

- Campaign
  - `Id` integer
  - `SyncGuid` string, uuid
  - `Name` string, required
  - `ZoneId` integer
  - `MinWidth` integer
  - `MaxWidth` integer
  - `MaxHeight` integer
  - `SortOrder` integer
  - `RuleXml` string
  - `IsTrigger` boolean
  - `Banners` BannerCampaign[]
    - `BannerId` integer
    - `DateFrom` string, date-time
    - `DateTo` string, date-time
    - `Weight` integer
  - `Tags` string
  - `CreateDate` string, date-time
  - `ModifyDate` string, date-time

---

[API](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi.md) - [All operations](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/llms.txt) - [OpenAPI document](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/revisions/24cba7bf3468?raw)