Skip to main content

Meta Ads Component

Interact with ads and adsets in your Meta Ads account.

Component key: facebook-marketing

Changelog ↓

Description

Meta Ads (Formerly known as Facebook Marketing) is a digital advertising platform that allows businesses to create, manage, and optimize ads across Meta products, including Facebook, Instagram, and WhatsApp.

API Documentation

This component was built using the Meta Ads Marketing API Reference utilizing version V22.0

Connections

Conversions API Access Token

InputNotesExample
Access Token

A valid access token for Meta Ads API

Meta Ads Client Credentials

InputNotesExample
Authorize URL

Provide a valid authURL for Meta Ads

https://www.facebook.com/v22.0/dialog/oauth
App Id

Provide the App Id that was generated from your Meta Ads App.

1233096058094633
App Secret

Provide the App Secret that was generated from your Meta Ads App.

7699008007296c1689ddd30b0cf7c924
Scopes

Provide a valid list of scopes. A list per use case is provided on the Meta Ads docs: https://developers.facebook.com/docs/marketing-api/overview/authorization/

ads_read ads_management pages_show_list groups_access_member_info leads_retrieval page_events pages_read_user_content public_profile
Token URL

Provide a valid Meta Ads version to complete the Token URL

https://graph.facebook.com/v22.0/oauth/access_token

Meta Ads Oauth 2.0

This component uses OAuth 2.0 to connect to the Meta Ads Marketing API. To get started with Meta Ads, you first need to create a developer account.

  1. Select Create app, take note of the App Id and App Secret under the basic tab.
  2. Navigate to the Facebook Login Section:
    1. Under the Valid OAuth Redirect URIs section add https://oauth2.prismatic.io/callback as a Redirect URI.
  3. Now add a new Meta Ads action to your flow, and you will see a new connection.
  4. Enter the values that you previously saved from your Facebook Developer App.
  5. All the scopes you need should already exist in the connection. However if you need to enter additional scopes you can refer to Meta Ads Docs to find the correct ones.

Now you can make a new Meta Ads connection, and provide the values you obtained earlier.

For any additional setup information, refer to the Meta Ads Docs

InputNotesExample
Authorize URL

Provide a valid authURL for Meta Ads

https://www.facebook.com/v22.0/dialog/oauth
App Id

Provide the App Id that was generated from your Meta Ads App.

1233096058094633
App Secret

Provide the App Secret that was generated from your Meta Ads App.

7699008007296c1689ddd30b0cf7c924
Scopes

Provide a valid list of scopes. A list per use case is provided on the Meta Ads docs: https://developers.facebook.com/docs/marketing-api/overview/authorization/

ads_read ads_management pages_show_list groups_access_member_info leads_retrieval page_events pages_read_user_content public_profile
Token URL

Provide a valid Meta Ads version to complete the Token URL

https://graph.facebook.com/v22.0/oauth/access_token

Sandbox Ad Account Token

This component may also use the Sandbox Ad token to connect a Meta Ad's Sandbox Ad Account To get started with Meta Ads, you first need to create a developer account.

  1. Select Create app, take note of the App Id and App Secret under the basic tab.
  2. Navigate and expand the Marketing API Section and select the Tools section.
    1. In the Sandbox Ad Account Management section, create and name a new Sandbox Ad Account.
    2. Under Actions select the button with a key icon and in the Generate Access Token window Select Generate
    3. Add this Access Token to the Sandbox Ad Token Connection Type.
  3. All the scopes you need should already exist in the connection. However if you need to enter additional scopes you can refer to Meta Ads Docs to find the correct ones.

For any additional setup information, refer to the Meta Ads Docs

InputNotesExample
Sandbox Token

A valid sandbox token for Meta Ads API

Triggers

Ad Account Trigger

Receive data from the Ad Account in real time with webhook subscriptions. | key: metaAdsAdAccountTrigger

InputNotesExample
Ad Account Fields

The fields to be subscribed to.

id,name
Dynamic Ad Account Fields

The fields to be subscribed to.

Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Verify Token

The verify token for the webhook.

test
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Page Trigger

Receive data from the Page in real time with webhook subscriptions. | key: metaAdsPageTrigger

InputNotesExample
Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Page Fields

The fields to be subscribed to.

id,name
Dynamic Page Fields

The fields to be subscribed to.

Verify Token

The verify token for the webhook.

test
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Data Sources

Business Names

A picklist of business names | key: businessNames | type: picklist

InputNotesExample
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Select Ad Account

Select an ad account from the current user's ad accounts. | key: selectAdAccount | type: picklist

InputNotesExample
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Select Ads in Account

Select an ad in the provided ad account. | key: selectAdsInAccount | type: picklist

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Select Campaign in Account

Select a campaign in the provided ad account. | key: selectCampaignInAccount | type: picklist

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Actions

Add URL Tags To Ad Creative

Update an existing Ad Creative to include a new set of URL Tags. | key: addUrlTagsToCreative

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fields

Provide a comma separated list of fields to be returned.

name, object_story_spec, adlabels, body, object_id, url_tags
Limit

Provide a limit for the result set.

30
Object Story Id

Provide an Id for the object story of the adCreative.

1051738543535_10636436633230
Optional Values

Provide optional values to mutate the given object.

URL Tags

Provide an string for the URL tags on the given adCreative.

key1=val1&key2=val2
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Create Ad

Creates a new ad. | key: createAd

InputNotesExample
Ad Schedule End Time

Indicates the end time for the ad. If no end time is defined, the ad will run on the campaign's schedule.

2022-10-10T00:00:00Z
Ad Schedule Start Time

Indicates the start time for the ad. If no start time is defined, the ad will run on the campaign's schedule.

2022-10-10T00:00:00Z
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
Ad Labels

Ad labels associated with this ad.

Adset Id

ID of the ad set that contains the ad.

23849551358310668
Adset Spec

The ad set spec for this ad. When the spec is provided, Adset Id field is not required.

Audience Id

The ID of the audience.

Connection
Conversion Domain

The domain where conversions happen. The field is no longer required for creation or update since June 2023. Note that this field should contain only the first and second level domains, and not the full URL.

facebook.com
Creative

This field is required for create. The ID or creative spec of the ad creative to be used by this ad. You may supply the ID within an object as shown in the example.

Date Format

The format of the date.

Display Sequence

The sequence of the ad within the same campaign.

Engagement Audience

Flag to create a new audience based on users who engage with this ad.

false
Include Demolink Hashes

Include the demolink hashes.

false
Name

Name of the ad.

My Ad Creative
Priority

Priority of the ad.

Source Ad Id

ID of the source Ad, if applicable.

Ad Status

Provide a status for the ad. During testing, it is recommended to set ads to a PAUSED status so as to not incur accidental spend.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Create Ad Account Webhook

Create a new ad account webhook for the current application. | key: createAdAccountWebhook

InputNotesExample
Ad Account Fields

The fields to be subscribed to.

id,name
Dynamic Ad Account Fields

The fields to be subscribed to.

Callback Url

The URL to send the webhook to.

https://your-domain.com/webhook
Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Verify Token

The verify token for the webhook.

test
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": [
{
"id": "123456789012345"
}
]
}

Create Campaign

Creates a new campaign. | key: createCampaign

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
Ad Labels

Ad Labels associated with this campaign.

Bid Strategy

Choose bid strategy for this campaign to suit your specific business goals.

Buying Type

This field will help Meta Ads make optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type.

Campaign Optimization Type

Campaign Optimization Type.

Campaign Name

Name for this campaign.

Connection
Daily Budget

Daily budget of this campaign. All adsets under this campaign will share this budget. You can either set budget at the campaign level or at the adset level, not both.

Is Skadnetwork Attribution

To create an iOS 14 campaign, enable SKAdNetwork attribution for this campaign.

false
Is Using L3 Schedule

Is Using L3 Schedule.

false
Iterative Split Test Configs

Array of Iterative Split Test Configs created under this campaign.

Lifetime Budget

Lifetime budget of this campaign. All adsets under this campaign will share this budget. You can either set budget at the campaign level or at the adset level, not both.

Objective

Campaign's objective. If it is specified the API will validate that any ads created under the campaign match that objective.

Promoted Object

The object this campaign is promoting across all its ads. It's required for SKAdNetwork or Aggregated Event Measurement campaign creation. Only product_catalog_id is used at the ad set level.

Source Campaign Id

Used if a campaign has been copied. The ID from the original campaign that was copied.

Special Ad Categories

Special Ad Categories.

Special Ad Category Country

Special Ad Category Country.

Spend Cap

A spend cap for the campaign, such that it will not spend more than this cap. Defined as integer value of subunit in your currency with a minimum value of $100 USD (or approximate local equivalent). Set the value to 922337203685478 to remove the spend cap. Not available for Reach and Frequency or Premium Self Serve campaigns.

Start Time

Start Time.

Ad Status

Only ACTIVE and PAUSED are valid during creation. Other statuses can be used for update. If it is set to PAUSED, its active child objects will be paused and have an effective status CAMPAIGN_PAUSED.

Stop Time

Stop Time.

Topline Id

Topline Id.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Create Conversion

Create a single conversion event for a pixel. Requires the Conversions API Access Token connection. | key: createConversion

InputNotesExample
Action Source

This field allows you to specify where your conversions occurred.

website
Connection
Custom Data

A map that includes additional business data about the event. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data.

Event Name

A standard event or custom event name.

Purchase
Event Source Url

The browser URL where the event happened.

http://jaspers-market.com/product/123
Event Time

A Unix timestamp in seconds indicating when the actual event occurred. The specified time may be earlier than the time you send the event to Meta Ads. You must send this date in GMT time zone. Default is the current time.

1633552688
More Data

Additional data to include with the event. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event.

Pixel Id

Provide the Id of a pixel.

587490763
User Data

A map that contains customer information data. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": {
"events_received": 1,
"messages": [],
"fbtrace_id": "AsGY30oxXE4Dvv_CDbCOFR6"
}
}

Create Multiple Conversions

Create multiple conversion events for a pixel. Requires the Conversions API Access Token connection. | key: createMultipleConversions

InputNotesExample
Connection
Events

An array of server event objects. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event for more information.

Pixel Id

Provide the Id of a pixel.

587490763
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": {
"events_received": 1,
"messages": [],
"fbtrace_id": "AsGY30oxXE4Dvv_CDbCOFR6"
}
}

Create Page Webhook

Create a new page webhook for the current application. | key: createPageWebhook

InputNotesExample
Callback Url

The URL to send the webhook to.

https://your-domain.com/webhook
Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Page Fields

The fields to be subscribed to.

id,name
Dynamic Page Fields

The fields to be subscribed to.

Verify Token

The verify token for the webhook.

test
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": [
{
"id": "123456789012345"
}
]
}

Delete Ad

Delete the information and metadata of a given ad. | key: deleteAd

InputNotesExample
Ad Id

Ad ID to delete.

342512647855388
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Delete Webhook

Delete a webhook for the current application. | key: deleteWebhook

InputNotesExample
Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Object

The webhook associated with the object will be deleted.

user
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": "Webhook deleted successfully"
}

Get Ad

Get the information and metadata of a given ad. | key: getAd

InputNotesExample
Ad Id

Ad ID to get.

342512647855388
Connection
Fields

Provide a comma separated list of fields to be returned.

name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Get Ad Account

Get the information and metadata of the given ad account. | key: getAdAccount

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
Connection
Fields

Provide a comma separated list of fields to be returned.

name,age,balance,is_personal,account_status,line_numbers,adcreatives
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Get Ad Creative

Get the information and metadata of the given ad creative. | key: getAdCreative

InputNotesExample
Ad Creative

Provide a unique identifier of the Ad Creative. This value should be an ID.

342512647855388
Connection
Fields

Provide a comma separated list of fields to be returned.

name, object_story_spec, adlabels, body, object_id, url_tags
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Get Ad Set

Get the information and metadata of a given Ad Set. | key: getAdSet

InputNotesExample
Ad Set Id

The ID of the Ad Set to retrieve.

342512647855388
Connection
Fields

Provide a comma separated list of fields to be returned.

name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Get Business By Name

Fetch an business with the provided name. | key: businessByName

InputNotesExample
Business Name
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": {
"id": "123456789012345",
"name": "Example User's Business"
}
}

Get Current User

Get the information and metadata of the current user. | key: getCurrentUser

InputNotesExample
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Get User By Id

Get the information and metadata of a given user. | key: getUserById

InputNotesExample
Connection
User Id

Provide the Id of a user.

587490763
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ad Accounts

Get the ad accounts for the current user. | key: listAddAccounts

InputNotesExample
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fetch All

If true, it will fetch all records and ignore parameters like limit, after, and before.

false
Fields

Provide a comma separated list of fields to be returned.

name,age,balance,is_personal,account_status,line_numbers,adcreatives
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": {
"data": [
{
"name": "Example Account",
"age": 0,
"balance": "0",
"is_personal": 0,
"account_status": 2,
"id": "act_123456789012345"
}
],
"paging": {
"cursors": {
"before": "ABCDEFG1234567890XYZ",
"after": "ABCDEFG1234567890XYZ"
}
}
}
}

List Ad Creatives

List all ad creatives in a given ad account. | key: listAdCreatives

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fetch All

If true, it will fetch all records and ignore parameters like limit, after, and before.

false
Fields

Provide a comma separated list of fields to be returned.

name, object_story_spec, adlabels, body, object_id, url_tags
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ad Leads

List all ad leads for the given ad. | key: listAdLeads

InputNotesExample
Ad Id

The ID of the ad to list leads for.

342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fields

Provide a comma separated list of fields to be returned.

name
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ad Previews

Get a list of all previews of the given ad. | key: getAdPreview

InputNotesExample
Ad Format

Provide a type of ad format to preview.

Ad Id

The ID of the ad to list previews for.

342512647855388
Connection
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ad Sets In Account

List all ad sets in an ad account. | key: listAdSetsInAccount

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fetch All

If true, it will fetch all records and ignore parameters like limit, after, and before.

false
Fields

Provide a comma separated list of fields to be returned.

name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ads In Account

List all ads in an ad account. | key: listAdsInAccount

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Fetch All

If true, it will fetch all records and ignore parameters like limit, after, and before.

false
Fields

Provide a comma separated list of fields to be returned.

name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Ads In Adset

List all ads in a given adset. | key: listAdsInAdset

InputNotesExample
Ad Set Id

The ID of the adset to list ads for.

342512647855388
Connection
Fields

Provide a comma separated list of fields to be returned.

name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Campaigns In Account

List all campaigns in an ad account. | key: listCampaignsInAccount

InputNotesExample
Ad Account

Provide the identifier of an Ad Account. This value should be an Id.

act_342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Connection
Limit

Provide a limit for the result set.

30
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

List Webhooks

List all webhooks for the current application. | key: listWebhooks

InputNotesExample
Connection

This connection must be a Meta Ads Client Credentials connection to be able to use webhooks APIs.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

{
"data": [
{
"id": "123456789012345"
}
]
}

Raw Request

Send raw HTTP request to Meta Ads. | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/me/adaccounts), The base URL is already included (https://graph.facebook.com/v<INPUT_VERSION>.0). For example, to connect to https://graph.facebook.com/v<INPUT_VERSION>.0/me/adaccounts, only /me/adaccounts is entered in this field.

/me/adaccounts
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Update Ad

Update the information and metadata of a given ad or adset. | key: updateAd

InputNotesExample
Ad Id

Provide the Id of an Ad or Ad Set.

342512647855388
Ad Name

Provide a name for the given ad.

My New Ad
Connection
Creative Id

Provide the Id of the desired creative.

58789326952
Fields

Provide a comma separated list of fields to be returned.

name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs
Optional Values

Provide optional values to mutate the given object.

Ad Status

Provide a status for the ad. During testing, it is recommended to set ads to a PAUSED status so as to not incur accidental spend.

Tracking

Provide a JSON array containing valid tracking specs. The shape of this field can change depending on the type of ad: https://developers.facebook.com/docs/marketing-api/tracking-specs#default_by_ad.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Update Ad Creative

Update the information and metadata of the given ad creative. | key: updateAdCreative

InputNotesExample
Ad Creative Id

The ID of the ad creative to update.

342512647855388
After

Provide the token for the item after the current one.

xOTQ1MjAwNzI5NDE=
Before

Provide the token for the item before the current one.

xOTQ1MjAwNzI5NDE=
Body

Provide a body for the adCreative.

This is an example description body.
Connection
Fields

Provide a comma separated list of fields to be returned.

name, object_story_spec, adlabels, body, object_id, url_tags
Limit

Provide a limit for the result set.

30
Name

Provide a name for the adCreative.

My Ad Creative
Object Story Id

Provide an Id for the object story of the adCreative.

1051738543535_10636436633230
Optional Values

Provide optional values to mutate the given object.

URL Tags

Provide an string for the URL tags on the given adCreative.

key1=val1&key2=val2
Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Update Ad Set

Update the information and metadata of a given Ad Set. | key: updateAdSet

InputNotesExample
Ad Set Id

The ID of the Ad Set to update.

342512647855388
Ad Set Name

Provide a name for the Ad Set.

My New Ad
Connection
Fields

Provide a comma separated list of fields to be returned.

name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time
Optional Values

Provide optional values to mutate the given object.

Ad Set Status

Provide a status for the Ad Set. During testing, it is recommended to set ad sets to a PAUSED status so as to not incur accidental spend.

Targeting

The targeting specs for the ad set.

Graph Version

Provide the version of the Graph API to use. Defaults to 22.

22

Changelog

2025-10-17

Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup

2025-07-23

Added inline datasources for ad accounts, campaigns, and business names to enhance data selection capabilities

2025-04-01

Updated to Facebook Marketing API V22.0 with enhanced ad management and campaign capabilities