Appearance

Update Ad groups ​

Endpoint ​

http
PATCH /unified/ads/ad_groups/{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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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

labels
object[]

The labels for the ad_group.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the label.

name
string

The name of the label.

schedule
object

The schedule for the ad_group.

Supported in
  • Meta Marketing API
start_time
string · date-time

The start time for the ad_group.

end_time
string · date-time

The end time for the ad_group.

days
string[]

The days for the ad_group.

All possible enum values:
  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
attribution_spec
string

The attribution spec for the ad_group.

Supported in
  • Meta Marketing API
bid
object

The bid for the ad_group.

Supported in
  • Meta Marketing API
adjustments
object

The bid adjustments for the ad_group.

amount
string

The bid amount for the ad_group.

constraints
object

The bid constraints for the ad_group.

objective_values
object

The bid values for different objectives of the ad_group.

strategy
object

The bid strategy for the ad_group.

id
string

The unique identifier for the bid strategy.

name
string

The name of the bid strategy.

billing_event
string

The billing event for the ad_group.

All possible enum values:
  • app_installs
  • clicks
  • impressions
  • link_clicks
  • none
  • offer_claims
  • page_likes
  • post_engagement
  • video_views
Supported in
  • Meta Marketing API
budget
object

The budget for the ad_group.

Supported in
  • Meta Marketing API
lifetime_max
string

The max budget for the ad_group.

daily_max
string

The daily max budget for the ad_group.

daily_min
string

The daily min budget for the ad_group.

spend
object

The spend for the ad_group.

Supported in
  • Meta Marketing API
lifetime_max
string

The max spend for the ad_group.

daily_min_cap
string

The min cap spend for the ad_group.

daily_max_cap
string

The max cap spend for the ad_group.

cap_enabled
boolean

Whether the cap is enabled for the ad_group.

destination
object

The destination type for the ad_group.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the destination type.

name
string

The name of the destination type.

All possible enum values:
  • undefined
  • app
  • messenger
  • website
  • instagram_direct
  • on_ad
  • on_post
  • on_video
  • on_page
  • on_event
name
string

The name of the ad_group.

Supported in
  • Meta Marketing API
stop_time
string · date-time

The stop time for the ad_group.

Supported in
  • Meta Marketing API
optimization_goal
string

The optimization goal for the ad_group.

All possible enum values:
  • none
  • app_installs
  • ad_recall_lift
  • clicks
  • engaged_users
  • event_responses
  • impressions
  • lead_generation
  • quality_lead
  • link_clicks
  • offsite_conversions
  • page_likes
  • post_engagement
  • quality_call
  • reach
  • landing_page_views
  • visit_instagram_profile
  • value
  • thruplay
  • derived_events
  • app_installs_and_offsite_conversions
  • conversations
Supported in
  • Meta Marketing API
promoted_object
object

The promoted object for the ad_group.

Supported in
  • Meta Marketing API
start_time
string · date-time

The start time for the ad_group.

Supported in
  • Meta Marketing API
status
string

The status of the campaign.

All possible enum values:
  • active
  • inactive
  • draft
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
  • completed
  • canceled
  • pending_deletion
Enum support by integration
  • Meta Marketing API
    • paused
Supported in
  • Meta Marketing API
targeting
object

The targeting for the ad_group.

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_group.

name
string

The name of the ad_group.

status
string

The status of the campaign.

All possible enum values:
  • active
  • inactive
  • draft
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
  • completed
  • canceled
  • pending_deletion
account_id
string

The unique identifier for the account.

campaign_id
string

The unique identifier for the campaign.

labels
object[]

The labels for the ad_group.

id
string

The unique identifier for the label.

name
string

The name of the label.

attribution_spec
string

The attribution spec for the ad_group.

bid
object

The bid for the ad_group.

adjustments
object

The bid adjustments for the ad_group.

amount
string

The bid amount for the ad_group.

constraints
object

The bid constraints for the ad_group.

objective_values
object

The bid values for different objectives of the ad_group.

strategy
object

The bid strategy for the ad_group.

id
string

The unique identifier for the bid strategy.

name
string

The name of the bid strategy.

billing_event
string

The billing event for the ad_group.

All possible enum values:
  • app_installs
  • clicks
  • impressions
  • link_clicks
  • none
  • offer_claims
  • page_likes
  • post_engagement
  • video_views
budget
object

The budget for the ad_group.

lifetime_max
string

The max budget for the ad_group.

daily_max
string

The daily max budget for the ad_group.

daily_min
string

The daily min budget for the ad_group.

spend
object

The spend for the ad_group.

lifetime_max
string

The max spend for the ad_group.

daily_min_cap
string

The min cap spend for the ad_group.

daily_max_cap
string

The max cap spend for the ad_group.

cap_enabled
boolean

Whether the cap is enabled for the ad_group.

impressions
object

The impressions for the ad_group.

daily_min
string

The daily min impressions for the ad_group.

lifetime_max
string

The max impressions for the ad_group.

destination
object

The destination type for the ad_group.

id
string

The unique identifier for the destination type.

name
string

The name of the destination type.

All possible enum values:
  • undefined
  • app
  • messenger
  • website
  • instagram_direct
  • on_ad
  • on_post
  • on_video
  • on_page
  • on_event
start_time
string · date-time

The start time for the ad_group.

stop_time
string · date-time

The stop time for the ad_group.

issues
object[]

The issues for the ad_group that prevented ads 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.

optimization_goal
string

The optimization goal for the ad_group.

All possible enum values:
  • none
  • app_installs
  • ad_recall_lift
  • clicks
  • engaged_users
  • event_responses
  • impressions
  • lead_generation
  • quality_lead
  • link_clicks
  • offsite_conversions
  • page_likes
  • post_engagement
  • quality_call
  • reach
  • landing_page_views
  • visit_instagram_profile
  • value
  • thruplay
  • derived_events
  • app_installs_and_offsite_conversions
  • conversations
promoted_object
object

The promoted object for the ad_group.

targeting
object

The targeting for the ad_group.

targeting_optimization_types
object[]
key
string

The key for the targeting optimization type.

value
string

The value for the targeting optimization type.

schedule
object

The schedule for the ad_group.

start_time
string · date-time

The start time for the ad_group.

end_time
string · date-time

The end time for the ad_group.

days
string[]

The days for the ad_group.

All possible enum values:
  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
created_at
string · date-time

The date and time the ad_group was created.

updated_at
string · date-time

The date and time the ad_group was last updated.

remote_data
object

Raw data returned from the remote API call.