Skip to content

Create a Campaign

Request

Create a campaign

Security
Auth0(Required scopes: offline_accessmanage:services)
Bodyapplication/json
archivedboolean
Default:false
statusboolean
Default:true
namestring, [ 1 .. 256 ] charactersrequired
service_typestringrequired
Enum:"SELF""MANAGED"
io_namestring, <= 256 characters
io_reference_numstring, <= 32 characters
is_programmatic_guaranteedboolean
politicalboolean
Default:false
source_campaign_idinteger or null, (int32)
Example:7
zone_namestring, non-empty
viewabilityobject or null(campaign_viewability)
identityobject(campaign_identity)
ad_serverobject(campaign_ad_server)
pacingobject(campaign_pacing)
attributionobject(campaign_attribution)
vendor_contractsArray of objects(vendor_contract_base)
mfa_avoidancestring
Enum:"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
targeting_identity_levelstring
Default:"INHERIT"
Enum:"INHERIT""INDIVIDUAL""HOUSEHOLD"
advertiser_idinteger, (int32), >= 1required
Example:8
goalsobject(campaign_goals_create)required
budgetobject(campaign_budget)required
frequencyobject(campaign_frequency)
inventoryobject(campaign_inventory)
site_listsArray of objects
custom_brain_selectionsArray of objects
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": {
      "vendor_id": 34,
      "type": "AUTO_TAG",
      "sample_rate": 0
    },
    "identity": {
      "device_graph_only": false,
      "bid_min_devices": 1,
      "connected_id_type": "DETERMINISTIC_FIRST"
    },
    "ad_server": {
      "ad_server_id": 19,
      "ad_server_username": "string",
      "ad_server_password": "string",
      "use_default_ad_server": true,
      "ad_server_fee": 0
    },
    "pacing": {
      "pacing_alert": 0,
      "impression_cap_automatic": false,
      "impression_cap_amount": 11,
      "impression_cap_type": "even",
      "spend_cap_type": "even",
      "spend_cap_amount": 0,
      "spend_cap_automatic": true,
      "brain_intraday_pacing": false,
      "spend_pace_ahead": false,
      "impression_pace_ahead": false
    },
    "attribution": {
      "has_custom_attribution": false,
      "custom_attribution_source": "3rd Party Attribution",
      "pc_window_minutes": 5,
      "pv_window_minutes": 6,
      "pv_pct": 100,
      "merit_pixel_id": 17,
      "merit_pixels": [
        {
          "pixel_id": 1,
          "weight": 1,
          "funnel_position": 1
        }
      ],
      "conversion_type": "every",
      "conversion_variable_minutes": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 23,
        "use_mm_contract": true,
        "price": 0.1,
        "rate_card_type": "CPM"
      }
    ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "advertiser_id": 8,
    "goals": {
      "goal_type": "spend",
      "goal_alert": 0,
      "goal_value": 0.0001,
      "goal_category": "audience"
    },
    "budget": {
      "total_budget": 0.1,
      "total_impression_budget": 18789,
      "currency_code": "USD",
      "margin_pct": 0,
      "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
      "flights": [
        {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 12345
        }
      ]
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 10,
      "use_mm_freq": false,
      "frequency_optimization": false
    },
    "inventory": {
      "ads_txt_verified": "ANY",
      "minimize_multi_ads": false,
      "override_suspicious_traffic_filter": false,
      "suspicious_traffic_filter_level": 25,
      "dcs_data_is_campaign_level": false,
      "restrict_targeting_to_deterministic_id": true,
      "restrict_targeting_to_same_device_id": true
    },
    "site_lists": [
      {
        "id": 55,
        "assigned": true
      }
    ],
    "custom_brain_selections": [
      {
        "selection_id": 23,
        "selection_type": "Audience Target"
      }
    ]
  }'

Responses

Campaign response

Bodyapplication/json
dataobject(campaign_full_with_inherited)
metaobject(single_metadata)
Response
{ "data": { "archived": false, "status": true, "name": "string", "service_type": "SELF", "io_name": "string", "io_reference_num": "string", "is_programmatic_guaranteed": true, "political": false, "source_campaign_id": 7, "zone_name": "string", "viewability": { … }, "identity": { … }, "ad_server": { … }, "pacing": { … }, "attribution": { … }, "vendor_contracts": [ … ], "mfa_avoidance": "INHERIT", "targeting_identity_level": "INHERIT", "id": 0, "entity_type": "string", "version": 0, "advertiser_id": 0, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "locked_on": "2019-08-24T14:15:22Z", "v3_usage": true, "duration": { … }, "goals": { … }, "budget": { … }, "frequency": { … }, "inventory": { … }, "site_lists": [ … ], "custom_brain_selections": [ … ], "strategies": { … }, "strategy_groups": { … }, "inherited_mfa_avoidance": "INHERIT", "inherited_mfa_from": "Organization", "inherited_targeting_identity_level": "INDIVIDUAL" }, "meta": { "status": "success" } }