Skip to main content
PUT
/
api
/
v1
/
campaigns
/
drafts
/
{draft_id}
/
ad-groups
/
{ad_group_id}
/
keywords
/
{keyword_id}
Update a keyword
curl --request PUT \
  --url http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups/{ad_group_id}/keywords/{keyword_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "match_type": "EXACT",
  "cpc_bid_micros": 123,
  "final_url": "<string>"
}
'
{
  "id": 123,
  "text": "<string>",
  "match_type": "EXACT",
  "cpc_bid_micros": 25000000000,
  "final_url": "<string>",
  "source_market_analysis_keyword_id": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
draft_id
integer
required
​
ad_group_id
integer
required
​
keyword_id
integer
required

Query Parameters

​
regenerate_rsas
boolean
default:true

Auto-regenerate RSAs if keyword text changed

Body

application/json

Request to update a keyword.

​
text
string | null
Required string length: 1 - 80
​
match_type
enum<string> | null

The keyword match types.

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
​
cpc_bid_micros
integer | null
​
final_url
string<uri> | null
Required string length: 1 - 2083

Response

Successful Response

Keyword within a draft ad group.

​
id
integer
required
​
text
string
required
​
match_type
enum<string>
required

The keyword match types.

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
​
cpc_bid_micros
integer | null
Required range: 0 <= x <= 50000000000
​
final_url
string<uri> | null
Required string length: 1 - 2083
​
source_market_analysis_keyword_id
integer | null