Campaigns
Execute an approved campaign
Launches the campaign with simulated delivery. Refuses with APPROVAL_REQUIRED if no approval is on record.
Authorization
HTTPBearer AuthorizationBearer <token>
JWT access token
In: header
Path Parameters
campaign_id*string
Format
uuidQuery Parameters
merchant_id?|
Optional merchant to act on. Must be one you are a member of.
Format
uuidHeader Parameters
X-Merchant-ID?string|null
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/execute"{ "data": { "actions": [ { "action_type": "string", "actor_label": "string", "actor_type": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_simulated": true, "payload": {} } ], "actual_cost": 0, "actual_incremental_revenue": 0, "agent_run_id": "c3317f32-e28b-4af1-a584-86ac8c788dd8", "approved_at": "2019-08-24T14:15:22Z", "audiences": [ { "definition": {}, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "role": "TEST", "size": 0 } ], "budget": 0, "business_budget": 0, "channel": "paypal_app", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by_agent": "", "end_date": "2019-08-24", "estimated_cost": 0, "estimated_impact": 0, "expected_incremental_revenue": 0, "experiment_id": "916afd89-cac5-4339-9c59-dd068abdfa69", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "incremental_roi": 0, "is_simulated": true, "launched_at": "2019-08-24T14:15:22Z", "measurement_status": "", "message": "string", "name": "string", "objective": "string", "objective_type": "RETENTION", "offer_description": "string", "offer_type": "COMBO", "offer_value": 0, "opportunity_id": "5c7fee95-8917-4b3c-8649-bbbc4ef0c4f7", "paypal_budget": 0, "paypal_surface": "", "provenance": { "data_source": "SEEDED", "is_simulated": true, "note": "Seeded demo dataset - not computed from a live PayPal merchant account." }, "rejected_reason": "string", "requires_approval": true, "start_date": "2019-08-24", "status": "DRAFT", "surface": "BUSINESS", "tags": [ "string" ], "updated_at": "2019-08-24T14:15:22Z" }, "meta": {}, "success": true}