/

Back to MB Suite

Menu

API reference

Media Planner

54 operations

Plans

GET/v1/media-planner/plansList media plans GET/v1/media-planner/plans/{plan_id}Get one media plan with its rows POST/v1/media-planner/plansCreate a media plan PATCH/v1/media-planner/plans/{plan_id}Update a media plan POST/v1/media-planner/plans/{plan_id}/duplicateDuplicate a media plan POST/v1/media-planner/plans/{plan_id}/archiveArchive a media plan DELETE/v1/media-planner/plans/{plan_id}Delete a media plan

Campaigns

GET/v1/media-planner/plans/{plan_id}/campaignsList the rows of a media plan GET/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}Get one row of a media plan POST/v1/media-planner/plans/{plan_id}/campaignsAdd a row to a media plan PATCH/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}Update a row of a media plan DELETE/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}Delete a row of a media plan POST/v1/media-planner/plans/{plan_id}/campaigns/reorderReorder the rows of a media plan POST/v1/media-planner/plans/{plan_id}/campaigns/bulk/updateEdit many rows of a media plan POST/v1/media-planner/plans/{plan_id}/campaigns/bulk/deleteDelete many rows of a media plan POST/v1/media-planner/plans/{plan_id}/campaigns/importImport campaigns from another plan

Change history

GET/v1/media-planner/plans/{plan_id}/changesList the change history of a plan's campaigns

Labels

GET/v1/media-planner/labelsList campaign labels POST/v1/media-planner/labelsCreate a campaign label PATCH/v1/media-planner/labels/{label_id}Rename or recolor a campaign label POST/v1/media-planner/labels/reorderReorder campaign labels DELETE/v1/media-planner/labels/{label_id}Delete a campaign label

Templates

GET/v1/media-planner/templatesList media plan templates GET/v1/media-planner/templates/{template_id}Get one media plan template POST/v1/media-planner/templatesCreate a media plan template PATCH/v1/media-planner/templates/{template_id}Update a media plan template DELETE/v1/media-planner/templates/{template_id}Delete a media plan template POST/v1/media-planner/templates/{template_id}/duplicateDuplicate a media plan template POST/v1/media-planner/templates/reorderReorder media plan templates GET/v1/media-planner/system-templatesList MB Suite's system templates POST/v1/media-planner/system-templates/{system_template_id}/cloneCopy a system template into the organization

Costs

GET/v1/media-planner/plans/{plan_id}/costs/breakdownGet the per-campaign spend breakdown of a plan

Shares

POST/v1/media-planner/plans/{plan_id}/sharesEmail a media plan GET/v1/media-planner/plans/{plan_id}/shares/previewPreview a media plan email GET/v1/media-planner/plans/{plan_id}/sharesList the emails sent with a media plan GET/v1/media-planner/plans/{plan_id}/shares/{share_id}/pdf-urlGet a download link for the PDF of a sent email GET/v1/media-planner/plans/{plan_id}/shares/{share_id}/htmlGet the HTML of a sent email DELETE/v1/media-planner/plans/{plan_id}/shares/{share_id}Delete the record of a sent email

Carryover

GET/v1/media-planner/plans/{plan_id}/carryover/candidatesList the plans whose balance can be carried over POST/v1/media-planner/plans/{plan_id}/carryover/applyApply a carryover to a plan POST/v1/media-planner/plans/{plan_id}/carryover/revertRevert the carryover of a plan POST/v1/media-planner/plans/{plan_id}/carryover/dismissDismiss a carryover candidate

Comments

GET/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}/commentsList the comments of a campaign GET/v1/media-planner/plans/{plan_id}/commentsList the comments of every row of a plan POST/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}/commentsComment on a campaign PATCH/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}/comments/{comment_id}Edit a campaign comment DELETE/v1/media-planner/plans/{plan_id}/campaigns/{campaign_id}/comments/{comment_id}Delete a campaign comment GET/v1/media-planner/plans/{plan_id}/comments/historyComments on the same real campaign in previous plans

Automations

GET/v1/media-planner/automationGet the workspace's media plan automations PATCH/v1/media-planner/automationConfigure the workspace's media plan automations POST/v1/media-planner/automation/runRun a media plan automation now GET/v1/media-planner/automation/runsList the runs of the media plan automations GET/v1/media-planner/automation/runs/{run_id}Get one run of the media plan automations

Cross-account

cross_account

GET/v1/media-planner/cross-accountOverview of every account's media plans