v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB

keywords

Update keywords

Update one or more keywords' bid and archived fields. Archiving a keyword effectively deletes it - keywords no longer receive metrics and are no longer visible within the parent entity's keywords list.

patch/ad_accounts/{ad_account_id}/keywords

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

Example request

{
  "keywords": [
    {
      "id": "383791336903426391"
    }
  ]
}

Response

The request has succeeded.

Example response

{
  "errors": [
    {
      "data": {
        "id": "383791336903426391",
        "match_type": "BROAD",
        "parent_id": "383791336903426391",
        "parent_type": "campaign",
        "type": "keyword"
      }
    }
  ],
  "keywords": [
    {
      "id": "383791336903426391",
      "match_type": "BROAD",
      "parent_id": "383791336903426391",
      "parent_type": "campaign",
      "type": "keyword"
    }
  ]
}