Skip to main content
PUT
/
api
/
v1
/
analysis
/
recommendations
/
{analysis_type}
/
{recommendation_id}
/
update
Update Recommendation
curl --request PUT \
  --url http://localhost:8000/api/v1/analysis/recommendations/{analysis_type}/{recommendation_id}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_updated_text": "<string>"
}
'
{
  "is_manually_generated": true,
  "keyword": "<string>",
  "match_type": "<string>",
  "reason": "<string>",
  "campaign": {
    "id": 123,
    "name": "<string>",
    "status": "<string>"
  },
  "date_regenerated": "2023-11-07T05:31:56Z",
  "date_added": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "id": 123,
  "budget_saving": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
analysis_type
enum<string>
required

The types of analyses.

Available options:
keyword_pause,
negative_keyword,
double_check_keywords_to_pause,
headline,
description,
budget_migration,
pause_hours,
pause_locations,
search_terms
​
recommendation_id
integer
required

Body

application/json

The schema for updating a recommendation text.

​
user_updated_text
string
required

Response

Successful Response

The schema for recommended negative keywords.

​
status
enum<string>
required

The status of a recommendation.

Available options:
pending,
applied,
auto_applied,
rejected
​
is_manually_generated
boolean
required
​
keyword
string
required
​
match_type
string
required
​
reason
string
required
​
campaign
The campaign · object
required

Schema for campaign information related to a keyword

​
date_regenerated
string<date-time> | null
​
date_added
string<date-time> | null
​
date_updated
string<date-time> | null
​
id
integer | null
​
budget_saving
number | null