Campaign Plans
/
Create Campaign Plan

Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://mediamathsupport.force.com/
Support developers@mediamath.com
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Strategies

Strategies

Operations

Targeting

Targeting

Operations

Vendor Contracts

Vendor Contracts

Operations

Strategy Templates

Strategy Templates

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Campaign Plans

Campaign Plans

Operations

List Campaign Plans

Request

List Campaign Plans

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/campaign_plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects(campaign_plan)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Create Campaign Plan

Request

Create a campaign plan

Bodyapplication/json
namestring[ 1 .. 256 ] charactersrequired
advertiser_idinteger(int32)required
durationobjectrequired
duration.​start_datestring(date-time)required
duration.​end_datestring(date-time)required
budgetobjectrequired
budget.​total_budgetnumber(float)[ 1 .. 99999999999999.98 ]required
budget.​currency_codestring<= 3 charactersrequired
zone_namestringrequired
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/campaign_plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advertiser_id": 190,
    "name": "valid campaign plan",
    "duration": {
      "start_date": "2050-01-01T10:00:00Z",
      "end_date": "2050-01-10T23:59:00Z"
    },
    "budget": {
      "currency_code": "USD",
      "total_budget": 100
    },
    "zone_name": "America/New_York"
  }'

Responses

Created

Bodyapplication/json
namestring
advertiser_idinteger
durationobject
budgetobject
zone_namestring
Response
application/json
{
  "name": "string",
  "advertiser_id": 0,
  "duration": {
    "start_date": "string",
    "end_date": "string"
  },
  "budget": {
    "total_budget": 1,
    "currency_code": "string"
  },
  "zone_name": "string"
}

Get a Campaign Plan

Request

Get a Campaign Plan

Path
campaign_plan_idintegerrequired

Numeric ID of the campaign plan

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/campaign_plans/{campaign_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataobject(campaign_plan)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "version": 0,
    "advertiser_id": 0,
    "name": "string",
    "duration": { … },
    "budget": { … },
    "zone_name": "string"
  },
  "meta": {
    "status": "success"
  }
}

Update Campaign Plan

Request

Update a campaign plan

Path
campaign_plan_idintegerrequired

Numeric ID of the campaign plan object to update

Bodyapplication/json
namestring[ 1 .. 256 ] charactersrequired
durationobjectrequired
duration.​start_datestring(date-time)required

start_date can not be in the past

duration.​end_datestring(date-time)required

end_date must be between 1 and 30 days away from start_date

budgetobjectrequired
budget.​total_budgetnumber(float)[ 1 .. 99999999999999.98 ]required
budget.​currency_codestring<= 3 charactersrequired
zone_namestringrequired
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/campaign_plans/{campaign_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "valid campaign plan",
    "duration": {
      "start_date": "2050-01-01T10:00:00Z",
      "end_date": "2050-01-10T23:59:00Z"
    },
    "budget": {
      "currency_code": "USD",
      "total_budget": 100
    },
    "zone_name": "America/New_York"
  }'

Responses

Updated

Bodyapplication/json
namestring
advertiser_idinteger
durationobject
budgetobject
zone_namestring
Response
application/json
{
  "name": "string",
  "advertiser_id": 0,
  "duration": {
    "start_date": "string",
    "end_date": "string"
  },
  "budget": {
    "total_budget": 1,
    "currency_code": "string"
  },
  "zone_name": "string"
}

Strategy Plans

Strategy Plans

Operations

Bulk Update

Bulk Update

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Strategy Groups

Strategy Groups

Operations

Strategy Day Parts

Strategy Day Parts

Operations

Strategy Deals

Strategy Deals

Operations

Strategy IP Addresses

Strategy IP Addresses

Operations

Strategy Concepts

Strategy Concepts

Operations

Targeting Segments

Targeting Segments

Operations

Strategy Target Values

Strategy Target Values

Operations

List Organization Settings

Operations

Update Organization Settings

Operations

New Strategy Plans

Operations

Strategy Plan Target Values

Operations

Campaigns Budget Flights

Operations

User Settings

Operations

Update User Settings

Operations

Supply Sources

Operations

Vendors

Operations

Ad Servers

Operations

Site Lists Site Download

Operations

Site Lists Assignments

Operations

Targeting Segment Objectives

Operations

Targeting Segment Objective

Operations