Skip to main content

Create an advertising campaign

POST 
/v1/ads/campaigns

Create a campaign for a brand and sale channel with its family, budget, dates, advertised item SKUs, and supported console settings.

Request and response fields at a glance
  • Request body (application/json): name (string, required), brandId (number, required), saleChannelId (number, required), family (string, required), targeting (string), objective (string), budgetType (string, required), budgetAmount (number, required), startDate (string, required), endDate (mixed), itemSkus (array), settings (object).
  • 201 response (application/json): id (string, required), name (string, required), brandId (number, required), brandName (string, required), saleChannel (object, required), nativeTypeName (string, required), family (string, required), objective (string, required), costModel (string, required), status (string, required), targeting (string, required), budgetType (string, required), budgetAmount (number, required), budgetSpent (mixed, required), budgetRemaining (mixed, required), monthlyBudgetCap (mixed, required), sharedBudget (boolean, required), bidGuidance (mixed, required), spend (number, required), attributedSales (number, required), directAttributedSales (mixed, required), settledRoas (mixed, required), nativeSuccessMetric (mixed, required), belowFloorShare (mixed, required), views (mixed, required), clicks (mixed, required), orders (mixed, required), atc (mixed, required), ecpc (mixed, required), startDate (string, required), endDate (mixed, required), lastCapturedAt (string, required), consoleUrl (mixed, required), settings (object, required), estimatedMissedSales (number), pairExpectationState (string).

Request​