...
| Field | Data Type | Required | Notes | |
|---|---|---|---|---|
| is_active | stringbool | True | List titlesets status | |
| name | string | False | Add your own descriptionTrue | Name of Deal in ClearLine |
| note | boolstring | FalseDefault = true | ||
| deal_setting_attributes | object | True | *See information for field below |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": 914,
"is_active": false,
"name": "test-deal-documentation",
"originator": false,
"note": "For API Documentation",
"created_at": "2024-09-06T21:00:32.427Z",
"updated_at": "2024-09-06T21:00:32.427Z",
"deal_setting_id": 914,
"deal_setting": {
"id": 914,
"external_deal_id": "magnite_deal_id",
"auction_type": "pg",
"gross_rate": "0.01",
"generate_external_deal_id": false,
"deleted_at": null,
"created_at": "2024-09-06T21:00:32.425Z",
"updated_at": "2024-09-06T21:00:32.425Z",
"seller_rate": null,
"gross_rate_currency": "USD",
"seller_rate_currency": "USD"
}
} |
Getting a ClearLine Deal
REST API
Method: GET
Endpoint: /api/v1/clearline_deals/<id>
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": 914,
"is_active": false,
"name": "test-deal-documentation",
"originator": false,
"note": "For API Documentation",
"created_at": "2024-09-06T21:00:32.427Z",
"updated_at": "2024-09-06T21:00:32.427Z",
"deal_setting_id": 914,
"deal_setting": {
"id": 914,
"external_deal_id": "magnite_deal_id",
"auction_type": "pg",
"gross_rate": "0.01",
"generate_external_deal_id": false,
"deleted_at": null,
"created_at": "2024-09-06T21:00:32.425Z",
"updated_at": "2024-09-06T21:00:32.425Z",
"seller_rate": null,
"gross_rate_currency": "USD",
"seller_rate_currency": "USD"
}
} |
Modifying a ClearLine Deal
REST API
Method: PUT
Endpoint: /api/v1/clearline_deals/<id>
...