Update App List
Use this API to add or remove the app_bundles and/or placement_ids in an existing App List
See below for supported URL parameters
Field | Type | Required/ Optional | Description |
---|---|---|---|
id | int | required | App List Id received with the List App Lists / View App List API |
action | string | required | Action which needs to be performed with the sent body in the request. Allowed Values - 'add' / 'remove' |
See below for supported body parameters
Field | Type | Required/ Optional | Description |
---|---|---|---|
app_bundles | string | conditionally required | Comma separated app_bundles, either of app_bundles or placement_id should have value. Maximum 10,000 app_bundles can be present in an App List. |
placement_ids | string | conditionally required | Comma separated placement_ids, either of app_bundles or placement_id should have value. Exchange in placement id should exist. Maximum 10,000 placement_ids can be present in an App List. |
Sample for adding app_bundles and placement_ids to an existing App List
curl --location --request PATCH 'https://api.kayzen.io/v1/app_list/9101/add' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
--header 'Content-Type: application/json' \
--data '{
"app_bundles": "com.rovio.baba,com.Seriously.BestFiends",
"placement_ids": "10064-595558412,10064-123458412"
}'
{
"id": 9101,
"name": "Hypercasual Apps",
"description": "These are the top hypercasual apps",
"placement_ids": "10064-595558452,10064-620bb0080b6,10064-5b0bc90385,10064-5f08659e089,10064-5e74cbc777,10064-5e64cbc098,10064-5e24cbc1281,10064-5e74cbccdhs,10064-5ej4cbcbchx,10064-5e94cbc787,10064-595558412,10064-123458412",
"app_bundles": "com.king.candycrushsaga,com.funzilla.bullet.stack,com.ht2.stick.hero,com.popreach.dumbways,com.playrix.gardenscapes,com.pronetis.ironball2,com.playrix.township,com.ht2.stick.hero,com.MelsoftGames.FamilyIslandFarm,com.playrix.homescapes,com.rovio.baba,com.Seriously.BestFiends",
"has_associated_campaigns": false
}
Sample for removing app_bundles / placement_ids from an existing App List
curl --location --request PATCH 'https://api.kayzen.io/v1/app_list/9101/remove' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
--header 'Content-Type: application/json' \
--data '{
"app_bundles": "com.rovio.baba,com.Seriously.BestFiends",
"placement_ids": "10064-595558412,10064-123458412"
}'
{
"id": 9101,
"name": "Hypercasual Apps",
"description": "These are the top hypercasual apps",
"placement_ids": "10064-595558452,10064-620bb0080b6,10064-5b0bc90385,10064-5f08659e089,10064-5e74cbc777,10064-5e64cbc098,10064-5e24cbc1281,10064-5e74cbccdhs,10064-5ej4cbcbchx,10064-5e94cbc787",
"app_bundles": "com.king.candycrushsaga,com.funzilla.bullet.stack,com.ht2.stick.hero,com.popreach.dumbways,com.playrix.gardenscapes,com.pronetis.ironball2,com.playrix.township,com.ht2.stick.hero,com.MelsoftGames.FamilyIslandFarm,com.playrix.homescapes",
"has_associated_campaigns": false
}
See below for the response codes
HTTP Status Code | Response | |
---|---|---|
Success | 200 | JSON body containing updated details about the App List |
Error | 400, 422 | JSON body containing the error details |
Updated 10 days ago