Skip to main content
PUT
/
api
/
v1
/
campaigns
/
drafts
/
{draft_id}
/
ad-groups
/
{ad_group_id}
/
rsas
/
{rsa_id}
Update an RSA
curl --request PUT \
  --url http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups/{ad_group_id}/rsas/{rsa_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "headlines": [
    {
      "text": "<string>",
      "pinned_field": "HEADLINE_1",
      "reason": "<string>"
    }
  ],
  "descriptions": [
    {
      "text": "<string>",
      "pinned_field": "HEADLINE_1",
      "reason": "<string>"
    }
  ],
  "final_url": "<string>",
  "final_mobile_url": "<string>",
  "display_path_1": "<string>",
  "display_path_2": "<string>",
  "tracking_url_template": "<string>"
}
'
{
  "id": 123,
  "ad_group_id": 123,
  "headlines": [
    {
      "text": "<string>",
      "pinned_field": "HEADLINE_1",
      "reason": "<string>"
    }
  ],
  "descriptions": [
    {
      "text": "<string>",
      "pinned_field": "HEADLINE_1",
      "reason": "<string>"
    }
  ],
  "final_url": "<string>",
  "final_mobile_url": "<string>",
  "display_path_1": "<string>",
  "display_path_2": "<string>",
  "tracking_url_template": "<string>",
  "generation_status": "pending",
  "generation_task_id": "<string>",
  "generation_error": "<string>"
}

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
rsa_id
integer
required

Body

application/json

Request to update an RSA.

headlines
GeneratedHeadlineSchema · object[] | null
descriptions
GeneratedDescriptionSchema · object[] | null
final_url
string<uri> | null
Required string length: 1 - 2083
final_mobile_url
string<uri> | null
Required string length: 1 - 2083
display_path_1
string | null
Maximum string length: 15
display_path_2
string | null
Maximum string length: 15
tracking_url_template
string | null

Response

Successful Response

RSA within a campaign draft ad group.

id
integer
required
ad_group_id
integer
required
headlines
GeneratedHeadlineSchema · object[]
descriptions
GeneratedDescriptionSchema · object[]
final_url
string<uri> | null
Required string length: 1 - 2083
final_mobile_url
string<uri> | null
Required string length: 1 - 2083
display_path_1
string | null
display_path_2
string | null
tracking_url_template
string | null
generation_status
enum<string>
default:pending

Status of background task generation (ad groups, RSAs).

Available options:
not_started,
pending,
in_progress,
completed,
failed
generation_task_id
string | null
generation_error
string | null