Edit Campaign
To edit the campaigns
PATCH /api/v1/campaigns/:id/edit
Use this API to update the properties of the specified campaign.
See below for supported fields and param.
Field | Param | Required/ Optional | Description |
---|---|---|---|
target_bid | float | optional | The target value to achieve based on your campaign optimization type |
day_budget | int | optional | The maximum amount of money to spend in one day on the campaign |
total_budget | int | optional | The total amount of money to spend on the campaign |
curl -X "PUT" "https://api.kayzen.io/v1/campaigns/12345/edit" \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d $'{
"target_bid": 250.5,
"day_budget": 200,
"total_budget": 5000
}'
{
"status": "paused",
"id": 123,
"name": "Test",
"detail_id": 123,
"is_active": false,
"order_active": true,
"has_running_creatives": true,
"creative_statuses": ["paused", "paused", "paused", "running"],
"exchange_statuses": ["approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved", "approved"],
"start_time": "2019-01-28T12:35:31.000Z",
"end_time": "2038-01-01T00:00:00.000Z",
"cap_type": "none",
"budget_cap_amount": null,
"budget_cap_interval": null,
"objective_cap_amount": null,
"objective_cap_interval": null,
"cloned_from": 0,
"creative_type": "javascript",
"billing_type": null,
"billing_price": 0.0,
"creative_ids": [12345, 122435, 12345, 1252552],
"updated_at": "2022-11-06T17:22:27.000Z",
"created_at": "2019-01-28T11:36:52.000Z",
"tags": [],
"bid_multipliers_enabled": true,
"skan_enabled": false,
"app_group_id_whitelist": null,
"app_group_id_blacklist": null,
"total_budget": 5000,
"target_bid": 250.5,
"day_budget": 200,
"campaign_type": "cpm",
"modified_by": {
"id": 123,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"company": "Kayzen",
"time_zone": "UTC",
"status": "active",
"created_at": "2022-06-08T12:03:15.000Z",
"external": false,
"system_role": "platform_admin",
"has_ad_quality_access": false,
"email_notifications_enabled": false,
"registered_at": "2022-06-09",
"role": null
},
"created_by": {
"id": 123,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"company": "Kayzen",
"time_zone": "UTC",
"status": "active",
"created_at": "2018-06-29T08:40:59.000Z",
"external": false,
"system_role": "platform_admin",
"has_ad_quality_access": false,
"email_notifications_enabled": true,
"registered_at": "2018-06-29",
"role": null
},
"advertiser": {
"id": 123123,
"name": "Kayzen",
"created_at": "2018-12-06T14:33:33.000Z",
"status": "active",
"rtb_margin": "0.0",
"advertiser_office_id": 2,
"conversion_objects": [{
"id": 123123,
"name": "CO_sale",
"drp_event_id": 12434,
"attribution_type": "total",
"attribution_source": "mmp",
"one_conversion_per_user_in_x_days": 0,
"advertiser_id": 1234,
"user_as_unique_for_next_x_days": 1
}],
"s2s_enabled": true,
"mobile_object_enabled": false,
"advertiser_api_key": {
"id": 1234,
"api_key": "sdsaff",
"api_secret": "asdsfsaf",
"advertiser_id":12342,
"created_at": "2018-12-06T14:33:34.000Z",
"updated_at": "2019-03-06T10:46:50.000Z"
},
"multiple_pixel_url_allowed": true,
"vast_3_enabled": true
},
"enterprise": {
"id": 123123,
"name": "Kayzen",
"created_at": "2018-12-05T15:23:14.000Z"
},
"geolocations": [],
"bid_values": []
}
Updated 10 months ago