Skip to main content

CampaignUpdateRequest

Request body to update a campaign's mutable business fields. Every field is optional; only the provided fields change (optimistic-locked). status is read-only here --- use the archive action for the only client-driven transition. The version/raw info map are never accepted.

namestringnullable

Human-readable name of the campaign

Example: Spring Launch 2026
advertiser_idstringnullable

Identifier of the advertiser this campaign runs for

Example: 3Kd7Np5RvM9qWx2T8yZ6
brand_namestringnullable

Brand being advertised in the campaign

Example: Acme Corp
product_namestringnullable

Product being advertised in the campaign

Example: Acme Pro Headphones
product_categorystringnullable

Category the advertised product belongs to

Example: Consumer Electronics
categoriesstring[]nullable

Content categories the campaign is eligible to run against

descriptionstringnullable

Free-text description of the campaign

Example: Promoting the Spring 2026 product line
start_datedate-timenullable

Date the campaign is scheduled to start running

Example: 2026-01-15T09:30:00Z
end_datedate-timenullable

Date the campaign is scheduled to stop running

Example: 2026-03-15T09:30:00Z
budgetdoublenullable

Total campaign budget in US dollars

Example: 50000
cpmdoublenullable

Cost per thousand impressions (CPM) in US dollars

Example: 25
ad_variants object[]nullable

Ad variants (copy and configuration) for the campaign

  • Array [
    • idstringnullable

    Identifier of the variant. Optional on create; the server generates one when omitted.

    Example: 2Bx6Rk9LtN5mZq8Wv4G
    namestringnullable

    Human-readable name of the variant.

    Example: Holiday promo
    ad_copystringnullable

    The ad copy text for this variant.

    Example: This episode is brought to you by Acme...
  • ]
    • platformstringnullable

    Ad-serving platform the campaign targets

    Possible values: [adbridge, adswizz, megaphone]

    Example: adswizz
    adswizz objectnullable

    Link to an Adswizz campaign (merged onto info.adswizz)

    campaign_idstringnullable

    Identifier of the linked campaign in Adswizz

    Example: az_8421907
    targeting objectnullable

    Free-form targeting parameters (open, platform-defined); replaces the stored value

    property name*object
    tracking objectnullable

    Free-form tracking configuration (open, platform-defined); replaces the stored value

    property name*object
    CampaignUpdateRequest
    {
      "name": "Spring Launch 2026",
      "advertiser_id": "3Kd7Np5RvM9qWx2T8yZ6",
      "brand_name": "Acme Corp",
      "product_name": "Acme Pro Headphones",
      "product_category": "Consumer Electronics",
      "categories": [
        "string"
      ],
      "description": "Promoting the Spring 2026 product line",
      "start_date": "2026-01-15T09:30:00Z",
      "end_date": "2026-03-15T09:30:00Z",
      "budget": 50000,
      "cpm": 25,
      "ad_variants": [
        {
          "id": "2Bx6Rk9LtN5mZq8Wv4G",
          "name": "Holiday promo",
          "ad_copy": "This episode is brought to you by Acme..."
        }
      ],
      "platform": "adswizz",
      "adswizz": {
        "campaign_id": "az_8421907"
      },
      "targeting": {},
      "tracking": {}
    }