update_microsoft_keywords

Microsoft Advertising Write

Edit EXISTING keywords — match type, status (pause/resume), per-keyword bid (plain decimal account currency; pass bid:null to clear it and inherit the ad group's), dynamic-text params ("" clears) and

Endpoint

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

Headers

Description

Edit EXISTING keywords — match type, status (pause/resume), per-keyword bid (plain decimal account currency; pass bid:null to clear it and inherit the ad group's), dynamic-text params ("" clears) and URLs. ⛔ MERGE — only passed fields change. Keyword TEXT cannot change (delete + re-add to change it). Mutates LIVE keywords.

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.
ad_group_idstring requiredThe parent ad group of the keywords being edited (required).
keywordsarray requiredKeywords to edit. Each: {id (req), and any fields to change: match_type (Broad/Phrase/Exact), status (pause/resume), bid (decimal account currency; pass bid:null to clear it and inherit the ad group's), param1/2/3 ("" clears), final_urls, final_url_suffix, tracking_url_template}. ⛔ MERGE — omitted fields stay as-is. Keyword TEXT cannot be changed (delete + re-add to change it).

Example request

{
  "arguments": {
    "ad_group_id": "string",
    "keywords": [
      {}
    ],
    "account_id": "string",
    "customer_id": "string"
  }
}

Example responses

200 — Success

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

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": "update_microsoft_keywords"
}

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": "update_microsoft_keywords",
  "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