New Inventory List
POST {{campaign_url}}/inventoryLists?marketId=1
Create a new inventory list
You can create a new inventory list by sending this POST request. To define settings for your inventory list, open the body tab and edit the JSON object.
If you have access to multiple markets, you must specify a value for marketId. Otherwise (i.e., marketId is left unchecked), the request will return a 300 Multiple Choices response containing a list of market IDs that can be passed as marketId values.
Request Body (Definitions)
| JSON Object Key | Description | Type |
|---|---|---|
| name | Name of this inventory list. | string |
| inventoryUsage | Media type of objects (i.e., website or app) specified in this inventory list. Allowed values: apps, sites | string |
| inclusionUsage | Indicates whether the websites/apps in this list should be included or excluded from targeted inventory. Allowed values: include, exclude | string |
| content | Apps (IDs or names) or sites (URLs) to include/exclude. | comma-separated array of strings |
| includeSubdomain | Indicates whether both top-level domains (TLDs) and subdomains can be targeted. | boolean |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
marketId | number | Numeric ID associated with the market for which the inventory list is being created. Required only if you have access to multiple markets. |
Request Body
{"name"=>"doc test site list", "inventoryUsage"=>"sites", "inclusionUsage"=>"include", "content"=>["mySite1.com", "mySite2.com"], "includeSubdomain"=>true}
RESPONSES
status: Created
{"data":[{"id":"36390556","marketId":"1","resourceType":"inventoryList","name":"doc test app list","marketName":"Turn","inventoryUsage":"apps","inclusionUsage":"include","includeSubdomain":false,"content":["AccuWeather: Weather Forecast Updates \u0026 Radar Maps","Wordle","HuffPost - News \u0026 Politics"],"workflowStatus":"approved"}],"errors":[]}