Submit a JSON object in a PUT or POST request body.
Fields that are omitted or null will not be updated.
When updating a resource, you can use either PUT or POST.
You can submit only the fields of interest. Fields that are omitted ornull, will remain unchanged.
EXAMPLES
Update a field
The JSON object in the request body represents the fields to update:
{
"display_name": "Updated Test Rule Name"
}
The response contains the updated Custom Audience Rule object:
{
"id": 203,
"display_name": "Updated Test Rule Name",
"category": "ADD_TO_CART",
"status": "ACTIVE",
"type": "EVENT_BASED",
"event_name": "add-to-cart",
"condition": {
"property": null,
"predicate": null,
"value": null,
"children": []
},
"effects": [
{
"type": "REVENUE",
"data": "15"
}
],
"include_in_total_conversions": true,
"exclude_from_campaigns": false,
"description": "abc",
"advertiser_id": "taboola-demo-advertiser",
"last_modified_by": "[email protected]",
"audience_size": 12345
}
Archive a Custom Audience Rule
To archive a Custom Audience Rule, update it, and set the status to "ARCHIVED":
Unlike other objects in the Taboola Backstage API, the Custom Audience Rule
statusfield is not read-only.
{
"status": "ARCHIVED"
}
The response contains the updated Custom Audience Rule object:
{
"id": 203,
"display_name": "Test Rule Name",
"category": "ADD_TO_CART",
"status": "ARCHIVED",
"type": "EVENT_BASED",
"event_name": "add-to-cart",
"condition": {
"property": null
"predicate": "null",
"value": "null",
"children": [
]
},
"effects": [
{
"type": "REVENUE",
"data": "15"
}
],
"description": "abc",
"advertiser_id": "taboola-demo-advertiser",
"last_modified_by": "[email protected]"
}
Unarchive a Custom Audience Rule
Similarly, to unarchive a Custom Audience Rule, update it, and set the status to "ACTIVE":
{
"status": "ACTIVE"
}
As always, the response contains the updated Custom Audience Rule object:
{
"id": 203,
"display_name": "Test Rule Name",
"category": "ADD_TO_CART",
"status": "ACTIVE",
"type": "EVENT_BASED",
"event_name": "add-to-cart",
"condition": {
"property": null
"predicate": "null",
"value": "null",
"children": [
]
},
"effects": [
{
"type": "REVENUE",
"data": "15"
}
],
"description": "abc",
"advertiser_id": "taboola-demo-advertiser",
"last_modified_by": "[email protected]"
}
Exclude From ALL Campaigns
To exclude a custom audience by default, set
exclude_from_campaignsto true. (Applies to new and existing campaigns.)You can override this behavior for a given campaign by updating its Custom Audience Targeting to target this audience.