ads
ad

Update an ad

patch/ads/{connection_id}/ad/{id}

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Ad

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time
updated_atstring date-time
namestring
campaign_idstring
group_idstring
organization_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
ad_type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH'
advertiser_namestring
creative_idsstring[]
creative_asset_urlstring
ad_copystring
headlinestring
descriptionstring
ctastring
final_urlstring
display_urlstring
path1string
path2string
logo_creative_idstring
rawobject

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
campaign_idstring
group_idstring
organization_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
ad_type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH'
advertiser_namestring
creative_idsstring[]
creative_asset_urlstring
ad_copystring
headlinestring
descriptionstring
ctastring
final_urlstring
display_urlstring
path1string
path2string
logo_creative_idstring
rawobject

Changes

Changed in 2 of the 25 revisions of this API.39

  • 963bcc74f9e333See the full diff
    • added the new CTV enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DOOH enum value to the response property for the response status

      response-property-enum-value-added

    • added the new NATIVE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CTV enum value to the request property

      request-property-enum-value-added

    • added the new DOOH enum value to the request property

      request-property-enum-value-added

    • added the new NATIVE enum value to the request property

      request-property-enum-value-added

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the enum value advertiser_name to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • added the enum value logo_creative_id to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added