New Package
POST {{campaign_url}}/insertionOrders/:insertionOrderId/packages
Create a new package
You can create a new package by sending this POST request. To define settings for your package, open the body tab and edit the JSON object.
For DTO fields budget and impressionFrequency (along with nested fields), see the corresponding DTO tables in the POST New IO documentation for field descriptions and allowed values.
Request Body (Definitions)
*Optional element
| JSON Object Key | Description | Type |
|---|---|---|
| inventoryType | Type of inventory targeted by this package. Allowed values: openAuctionAndPrivateDeals, programmaticGuaranteed | string |
| name | Name of this package. | string |
| *externalPackageId | Third-party ID associated with the package for third-party reporting purposes. | string |
| status | Play status of this package. Allowed values: play, pause, stop, archived | string |
| mediaFormat | Media format of this package. Allowed values: display, video, audio | string |
| *impressionFrequency (DTO) (Only available if parent IO's frequencyType is personor household) | Frequency of package impressions served to a specific user within the specified time frame. See POST New IO documentation for field descriptions and allowed values. | DTO |
| budget (DTO) | Budget and flight schedule details for this package. Note: Allowed values for nested field pacing may depend on the parent IO's budget settings. See POST New IO documentation for field descriptions and allowed values. | DTO |
Request Body
{"inventoryType"=>"openAuctionAndPrivateDeals", "name"=>"irene test pkg", "status"=>"play", "mediaFormat"=>"display", "impressionFrequency"=>{"householdFrequencyCapDetails"=>{"cap"=>3, "period"=>2, "periodUnits"=>"days"}, "personOrDeviceFrequencyCapDetails"=>{"cap"=>1, "period"=>45, "periodUnits"=>"minutes"}}, "budget"=>{"asapDelivery"=>false, "clientMargin"=>0, "pacing"=>"daily", "schedules"=>[{"budget"=>50, "dailyCap"=>2, "startDate"=>"2022-09-30T13:41:30Z", "endDate"=>"2022-10-27T13:41:30Z", "impressionCap"=>10}]}}
RESPONSES
status: Created
{"data":[{"id":"1608792594","marketId":"1","resourceType":"package","status":"stopStartDate","name":"irene test pkg","mediaFormat":"display","budget":{"pacing":"dailyImpression","schedules":[{"startDate":"2022-09-30T13:41:00Z","endDate":"2022-10-27T13:41:30Z","budget":50,"impressionCap":10}]},"impressionFrequency":{"personOrDeviceFrequencyCapDetails":{"cap":1,"period":45,"periodUnits":"minutes"},"householdFrequencyCapDetails":{"cap":3,"period":2,"periodUnits":"days"}},"advertiserId":"1608792487","insertionOrderId":"1608792488","createdAt":"2022-09-01T05:57:37Z","updatedAt":"2022-09-01T05:57:37Z","inventoryType":"openAuctionAndPrivateDeals"}],"errors":[]}