Skip to main content

​
✨ Create a Campaign

Creates a new campaign.

​
📤 Request Example

curl -X POST https://betaapi.audiohook.com/v2/companies/:companyUUID/campaigns \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "request_headers": [
      { "name": "X-Request-Header", "value": "Header value" }
    ],
    "body": {
      "draft": false,
      "campaign_type": 1,
      "name": "Test campaign Docs",
      "pacing": 5,
      "status": false,
      "budget_type": 1,
      "budget_value": 1,
      "start_date": "2023-02-15",
      "end_date": "2023-02-16",
      "advertiser_id": "test-advertiser-uuid"
    }
  }'

​
🌐 HTTP Request

POST /v2/companies/:companyUUID/campaigns

​
🧾 Body Parameters

ParameterRequiredTypeDescription
draft✅booleanDraft mode enabled or not.
campaign_type✅intType of campaign: 1 - Impression, 2 - CPA.
name✅stringName of the campaign.
pacing✅intPacing strategy: 1 to 6.
status✅booleanIf the campaign is active.
budget_type✅intBudget type: 1 - Dollars, 2 - Impressions.
budget_value✅intBudget amount.
start_date✅stringStart date (format: Y-M-D).
end_date✅stringEnd date (format: Y-M-D).
advertiser_id✅stringUUID of advertiser.
audiences❌arraySelected audience list.
dayparting_enabled❌booleanWhether dayparting is enabled.
dayparting❌arrayDayparting info.
geo_ui❌arrayGeographic targeting list.
google_places❌arrayGoogle Places API raw info.
devices_enabled❌booleanWhether device targeting is enabled.
brand_safety_filter❌objectBrand safety preferences.
creatives❌arrayCreative weights or priorities.
auto_optimized❌booleanAuto optimization flag.
conversion_type❌intConversion type.
conversion_value❌floatConversion value.
goal_optimization❌stringOptimization goal: no, partial, full.