Bid Modifiers can be created, edited and viewed using the API. When you have created a Bid Modifier, you can use that list in the Settings > Bid Modifiers section on a Demand Tag.
This feature is available for ClearLine account types.
Creating a Bid Modifier
REST API
Method: POST
Endpoint: /api/v0/bid_modifiers
Fields:
| Field | Data Type | Required | Notes |
|---|---|---|---|
| name | string | True | Modifier title |
| description | string | False | Add your own description |
| active | bool | False | Default = true |
| modifier_rules | object array | True | At least one object required in array |
Headers
Content-Type application/json Authorization "yourAuthToken"
Body (example)
{
"name": "Test Modifier - Values",
"modifier_rules": [
{
"source_type": "values",
"multiplier": "1.05",
"modifier_rule_object": "DealIdList",
"modifier_rule_values": [
"deal_id_1",
"deal_id_2"
]
}
]
}
Response: Status code 200
{
"id": 1,
"account_id": 10,
"name": "Test Modifier - Values",
"description": null,
"active": true,
"created_at": "2023-11-15T17:29:34.969Z",
"updated_at": "2023-11-15T17:34:31.232Z",
"modifier_rules": [
{
"id": 1651,
"source_type": "values",
"multiplier": "1.05",
"modifier_rule_object": "DealIdList",
"modifier_rule_values": [
"deal_id_1",
"deal_id_2"
]
}
]
}
Get a Bid Modifier
REST API
Method: GET
Endpoint: /api/v0/bid_modifiers/<id>
Headers:
Content-Type application/json Authorization "yourAuthToken"
Response: Status code 200
{
"id": 1,
"account_id": 10,
"name": "Test Modifier - Values",
"description": null,
"active": true,
"created_at": "2023-11-15T17:29:34.969Z",
"updated_at": "2023-11-15T17:34:31.232Z",
"modifier_rules": [
{
"id": 1651,
"source_type": "values",
"multiplier": "1.05",
"modifier_rule_object": "DealIdList",
"modifier_rule_values": [
"deal_id_1",
"deal_id_2"
]
}
]
}