create_chatgpt_event_setting

ChatGPT Ads Write

Create a conversion event setting that ties a conversion event (e

Endpoint

POST https://api.adspirer.ai/api/v1/tools/create_chatgpt_event_setting/execute

Headers

Authorization: Bearer sk_live_... — your Adspirer API key (required)
Content-Type: application/json (required)
Idempotency-Key: <uuid> — recommended for write operations to make retries safe

Description

Create a conversion event setting that ties a conversion event (e.g. order_created, lead_created, or a custom event) to a pixel/CAPI Source ID. The returned Event Setting ID is what a conversions-optimized (oCPC) campaign bids toward. Cannot be deleted once created.

Request body

All tool arguments are wrapped in an arguments object.

Field	Type	Description
`name`	`string` required	Display name for this conversion (e.g. 'Purchase', 'Signup').
`event_type`	`string` required	One of: page_viewed, contents_viewed, items_added, checkout_started, order_created, lead_created, appointment_scheduled, registration_completed, subscription_created, trial_started, app_installed, app_opened, or 'custom'.
`source_id`	`string` required	The pixel/CAPI SOURCE id (cds_...) this event ties to — from create/list pixels (the pixel's 'id', not the short pixel_id). Exactly one source.
`attribution_window_days`	`integer` optional	Attribution window in days (OpenAI recommends 30). default: `30`
`custom_event_name`	`string` optional	Required only when event_type is 'custom'.

Example request

{
  "arguments": {
    "name": "string",
    "event_type": "string",
    "source_id": "string",
    "attribution_window_days": 30,
    "custom_event_name": "string"
  }
}

Example responses

200 — Success

{
  "success": true,
  "data": {
    "text": "(tool-specific textual output for create_chatgpt_event_setting)",
    "quota": {
      "used": 42,
      "limit": 150,
      "tier": "plus",
      "period_end": "2026-05-01"
    }
  },
  "tool": "create_chatgpt_event_setting"
}

400 — Tool-level error (bad arguments / multi-account selection)

{
  "success": false,
  "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n  - Acme Holdings (ad_account_id=\"act_123456789\")\n  - Acme EU (ad_account_id=\"act_987654321\")",
  "is_error": true,
  "tool": "create_chatgpt_event_setting"
}

402 — Quota exhausted

{
  "success": false,
  "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
  "is_error": true,
  "tool": "create_chatgpt_event_setting",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live

Interactive: Swagger UI

Machine-readable: OpenAPI 3.1 spec · llms-full.txt

More tools: ChatGPT Ads · All tools

Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai