create_microsoft_conversion_goals

Microsoft Advertising Write

Create conversion goals (Url, Event, Duration, PagesViewedPerVisit, AppInstall, OfflineConversion, InStoreTransaction) on a UET tag, with optional revenue and attribution settings

Endpoint

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

Headers

Description

Create conversion goals (Url, Event, Duration, PagesViewedPerVisit, AppInstall, OfflineConversion, InStoreTransaction) on a UET tag, with optional revenue and attribution settings. These define what counts as a conversion for bidding + reporting. Creating one auto-enables MSCLKID auto-tagging. Creates live goals via the Microsoft API.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
account_idstring optionalMicrosoft Advertising ad account id (numeric AccountId — NOT the 8-character account number shown in the UI). Get it from list_microsoft_accounts. Required when more than one account is connected; may be omitted with exactly one. `customer_id` is accepted as an alias. If the tool replies that several accounts are connected, re-run with this set — that reply is NOT a connection problem.
customer_idstring optionalAlias of account_id.
conversion_goalsarray requiredConversion goals to create. Each needs {type, name, tag_id (a UET tag id)} plus the per-type fields: - UrlGoal {url_expression (req), url_operator? (Contains/Equals/BeginsWith/RegularExpression)} - DurationGoal {minimum_duration_in_seconds (req)} - PagesViewedPerVisitGoal {minimum_pages_viewed (req)} - EventGoal {action_expression/operator?, category_expression/operator?, label_expression/operator?, value?, value_operator?} - AppInstallGoal / AppDownloadGoal {app_platform (req), app_store_id (req)} - OfflineConversionGoal {is_externally_attributed?} - InStoreTransactionGoal {} (no extra) Common optional: revenue (a number = fixed value, or {value, currency_code, type: NoValue/FixedValue/VariableValue}; plain decimal, no scaling), count_type (All/Unique), goal_category, scope (Account/Customer), status (Active/Paused), conversion_window_in_minutes, view_through_conversion_window_in_minutes, exclude_from_bidding, attribution_model_type. ⛔ Adding a Url/Event/Duration/PagesViewed/Offline goal auto-enables MSCLKID auto-tagging (needed for offline + CAPI attribution).

Example request

{
  "arguments": {
    "conversion_goals": [
      {}
    ],
    "account_id": "string",
    "customer_id": "string"
  }
}

Example responses

200 — Success

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

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_microsoft_conversion_goals"
}

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_microsoft_conversion_goals",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live


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