Campaigns

Update a Campaign

Update a campaign by ID

post/campaigns/{campaign_id}

Request

Path parameters

campaign_idinteger required

Numeric ID of the campaign to update

Request body

archivedboolean
statusboolean
namestring
service_type'SELF' | 'MANAGED'
io_namestring
io_reference_numstring
is_programmatic_guaranteedboolean
politicalboolean
source_campaign_idinteger nullable
zone_namestring
mfa_avoidance'INHERIT' | 'ALLOW_ALL' | 'EXCLUDE_MFA'
targeting_identity_level'INHERIT' | 'INDIVIDUAL' | 'HOUSEHOLD'
versioninteger

Example request

{
  "source_campaign_id": 7,
  "viewability": {
    "vendor_id": 34
  },
  "ad_server": {
    "ad_server_id": 19
  },
  "pacing": {
    "impression_cap_amount": 11
  },
  "attribution": {
    "pc_window_minutes": 5,
    "pv_window_minutes": 6,
    "merit_pixel_id": 17,
    "conversion_variable_minutes": 1
  },
  "vendor_contracts": [
    {
      "vendor_id": 23
    }
  ],
  "version": 4,
  "budget": {
    "total_impression_budget": 18789,
    "currency_code": "USD",
    "flights": [
      {
        "id": 77,
        "total_impression_budget": 12345
      }
    ]
  },
  "frequency": {
    "frequency_amount": 10
  },
  "site_lists": [
    {
      "id": 23
    }
  ],
  "custom_brain_selections": [
    {
      "selection_id": 45
    }
  ]
}

Response

Campaign response

Example response

{
  "data": {
    "source_campaign_id": 7,
    "viewability": {
      "vendor_id": 34
    },
    "ad_server": {
      "ad_server_id": 19
    },
    "pacing": {
      "impression_cap_amount": 11
    },
    "attribution": {
      "pc_window_minutes": 5,
      "pv_window_minutes": 6,
      "merit_pixel_id": 17,
      "conversion_variable_minutes": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 23
      }
    ],
    "budget": {
      "total_impression_budget": 18789,
      "currency_code": "USD",
      "flights": [
        {
          "id": 77,
          "total_impression_budget": 12345
        }
      ]
    },
    "frequency": {
      "frequency_amount": 10
    }
  },
  "meta": {
    "status": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.