Request

POST /site-list/appendToSiteList

Request Body

Name	Type	Description	Required
id	Number	Site list id	Yes
name	String	Site list name	Yes
siteIds	Number Array	Sites that are appending to site list	Yes, if appending sites to id based sitelist
rules	Object Array	An array of rules to be added to sitelist	Yes, if appending rules to rule based sitelist
rules[].name	String	Rule name	Yes, if rules is included
rules[].type	String	Sites 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 appended to sitelist i.e., in ID based or rule based

Examples

Request to append sites to Id based site list

curl -u \<user>:\<password> -X POST -H "Content-Type: application/json" -d '\{"id":8988,"name":"Viant\_IDBased\_SiteList\_1","siteIds":\[444,497080] }' https\://sandbox-api.viant.com/v1/site-list/appendToSiteList

Response

{  
   "messages":[],
   "entity":
   {
     "id":8988,
     "name":"Viant_IDBased_SiteList",
     "typeId":5,
     "strategy":null,
     "siteIds":null,
     "rules":null,
     "insertedCount":1
   }
}

Request to append sites to rule based site list

curl -u \<user>:\<password> -X POST -H "Content-Type: application/json" -d '\{"id":6004,"name":"test1","rules":\[\{"name":"oracle.com","type":"web"}]}' https\://sandbox-api.viant.com/v1/site-list/appendToSiteList

Response

{  
   "messages":[],
   "entity":
   {
     "id":6004,
     "name":"test1",
     "typeId":1,
     "strategy":"precise",
     "siteIds":null,
     "rules":null,
     "insertedCount":1
   }
}