Appearance

Update Ads ​

Endpoint ​

http
PATCH /unified/ads/ads/{id}
Integrations supported
  • Meta Marketing API

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

account_id
string

The unique identifier for the account.

Supported in
  • Meta Marketing API
labels
object[]

The labels for the ad.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the label.

name
string

The name of the label.

ad_group_id
string

The unique identifier for the ad_group.

Supported in
  • Meta Marketing API
bid
object

The bid for the ad.

Supported in
  • Meta Marketing API
adjustments
object

The bid adjustments for the ad.

amount
string

The bid amount for the ad.

constraints
object

The bid constraints for the ad.

objective_values
object

The bid values for different objectives of the ad.

strategy
object

The bid strategy for the ad.

id
string

The unique identifier for the bid strategy.

name
string

The name of the bid strategy.

conversion_domain
string

The conversion domain for the ad.

Supported in
  • Meta Marketing API
creative_id
string[]

The unique identifier for the creative.

Supported in
  • Meta Marketing API
name
string

The name of the ad.

Supported in
  • Meta Marketing API
status
string

The status of the ad.

All possible enum values:
  • active
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
  • campaign_paused
  • pending_review
  • disapproved
  • preapproved
  • pending_billing_info
  • adset_paused
Supported in
  • Meta Marketing API
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for the ad.

name
string

The name of the ad.

type
string

The type of the ad

status
string

The status of the ad.

All possible enum values:
  • active
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
  • campaign_paused
  • pending_review
  • disapproved
  • preapproved
  • pending_billing_info
  • adset_paused
account_id
string

The unique identifier for the account.

ad_group_id
string

The unique identifier for the ad_group.

campaign_id
string

The unique identifier for the campaign.

labels
object[]

The labels for the ad.

id
string

The unique identifier for the label.

name
string

The name of the label.

schedule
object

The schedule for the ad.

end_time
string · date-time

The end time for the ad.

start_time
string · date-time

The start time for the ad.

bid
object

The bid for the ad.

adjustments
object

The bid adjustments for the ad.

amount
string

The bid amount for the ad.

constraints
object

The bid constraints for the ad.

objective_values
object

The bid values for different objectives of the ad.

strategy
object

The bid strategy for the ad.

id
string

The unique identifier for the bid strategy.

name
string

The name of the bid strategy.

conversion_domain
string

The conversion domain for the ad.

creative
object

The creative for the ad.

creative_id
string[]

The unique identifier for the creative.

issues
object[]

The issues for the ad that prevented the ad from being delivered.

code
string

The code for the issue.

message
string

The error message for the issue.

description
string

The error summary for the issue.

level
string

The level for the issue.

type
string

The type for the issue.

preview_url
object[]

The preview URL for the ad.

url
string

The URL for the preview.

type
string

The type for the preview.

tracking_specs
object[]

The tracking specs for the ad.

created_at
string · date-time

The date and time the ad was created.

updated_at
string · date-time

The date and time the ad was last updated.

remote_data
object

Raw data returned from the remote API call.