v1

latestOpenAPI 3.1.02026-07-26950137.9 KB

Delete a Campaign

Returns a campaign object with status = TERMINATED.

For all purposes, the campaign is 'deleted'. Any attempt to reference that Campaign ID will return 404 Not Found.

delete/backstage/api/1.0/{account_id}/campaigns/{campaign_id}

Path parameters

account_idstring required

An alphabetic ID. See Get Account Details.

campaign_idstring required

A numeric ID.

Response

200

idstring

advertiser_idstring

namestring

branding_textstring

tracking_codestring

cpcnumber

daily_capinteger

spending_limitinteger

spending_limit_modelstring

cpa_goalinteger

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}:delete:responses:200:content:application/json:schema:properties:sub_country_targeting","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}:delete:responses:200:content:application/json:schema:properties:postal_code_targeting","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}:delete:responses:200:content:application/json:schema:properties:publisher_targeting","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}:delete:responses:200:content:application/json:schema:properties:comments","oasType":"schema","type":"unknown"}

start_datestring

end_datestring

approval_statestring

is_activeboolean

spentinteger

bid_typestring

statusstring

daily_ad_delivery_modelstring

traffic_allocation_modestring

marketing_objectivestring

Example response

{
  "id": "123",
  "advertiser_id": "taboola-demo-advertiser",
  "name": "DemoCampaign",
  "branding_text": "Yummy Pizza",
  "tracking_code": "taboola-tracking-code",
  "cpc": 0.5,
  "daily_cap": 500,
  "spending_limit": 5000,
  "spending_limit_model": "ENTIRE",
  "cpa_goal": 5,
  "country_targeting": {
    "type": "INCLUDE",
    "value": [
      "AU"
    ]
  },
  "contextual_targeting": {
    "type": "INCLUDE",
    "value": [
      "IAB1"
    ]
  },
  "platform_targeting": {
    "type": "INCLUDE",
    "value": [
      "TBLT"
    ]
  },
  "campaign_profile": {
    "content_type": "VIDEO",
    "ad_type": "AD_HEAVY",
    "content_safety": "LOW_BROW",
    "language": "EN",
    "category": "SPORTS"
  },
  "start_date": "2015-04-24",
  "end_date": "2015-05-24",
  "approval_state": "APPROVED",
  "is_active": true,
  "bid_type": "OPTIMIZED_CONVERSIONS",
  "status": "TERMINATED",
  "daily_ad_delivery_model": "STRICT",
  "traffic_allocation_mode": "EVEN",
  "activity_schedule": {
    "mode": "ALWAYS",
    "time_zone": "US/Eastern"
  },
  "marketing_objective": "MOBILE_APP_INSTALL",
  "verification_pixel": {
    "verification_pixel_items": [
      {
        "tracking_pixels_type": "CLICK",
        "url": "www.mysite.com"
      }
    ]
  }
}