Request

POST /site-list/addNewSiteList

Request Body

Name	Type	Description	Required
name	String	Site list name.	Yes
typeId	Number	Type ID to differentiate id based or rule based.	Yes
siteIds	Number Array	Sites that are assigned to site list	Yes when creation is Id based. No when creation is rule based
strategy	String	Precise or broad strategy	Yes when creating rule based sitelist
rules	Object Array	An array of rules to be added to sitelist	Yes for creating rule based sitelist
rules[].name	String	Rule name	Yes if rules is included
rules[].type	String	Rule type	Yes if rules is included

Response

Name	Type	Description
messages	Object Array	An array of any error messages.
messages[].level	String	Error level.
messages[].code	String	Error code.
messages[].message	String	Error message.
entity	Object	A site list object
entity.id	Number	Site list id
entity.name	String	Site list name
entity.typeId	Number	Site list type i.e., id based or rule based
entity.strategy	String	Site list strategy i.e., broad or precise
entity.siteIds	Number Array	Site ids associated to Id based site list. Should be null for rule based ones
entity.rules	Object Array	Site list rules for rule based ones
entity.rules[].name	String	Site name added to site list
entity.rules[].type	String	Site type
entity.insertedCount	Number	Number of sites added to sitelist i.e., in id based or rule based

Examples

Request to create an Id based site list

curl -u \<user>:\<password> -X POST -H "Content-Type: application/json" -d '\{"name":"IDBased\_SiteList","typeId":5,"siteIds":\[23,444]}' https\://sandbox-api.viant.com/v1/site-list/addNewSiteList

Response

{
  "messages":[],
  "entity":
  {
     "id":9684,
     "name":"IDBased_SiteList",
     "typeId":5,
     "Strategy":null,
     "siteIds":null,
     "rules":null,
     "insertedCount":2
  }
}

Request to create rule based site list

curl -u \<user>:\<password> -X POST -H "Content-Type: application/json" -d '\{"name":"RuleBased\_SiteList","typeId":1,"strategy":"broad","rules":\[\{"name":"abc.com","type":"web"},\{"name":"abcnews","type":"app"}] }' https\://sandbox-api.viant.com/v1/site-list/addNewSiteList

Response

{  
   "messages":[],
   "entity": 
   {
      "id":9696,
      "name":"RuleBased_SiteList",
      "typeId":1,
      "strategy":"broad",
      "siteIds":null,
      "rules":null,
      "insertedCount":2
   }
}