Appearance

Update Creatives ​

Endpoint ​

http
PATCH /unified/ads/creatives/{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 creative.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the label.

name
string

The name of the label.

name
string

The name of the creative.

Supported in
  • Meta Marketing API
status
string

The status of the creative.

All possible enum values:
  • active
  • deleted
  • in_process
  • with_issues
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 creative.

name
string

The name of the creative.

status
string

The status of the creative.

All possible enum values:
  • active
  • deleted
  • in_process
  • with_issues
account_id
string

The unique identifier for the account.

labels
object[]

The labels for the creative.

id
string

The unique identifier for the label.

name
string

The name of the label.

applink_treatment
string

The applink treatment for the creative.

All possible enum values:
  • automatic
  • deeplink_with_appstore_fallback
  • deeplink_with_web_fallback
  • web_only
authorization_category
string

The authorization category for the creative.

All possible enum values:
  • none
  • political
body
string

The body for the creative.

call_to_action_type
string

The call to action type for the creative.

All possible enum values:
  • open_link
  • like_page
  • shop_now
  • play_game
  • install_app
  • use_app
  • call
  • call_me
  • video_call
  • install_mobile_app
  • use_mobile_app
  • mobile_download
  • book_travel
  • listen_music
  • watch_video
  • learn_more
  • sign_up
  • download
  • watch_more
  • no_button
  • visit_pages_feed
  • apply_now
  • call_now
  • contact
  • buy_now
  • get_offer
  • get_offer_view
  • buy_tickets
  • update_app
  • get_directions
  • buy
  • send_updates
  • message_page
  • donate
  • subscribe
  • say_thanks
  • sell_now
  • share
  • donate_now
  • get_quote
  • contact_us
  • order_now
  • add_to_cart
  • start_order
  • video_annotation
  • record_now
  • inquire_now
  • confirm
  • refer_friends
  • request_time
  • get_showtimes
  • listen_now
  • woodhenge_support
  • sotto_subscribe
  • follow_user
  • raise_money
  • event_rsvp
  • whatsapp_message
  • follow_news_storyline
  • see_more
  • book_now
  • find_a_group
  • find_your_groups
  • pay_to_access
  • purchase_gift_cards
  • follow_page
  • send_a_gift
  • swipe_up_shop
  • swipe_up_product
  • send_gift_money
  • play_game_on_facebook
  • get_started
  • open_instant_app
  • audio_call
  • get_promotions
image_crops
object

The image crops for the creative.

image_hash
string

The image hash for the creative.

image_url
string

The image URL for the creative.

properties
object[]

The properties for the creative.

id
string

The unique identifier for the property.

type
string

The type for the property.

url
string

The URL for the property.

spec
object

The spec for the creative.

interactive_components
object

The interactive components for the creative.

urls
object[]

The URLs for the creative.

id
string

The unique identifier for the URL.

type
string

The type for the URL.

url
string

The URL for the URL.

created_at
string · date-time

The date and time the creative was created.

updated_at
string · date-time

The date and time the creative was last updated.

remote_data
object

Raw data returned from the remote API call.