Ads · Ad Campaigns

Pause or enable a Search keyword

Pauses or enables a Search keyword. Works with Google Ads.

PATCHhttps://api.pozy.ai/v1/ads/keywords/{keywordId}

Google WorkspaceupdateAdKeyword

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`keywordId`required	string

Request body

application/json, required

statusstringrequired
One of active, paused.

Example

curl -X PATCH "https://api.pozy.ai/v1/ads/keywords/60156aec0ea6dde737c0c631" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active"
}'

const res = await fetch("https://api.pozy.ai/v1/ads/keywords/60156aec0ea6dde737c0c631", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    status: "active"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.patch(
    "https://api.pozy.ai/v1/ads/keywords/60156aec0ea6dde737c0c631",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "status": "active",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

keywordobject
21 child fields
- idstring
- platformCriterionIdstring
- resourceNamestring
- accountIdstring
- profileIdstring
- platformstring
  One of google.
- adAccountIdstring
- campaignIdstring
- campaignNamestring
  Can be null.
- campaignStatusstring
  Can be null.
- adSetIdstring
- adSetNamestring
  Can be null.
- adSetStatusstring
  Can be null.
- keywordstring
- matchTypestring
  One of exact, phrase, broad, unknown.
- statusstring
  One of active, paused.
- negativeboolean
- qualityScoreinteger
  Can be null.
- qualityobject
  4 child fields
  scoreinteger
  Can be null.
  expectedCtrstring
  One of BELOW_AVERAGE, AVERAGE, ABOVE_AVERAGE. Can be null.
  adRelevancestring
  One of BELOW_AVERAGE, AVERAGE, ABOVE_AVERAGE. Can be null.
  landingPageExperiencestring
  One of BELOW_AVERAGE, AVERAGE, ABOVE_AVERAGE. Can be null.
- syncedAtstring (date-time)
  Can be null.
- metricsobject
  Can be null.
  7 child fields
  windowDaysinteger
  clicksinteger
  impressionsinteger
  costnumber
  conversionsnumber
  firstPageCpcnumber
  Can be null.
  firstPositionCpcnumber
  Can be null.

200 response

{
  "keyword": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformCriterionId": "6882078ac440c35a806f87dc",
    "resourceName": "Acme",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "google",
    "adAccountId": "666219aad7bab67ace411e4f",
    "campaignId": "65a3737dd8b11ea61f199e6e",
    "campaignName": "Acme",
    "campaignStatus": "active",
    "adSetId": "60484b408d44e7c2492bfec5",
    "adSetName": "Acme",
    "adSetStatus": "active",
    "keyword": "string",
    "matchType": "exact",
    "status": "active",
    "negative": true,
    "qualityScore": 1,
    "quality": {
      "score": 1,
      "expectedCtr": "BELOW_AVERAGE",
      "adRelevance": "BELOW_AVERAGE",
      "landingPageExperience": "BELOW_AVERAGE"
    },
    "syncedAt": "2026-10-02T09:00:00.000Z",
    "metrics": {
      "windowDays": 1,
      "clicks": 1,
      "impressions": 1,
      "cost": 12.5,
      "conversions": 12.5,
      "firstPageCpc": 12.5,
      "firstPositionCpc": 12.5
    }
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Ad Campaigns

GETList ads GETList Google Ads recommendations POSTApply Google Ads recommendations POSTDismiss Google Ads recommendations GETList portfolio bid strategies POSTCreate portfolio bid strategy PATCHUpdate portfolio bid strategy GETList shared budgets POSTCreate a shared budget GETList Search keywords POSTAdd Search ad-group keywords DELRemove a Search keyword GETList campaigns POSTCreate a standalone campaign PUTPause or resume a campaign GETRead a campaign's ad schedule (dayparting)PUTReplace a campaign's ad schedule (dayparting)GETRead a campaign's current bidding GETGet live campaign details PUTUpdate a campaign DELDelete a campaign GETList campaign-level negative keywords PUTReplace campaign-level negative keywords POSTPause or resume many campaigns POSTDuplicate a campaign GETRead a Google campaign's device, location, excluded location, and language targeting PUTEdit a Google campaign's device, location, excluded location, or language targeting GETList ad sets POSTCreate a standalone ad group POSTDuplicate an ad set POSTDuplicate an ad GETGet live ad-set details PUTUpdate an ad set DELDelete an ad set GETRead a Reddit ad group's targeting and schedule PUTPause or resume a single ad set GETGet campaign tree GETGet daily account metrics GETGet ad details PUTUpdate ad DELCancel an ad PUTPause or resume a single ad GETList campaign assets POSTAttach campaign assets PUTUpdate campaign assets DELRemove campaign assets GETList ad-group assets POSTAttach ad-group assets PUTUpdate ad-group assets DELRemove ad-group assets GETRead the platform's review verdict for an ad GETReview status of each creative in a TikTok Smart+ ad GETList ads that need attention POSTDismiss an ads alert GETReview status of every TikTok Smart+ ad of an advertiser GETList campaign negative lists PUTReplace campaign negative lists POSTBoost post as ad GETList Performance Max asset groups POSTCreate a Performance Max asset group GETGet a Performance Max asset group PATCHUpdate a Performance Max asset group DELRemove a Performance Max asset group POSTLink or unlink asset group assets PUTReplace an asset group's listing-group tree POSTCreate standalone ad GETGet campaign conversion goals PATCHUpdate campaign conversion goals