Campaigns

Overview

The Campaigns API is used to create and manage campaigns. A campaign is a container for line items that defines budget, timing, and delivery details. Each campaign belongs an advertiser in a many-to-one relationship.

Use the Campaigns API to accomplish the following tasks:

  • Retrieve a list of campaigns for a given advertiser
  • Create campaigns individually or in bulk
  • Validate campaigns in bulk to ensure that campaign data meets requirements
  • Modify and delete campaigns
  • Update fields in a campaign via PATCH

Uniform Resource Identifiers (URI)

URI
https://{buzz_key}.api.beeswax.com/rest/v2/campaigns

Workflows

Bulk Validate and Create Campaigns

Client

  1. Sends multiple possible campaigns to the bulk validate campaigns endpoint.

FreeWheel

  1. Returns which campaigns contain invalid information (e.g., budget is set to 0).

Client

  1. Amends invalid campaigns, then sends campaigns to the create a campaign endpoint for creation.

FreeWheel

  1. Creates the campaigns and returns their IDs.