> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Meta Ads

> Create, edit and get insights from ads across Meta technologies, including Facebook, Instagram, Messenger, WhatsApp and more.

![Meta Ads logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/metaads.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=f4c918f6650a8688d07e6618a3998578)

* **Category:** ads & conversion
* **Auth:** OAUTH2, API\_KEY
* **Composio-managed OAuth available?** No
* **Tools:** 95
* **Triggers:** 0
* **Slug:** `METAADS`
* **Version:** 20261103\_00

## Tools

> [accordion] Copy Ad Object
>
> **Slug:** `METAADS_COPY_AD_OBJECT`
>
> Copy a Meta Campaign, Ad Set, or Ad while explicitly selecting its resource type and supported copy options.
>
> #### Input Parameters
>
> **end\_time** `string`
>
> ISO 8601 end time for the copy. Supported for Campaign and Ad Set copies.
>
> **deep\_copy** `boolean`
>
> Whether to copy nested children. Supported for Campaign and Ad Set copies.
>
> **object\_id** `string` *required*
>
> ID of the source Campaign, Ad Set, or Ad.
>
> **start\_time** `string`
>
> ISO 8601 start time for the copy. Supported for Campaign and Ad Set copies.
>
> **object\_type** `string ("campaign" | "ad_set" | "ad")` *required*
>
> Source resource type, which selects Meta's typed copy contract.
>
> **status\_option** `string ("ACTIVE" | "PAUSED" | "INHERITED_FROM_SOURCE")`
>
> Status to assign to copied objects.
>
> **rename\_options** `object`
>
> Meta rename strategy and options for the copied objects.
>
> **create\_dco\_adset** `boolean`
>
> Whether to create a dynamic-creative Ad Set; supported only for Ad Set copies.
>
> **creative\_parameters** `object`
>
> Ad creative parameter overrides; supported only for Ad copies.
>
> **parameter\_overrides** `object`
>
> Campaign parameter overrides; supported only for Campaign copies.
>
> **destination\_parent\_id** `string`
>
> Destination campaign ID for an Ad Set copy or destination ad set ID for an Ad copy. Campaign copies do not support this option.
>
> **migrate\_to\_advantage\_plus** `boolean`
>
> Whether to migrate the copy to Advantage+; supported only for Campaign copies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ad
>
> **Slug:** `METAADS_CREATE_AD`
>
> Create a new ad within an ad set using the Meta Marketing API, with image, video, or carousel creative content.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the ad
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")`
>
> Initial status of the ad
>
> **creative** `object` *required*
>
> Creative specifications for the ad
>
> **ad\_set\_id** `string` *required*
>
> ID of the ad set to create the ad in. The referenced ad set and its parent campaign must already exist.
>
> **bid\_amount** `integer`
>
> Bid amount in cents (overrides ad set bid)
>
> **ad\_account\_id** `string` *required*
>
> ID of the ad account (e.g. 'act\_123456789'). Must start with 'act\_'.
>
> **tracking\_specs** `array`
>
> Tracking specifications for the ad
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ad Creative
>
> **Slug:** `METAADS_CREATE_AD_CREATIVE`
>
> Create a new ad creative using the Meta Marketing API. Ad creatives are reusable visual and interactive elements that define how your ad looks and behaves: - Can be used in multiple ads - Support various formats (image, video, carousel) - Include text, media, and call-to-action buttons - Must follow Meta's ad policies
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of your ad creative. Best practices:         - Include the creative type (e.g., "Summer Sale - Image")         - Add version if iterating (e.g., "v1")         - Include target audience if specific         - Keep it searchable and organized
>
> **creative** `object` *required*
>
> The creative specifications for your ad.         This defines:         - What type of ad (image, video, carousel)         - What it looks like (images, text)         - How it behaves (links, buttons)         See AdCreative model for details.          Meta enforces strict asset specifications at creation time — image dimensions, aspect ratios, and text length must comply or the request will be rejected.
>
> **account\_id** `string` *required*
>
> The ad account ID where you want to create the creative.         Format: act\_1234567890         Get this from your Meta Ads account settings.         Must have proper permissions set up.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ad Set
>
> **Slug:** `METAADS_CREATE_AD_SET`
>
> Create a new ad set within a campaign using the Meta Marketing API. Supports detailed targeting options, budgets, and optimization goals.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the ad set
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")`
>
> Initial status of the ad set
>
> **end\_time** `string`
>
> End time in ISO 8601 format
>
> **targeting** `object` *required*
>
> Targeting specifications for the ad set
>
> **account\_id** `string` *required*
>
> ID of the ad account to create the ad set in
>
> **bid\_amount** `integer`
>
> Bid amount in cents. Required for LOWEST\_COST\_WITH\_BID\_CAP and COST\_CAP. Do not use with LOWEST\_COST\_WITH\_MIN\_ROAS.
>
> **start\_time** `string`
>
> Start time in ISO 8601 format
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to create the ad set in
>
> **bid\_strategy** `string ("LOWEST_COST_WITHOUT_CAP" | "LOWEST_COST_WITH_BID_CAP" | "COST_CAP" | "LOWEST_COST_WITH_MIN_ROAS")`
>
> Bid strategy for the ad set. LOWEST\_COST\_WITH\_BID\_CAP and COST\_CAP require bid\_amount. LOWEST\_COST\_WITH\_MIN\_ROAS requires optimization\_goal VALUE and bid\_constraints.roas\_average\_floor.
>
> **daily\_budget** `number`
>
> Average daily budget for this ad set in account currency. Meta may spend up to 75% over this amount on an individual day, while weekly spend remains capped at seven times the daily budget. Use for ad set-level budgets.
>
> **billing\_event** `string ("IMPRESSIONS" | "LINK_CLICKS" | "APP_INSTALLS" | "POST_ENGAGEMENT" | "THRUPLAY")` *required*
>
> The billing event for the ad set
>
> **bid\_constraints** `object`
>
> Bid constraint values for bid strategies that require them.
>
> **lifetime\_budget** `number`
>
> Lifetime budget limit for this ad set in account currency. Use for ad set-level budgets.
>
> **promoted\_object** `object`
>
> Object promoted by the ad set.
>
> **optimization\_goal** `string ("APP_INSTALLS" | "CONVERSATIONS" | "LINK_CLICKS" | "OFFSITE_CONVERSIONS" | "PAGE_LIKES" | "POST_ENGAGEMENT" | "REACH" | "THRUPLAY" | "VALUE")` *required*
>
> The optimization goal for the ad set
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ad Study
>
> **Slug:** `METAADS_CREATE_AD_STUDY`
>
> Create a Meta A/B test or other ad study under a business, including its cells and tested ad entities.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the ad study.
>
> **type** `string ("BACKEND_AB_TESTING" | "CONTINUOUS_LIFT_CONFIG" | "CREATIVE_SPEND_ENFORCEMENT" | "GEO_LIFT" | "LIFT" | "PORTFOLIO_OPTIMIZER" | "SPLIT_TEST" | "VERSION_CONTROL")`
>
> Meta ad-study type. Defaults to SPLIT\_TEST for an A/B test.
>
> **cells** `array` *required*
>
> Study cells and the campaigns, ad sets, ads, or ad accounts each tests.
>
> **viewers** `array`
>
> Positive numeric Meta user IDs allowed to view the study.
>
> **end\_time** `integer` *required*
>
> Study end time as a Unix timestamp in seconds.
>
> **objectives** `array`
>
> Meta study objective objects.
>
> **start\_time** `integer` *required*
>
> Study start time as a Unix timestamp in seconds.
>
> **business\_id** `string` *required*
>
> Numeric ID of the Meta business that will own the ad study.
>
> **description** `string`
>
> Optional description of the ad study.
>
> **client\_business** `string`
>
> Numeric ID of the client business.
>
> **confidence\_level** `number`
>
> Statistical confidence level for the study.
>
> **cooldown\_start\_time** `integer`
>
> Cooldown start time as a Unix timestamp in seconds.
>
> **creative\_test\_config** `object`
>
> Meta creative-test configuration object.
>
> **observation\_end\_time** `integer`
>
> Observation end time as a Unix timestamp in seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ad Video
>
> **Slug:** `METAADS_CREATE_AD_VIDEO`
>
> Upload an ad video asset; Meta may keep processing it after returning its ID.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional internal name for the ad video.
>
> **title** `string`
>
> Optional title for the ad video.
>
> **video** `object`
>
> One local video file to upload directly, up to 100 MiB. Provide exactly one of video or file\_url.
>
> **file\_url** `string`
>
> Public HTTP(S) URL that Meta can fetch for the video. Provide exactly one of file\_url or video.
>
> **description** `string`
>
> Optional description for the ad video.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Campaign
>
> **Slug:** `METAADS_CREATE_CAMPAIGN`
>
> Create a new advertising campaign using the Meta Marketing API. Supports various campaign objectives, budgets, and bidding strategies.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the campaign
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")`
>
> Initial status of the campaign
>
> **objective** `string ("OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_ENGAGEMENT" | "OUTCOME_AWARENESS" | "OUTCOME_TRAFFIC" | "OUTCOME_APP_PROMOTION")` *required*
>
> The objective of the campaign
>
> **account\_id** `string` *required*
>
> The ID of the ad account to create the campaign in
>
> **bid\_strategy** `string ("LOWEST_COST_WITHOUT_CAP" | "LOWEST_COST_WITH_BID_CAP" | "COST_CAP")`
>
> Bidding strategy for the campaign
>
> **daily\_budget** `number`
>
> Average daily budget in account currency. Meta may spend up to 75% over this amount on an individual day, while weekly spend remains capped at seven times the daily budget. Mutually exclusive with lifetime\_budget - provide one or the other, not both.
>
> **lifetime\_budget** `number`
>
> Lifetime budget limit in account currency. Mutually exclusive with daily\_budget - provide one or the other, not both.
>
> **special\_ad\_categories** `array`
>
> List of special ad categories that apply to this campaign
>
> **is\_adset\_budget\_sharing\_enabled** `boolean`
>
> Ad set budget sharing allows up to 20% of your budget to be shared with other ad sets in the same campaign for improved performance. This field is required when no campaign budget is set and budgets will be set at ad set level. Set to true to enable budget sharing optimization between ad sets (only applicable when budgets are set at ad set level). Should be false when using campaign-level budget (daily\_budget or lifetime\_budget).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Audience
>
> **Slug:** `METAADS_CREATE_CUSTOM_AUDIENCE`
>
> Create a new custom audience using the Meta Marketing API. Supports various types of custom audiences including customer lists, website visitors, and app users.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the custom audience
>
> **rule** `object`
>
> Rule for website/app custom audiences
>
> **prefill** `boolean`
>
> Whether to prefill the audience with available data
>
> **subtype** `string ("CUSTOM" | "PRIMARY" | "WEBSITE" | "APP" | "OFFLINE_CONVERSION" | "CLAIM" | "MANAGED" | "PARTNER" | "VIDEO" | "ENGAGEMENT" | "BAG_OF_ACCOUNTS" | "STUDY_RULE_AUDIENCE" | "FOX" | "MEASUREMENT" | "REGULATED_CATEGORIES_AUDIENCE" | "BIDDING" | "EXCLUSION" | "MESSENGER_SUBSCRIBER_LIST")`
>
> Use CUSTOM for customer-list audiences and VIDEO for video engagement. Omit for website, app, offline, and other engagement audiences. Legacy WEBSITE, APP, OFFLINE\_CONVERSION, and ENGAGEMENT inputs are accepted but not sent to Meta, which no longer supports those subtype values.
>
> **account\_id** `string` *required*
>
> The ID of the ad account to create the custom audience in
>
> **description** `string`
>
> Description of the custom audience
>
> **content\_type** `string ("AUTOMOTIVE_MODEL" | "DESTINATION" | "FLIGHT" | "GENERIC" | "HOME_LISTING" | "HOTEL" | "LOCAL_SERVICE_BUSINESS" | "MEDIA_TITLE" | "OFFLINE_PRODUCT" | "PRODUCT" | "VEHICLE" | "VEHICLE_OFFER")`
>
> Content type for dynamic product catalog audiences.
>
> **retention\_days** `integer`
>
> Number of days to keep the audience data
>
> **customer\_file\_source** `string ("USER_PROVIDED_ONLY" | "PARTNER_PROVIDED_ONLY" | "BOTH_USER_AND_PARTNER_PROVIDED")`
>
> Source of the customer file data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Conversion
>
> **Slug:** `METAADS_CREATE_CUSTOM_CONVERSION`
>
> Create a persistent custom-conversion definition in a Meta ad account and return its ID. This toolkit does not expose a matching archive or delete action.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the custom conversion.
>
> **rule** `object`
>
> Matching rule as a JSON object.
>
> **description** `string`
>
> Optional description of the custom conversion.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **advanced\_rule** `object`
>
> Advanced multi-source matching rule as a JSON object.
>
> **event\_source\_id** `string`
>
> Numeric ID of the Pixel, offline event set, or other event source.
>
> **custom\_event\_type** `string ("ADD_PAYMENT_INFO" | "ADD_TO_CART" | "ADD_TO_WISHLIST" | "COMPLETE_REGISTRATION" | "CONTACT" | "CONTENT_VIEW" | "CUSTOMIZE_PRODUCT" | "DONATE" | "FACEBOOK_SELECTED" | "FIND_LOCATION" | "INITIATED_CHECKOUT" | "LEAD" | "LISTING_INTERACTION" | "OTHER" | "PURCHASE" | "SCHEDULE" | "SEARCH" | "START_TRIAL" | "SUBMIT_APPLICATION" | "SUBSCRIBE")`
>
> Standard event category assigned to the custom conversion.
>
> **action\_source\_type** `string ("app" | "business_messaging" | "chat" | "email" | "other" | "phone_call" | "physical_store" | "system_generated" | "website")`
>
> Source from which conversion actions originate.
>
> **default\_conversion\_value** `number`
>
> Default monetary value assigned to matching conversions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Lead Form
>
> **Slug:** `METAADS_CREATE_LEAD_FORM`
>
> Create a persistent lead-generation form owned by a Facebook Page and return its ID. This toolkit does not expose a matching archive or delete action.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Internal name for the lead form.
>
> **locale** `string ("AR_AR" | "CS_CZ" | "DA_DK" | "DE_DE" | "EL_GR" | "EN_GB" | "EN_US" | "ES_ES" | "ES_LA" | "FI_FI" | "FR_FR" | "HE_IL" | "HI_IN" | "HU_HU" | "ID_ID" | "IT_IT" | "JA_JP" | "KO_KR" | "NB_NO" | "NL_NL" | "PL_PL" | "PT_BR" | "PT_PT" | "RO_RO" | "RU_RU" | "SV_SE" | "TH_TH" | "TR_TR" | "VI_VN" | "ZH_CN" | "ZH_HK" | "ZH_TW")`
>
> Locale used to render the form.
>
> **page\_id** `string` *required*
>
> Numeric Facebook Page ID that will own the lead form. Ad account IDs and act\_ prefixes are not accepted.
>
> **questions** `array` *required*
>
> Questions shown in the form, in display order.
>
> **context\_card** `object`
>
> Introductory context card shown before the questions.
>
> **privacy\_policy** `object`
>
> Privacy-policy link displayed by the form.
>
> **thank\_you\_page** `object`
>
> Page shown after the form is submitted.
>
> **custom\_disclaimer** `object`
>
> Additional disclaimer and consent checkboxes.
>
> **tracking\_parameters** `object`
>
> String key-value metadata returned with leads for attribution.
>
> **follow\_up\_action\_url** `string`
>
> URL used for the form's follow-up action.
>
> **is\_optimized\_for\_quality** `boolean`
>
> Whether to add a review step that favors higher-intent leads.
>
> **should\_enforce\_work\_email** `boolean`
>
> Whether email questions should require a work email address.
>
> **block\_display\_for\_non\_targeted\_viewer** `boolean`
>
> Whether people outside the ad's target audience are blocked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Ad Object
>
> **Slug:** `METAADS_DELETE_AD_OBJECT`
>
> Delete an Ad Set, Ad, or Ad Creative by ID; the supplied object type is not verified, so the ID determines the object targeted. Meta marks the object DELETED rather than guaranteeing permanent removal.
>
> #### Input Parameters
>
> **object\_id** `string` *required*
>
> ID of the Ad Set, Ad, or Ad Creative to delete.
>
> **object\_type** `string ("AD_SET" | "AD" | "AD_CREATIVE")` *required*
>
> Type of ad object identified by object\_id. Use METAADS\_DELETE\_CAMPAIGN for campaigns. Informational only: it is not verified against the object and is not sent to Meta, so the ID alone decides what is deleted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Campaign
>
> **Slug:** `METAADS_DELETE_CAMPAIGN`
>
> Delete an advertising campaign using the Meta Marketing API. This marks the campaign as DELETED, which prevents it from delivering ads. Note that deleted campaigns are not permanently removed from Meta's systems and can still be viewed in reports.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Estimate Ad Delivery
>
> **Slug:** `METAADS_ESTIMATE_AD_DELIVERY`
>
> Estimate monthly audience delivery for targeting and optimization settings in a Meta ad account.
>
> #### Input Parameters
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **targeting\_spec** `object` *required*
>
> Provider-native Meta targeting specification. Pass an object; the action compact JSON-encodes it for Meta.
>
> **promoted\_object** `object`
>
> Optional provider-native promoted object required by some optimization goals. Pass an object; the action compact JSON-encodes it for Meta.
>
> **optimization\_goal** `string ("ADVERTISER_SILOED_VALUE" | "AD_RECALL_LIFT" | "APP_INSTALLS" | "APP_INSTALLS_AND_OFFSITE_CONVERSIONS" | "AUTOMATIC_OBJECTIVE" | "CONVERSATIONS" | "DERIVED_EVENTS" | "ENGAGED_PAGE_VIEWS" | "ENGAGED_USERS" | "EVENT_RESPONSES" | "IMPRESSIONS" | "IN_APP_VALUE" | "LANDING_PAGE_VIEWS" | "LEAD_GENERATION" | "LINK_CLICKS" | "MEANINGFUL_CALL_ATTEMPT" | "MESSAGING_APPOINTMENT_CONVERSION" | "MESSAGING_DEEP_CONVERSATION_AND_FOLLOW" | "MESSAGING_PURCHASE_CONVERSION" | "NONE" | "OFFSITE_CONVERSIONS" | "PAGE_LIKES" | "POST_ENGAGEMENT" | "PROFILE_AND_PAGE_ENGAGEMENT" | "PROFILE_VISIT" | "QUALITY_CALL" | "QUALITY_LEAD" | "REACH" | "REMINDERS_SET" | "SUBSCRIBERS" | "THRUPLAY" | "VALUE" | "VISIT_INSTAGRAM_PROFILE")` *required*
>
> Meta optimization goal used to calculate delivery.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Estimate Targeting Reach
>
> **Slug:** `METAADS_ESTIMATE_TARGETING_REACH`
>
> Estimate the audience-size range for a Meta ad account and structured targeting specification containing at least one country. The response includes estimate readiness and lower and upper bounds; a bound of -1 indicates an unavailable estimate.
>
> #### Input Parameters
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **targeting\_spec** `object` *required*
>
> Structured Meta targeting specification used to estimate audience reach. It is serialized to compact JSON in the query.
>
> **object\_store\_url** `string`
>
> App-store URL for reach estimates for a mobile app campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Ad Previews
>
> **Slug:** `METAADS_GENERATE_AD_PREVIEWS`
>
> Render previews for a provider-native creative specification in a Meta ad account and return the generated HTML bodies.
>
> #### Input Parameters
>
> **post** `object`
>
> Provider-native Page post specification used when creative contains only a Page ID as object\_id; unsupported with RIGHT\_COLUMN\_STANDARD.
>
> **width** `integer`
>
> Optional preview viewport width in pixels.
>
> **height** `integer`
>
> Optional preview viewport height in pixels.
>
> **locale** `string`
>
> Optional locale used to render localized preview content.
>
> **creative** `object` *required*
>
> Provider-native Meta AdCreative specification. Pass the creative object without stringifying it; the action compact JSON-encodes it for Meta.
>
> **end\_date** `string`
>
> End date-time used by trip-related fields in the creative.
>
> **ad\_format** `string ("AUDIENCE_NETWORK_INSTREAM_VIDEO" | "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE" | "AUDIENCE_NETWORK_OUTSTREAM_VIDEO" | "AUDIENCE_NETWORK_REWARDED_VIDEO" | "BIZ_DISCO_FEED_MOBILE" | "DESKTOP_FEED_STANDARD" | "FACEBOOK_IFU_REELS_MOBILE" | "FACEBOOK_PROFILE_FEED_DESKTOP" | "FACEBOOK_PROFILE_FEED_MOBILE" | "FACEBOOK_PROFILE_REELS_MOBILE" | "FACEBOOK_REELS_BANNER" | "FACEBOOK_REELS_BANNER_DESKTOP" | "FACEBOOK_REELS_BANNER_FEED_ANDROID" | "FACEBOOK_REELS_BANNER_FEED_ANDROID_LARGE" | "FACEBOOK_REELS_BANNER_FULLSCREEN_IOS" | "FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE" | "FACEBOOK_REELS_MOBILE" | "FACEBOOK_REELS_POSTLOOP" | "FACEBOOK_REELS_POSTLOOP_FEED" | "FACEBOOK_REELS_SIMILAR_PRODUCTS_MOBILE" | "FACEBOOK_REELS_STICKER" | "FACEBOOK_STORY_MOBILE" | "FACEBOOK_STORY_STICKER_MOBILE" | "INSTAGRAM_EXPLORE_CONTEXTUAL" | "INSTAGRAM_EXPLORE_GRID_HOME" | "INSTAGRAM_EXPLORE_IMMERSIVE" | "INSTAGRAM_FEED_WEB" | "INSTAGRAM_FEED_WEB_M_SITE" | "INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS" | "INSTAGRAM_PROFILE_FEED" | "INSTAGRAM_PROFILE_REELS" | "INSTAGRAM_REELS" | "INSTAGRAM_REELS_OVERLAY" | "INSTAGRAM_REELS_WEB" | "INSTAGRAM_REELS_WEB_M_SITE" | "INSTAGRAM_SEARCH_CHAIN" | "INSTAGRAM_SEARCH_GRID" | "INSTAGRAM_STANDARD" | "INSTAGRAM_STORY" | "INSTAGRAM_STORY_EFFECT_TRAY" | "INSTAGRAM_STORY_WEB" | "INSTAGRAM_STORY_WEB_M_SITE" | "INSTANT_ARTICLE_RECIRCULATION_AD" | "INSTANT_ARTICLE_STANDARD" | "INSTREAM_BANNER_DESKTOP" | "INSTREAM_BANNER_FEED_IOS" | "INSTREAM_BANNER_FULLSCREEN_IOS" | "INSTREAM_BANNER_FULLSCREEN_MOBILE" | "INSTREAM_BANNER_IMMERSIVE_MOBILE" | "INSTREAM_BANNER_MOBILE" | "INSTREAM_VIDEO_DESKTOP" | "INSTREAM_VIDEO_FULLSCREEN_IOS" | "INSTREAM_VIDEO_FULLSCREEN_MOBILE" | "INSTREAM_VIDEO_IMAGE" | "INSTREAM_VIDEO_IMMERSIVE_MOBILE" | "INSTREAM_VIDEO_MOBILE" | "JOB_BROWSER_DESKTOP" | "JOB_BROWSER_MOBILE" | "MARKETPLACE_MOBILE" | "MESSENGER_MOBILE_INBOX_MEDIA" | "MESSENGER_MOBILE_STORY_MEDIA" | "MOBILE_BANNER" | "MOBILE_FEED_BASIC" | "MOBILE_FEED_STANDARD" | "MOBILE_FULLWIDTH" | "MOBILE_INTERSTITIAL" | "MOBILE_MEDIUM_RECTANGLE" | "MOBILE_NATIVE" | "RIGHT_COLUMN_STANDARD" | "SUGGESTED_VIDEO_DESKTOP" | "SUGGESTED_VIDEO_FULLSCREEN_MOBILE" | "SUGGESTED_VIDEO_IMMERSIVE_MOBILE" | "SUGGESTED_VIDEO_MOBILE" | "WATCH_FEED_HOME" | "WATCH_FEED_MOBILE" | "WHATSAPP_STATUS_MEDIA")` *required*
>
> Placement format in which Meta renders the ad preview.
>
> **start\_date** `string`
>
> Start date-time used by trip-related fields in the creative.
>
> **render\_type** `string`
>
> Optional Meta SDK render mode; currently only FALLBACK is supported.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **place\_page\_id** `string`
>
> Place Page ID used to render a dynamic local ad preview.
>
> **creative\_feature** `string ("ig_video_native_subtitle" | "image_animation" | "product_browsing" | "product_metadata_automation" | "profile_card" | "standard_enhancements_catalog" | "text_overlay_translation")`
>
> Optional Meta creative feature to apply while rendering the preview.
>
> **product\_item\_ids** `array`
>
> Product Item IDs used to render a dynamic ad preview.
>
> **dynamic\_asset\_label** `string`
>
> Asset label selecting a specific dynamic asset customization variation.
>
> **dynamic\_creative\_spec** `object`
>
> Provider-native dynamic creative specification for a dynamic ad.
>
> **dynamic\_customization** `object`
>
> Provider-native multilingual customization for a dynamic ad.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ad Accounts
>
> **Slug:** `METAADS_GET_AD_ACCOUNTS`
>
> Retrieve one page of directly assigned ad accounts for the authenticated user, including account IDs, names, and other requested account details.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of ad accounts to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve. Common fields: id, name, account\_id, currency, timezone\_name, account\_status, business\_name, business. The 'id' field returns the ad account ID prefixed with 'act\_', while 'account\_id' returns the numeric ID without prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ad Creative
>
> **Slug:** `METAADS_GET_AD_CREATIVE`
>
> Get Ad Creative
>
> #### Input Parameters
>
> **fields** `string`
>
> List of fields to include in the response.
>
> **creative\_id** `string` *required*
>
> The ID of the ad creative to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ad Preview
>
> **Slug:** `METAADS_GET_AD_PREVIEW`
>
> Render a placement-specific preview for an existing Meta Ad or Ad Creative.
>
> #### Input Parameters
>
> **post** `object`
>
> JSON object describing the post to render.
>
> **width** `integer`
>
> Preview width in pixels, when a custom size is needed.
>
> **height** `integer`
>
> Preview height in pixels, when a custom size is needed.
>
> **locale** `string`
>
> Locale in which to render the preview, such as en\_US.
>
> **end\_date** `string`
>
> Preview end date as a Meta-compatible datetime string.
>
> **ad\_format** `string ("AUDIENCE_NETWORK_INSTREAM_VIDEO" | "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE" | "AUDIENCE_NETWORK_OUTSTREAM_VIDEO" | "AUDIENCE_NETWORK_REWARDED_VIDEO" | "BIZ_DISCO_FEED_MOBILE" | "DESKTOP_FEED_STANDARD" | "FACEBOOK_IFU_REELS_MOBILE" | "FACEBOOK_PROFILE_FEED_DESKTOP" | "FACEBOOK_PROFILE_FEED_MOBILE" | "FACEBOOK_PROFILE_REELS_MOBILE" | "FACEBOOK_REELS_BANNER" | "FACEBOOK_REELS_BANNER_DESKTOP" | "FACEBOOK_REELS_BANNER_FEED_ANDROID" | "FACEBOOK_REELS_BANNER_FEED_ANDROID_LARGE" | "FACEBOOK_REELS_BANNER_FULLSCREEN_IOS" | "FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE" | "FACEBOOK_REELS_MOBILE" | "FACEBOOK_REELS_POSTLOOP" | "FACEBOOK_REELS_POSTLOOP_FEED" | "FACEBOOK_REELS_SIMILAR_PRODUCTS_MOBILE" | "FACEBOOK_REELS_STICKER" | "FACEBOOK_STORY_MOBILE" | "FACEBOOK_STORY_STICKER_MOBILE" | "INSTAGRAM_EXPLORE_CONTEXTUAL" | "INSTAGRAM_EXPLORE_GRID_HOME" | "INSTAGRAM_EXPLORE_IMMERSIVE" | "INSTAGRAM_FEED_WEB" | "INSTAGRAM_FEED_WEB_M_SITE" | "INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS" | "INSTAGRAM_PROFILE_FEED" | "INSTAGRAM_PROFILE_REELS" | "INSTAGRAM_REELS" | "INSTAGRAM_REELS_OVERLAY" | "INSTAGRAM_REELS_WEB" | "INSTAGRAM_REELS_WEB_M_SITE" | "INSTAGRAM_SEARCH_CHAIN" | "INSTAGRAM_SEARCH_GRID" | "INSTAGRAM_STANDARD" | "INSTAGRAM_STORY" | "INSTAGRAM_STORY_EFFECT_TRAY" | "INSTAGRAM_STORY_WEB" | "INSTAGRAM_STORY_WEB_M_SITE" | "INSTANT_ARTICLE_RECIRCULATION_AD" | "INSTANT_ARTICLE_STANDARD" | "INSTREAM_BANNER_DESKTOP" | "INSTREAM_BANNER_FEED_IOS" | "INSTREAM_BANNER_FULLSCREEN_IOS" | "INSTREAM_BANNER_FULLSCREEN_MOBILE" | "INSTREAM_BANNER_IMMERSIVE_MOBILE" | "INSTREAM_BANNER_MOBILE" | "INSTREAM_VIDEO_DESKTOP" | "INSTREAM_VIDEO_FULLSCREEN_IOS" | "INSTREAM_VIDEO_FULLSCREEN_MOBILE" | "INSTREAM_VIDEO_IMAGE" | "INSTREAM_VIDEO_IMMERSIVE_MOBILE" | "INSTREAM_VIDEO_MOBILE" | "JOB_BROWSER_DESKTOP" | "JOB_BROWSER_MOBILE" | "MARKETPLACE_MOBILE" | "MESSENGER_MOBILE_INBOX_MEDIA" | "MESSENGER_MOBILE_STORY_MEDIA" | "MOBILE_BANNER" | "MOBILE_FEED_BASIC" | "MOBILE_FEED_STANDARD" | "MOBILE_FULLWIDTH" | "MOBILE_INTERSTITIAL" | "MOBILE_MEDIUM_RECTANGLE" | "MOBILE_NATIVE" | "RIGHT_COLUMN_STANDARD" | "SUGGESTED_VIDEO_DESKTOP" | "SUGGESTED_VIDEO_FULLSCREEN_MOBILE" | "SUGGESTED_VIDEO_IMMERSIVE_MOBILE" | "SUGGESTED_VIDEO_MOBILE" | "WATCH_FEED_HOME" | "WATCH_FEED_MOBILE" | "WHATSAPP_STATUS_MEDIA")` *required*
>
> Meta ad placement format to render.
>
> **object\_id** `string` *required*
>
> Numeric ID of the existing Meta Ad or Ad Creative to preview.
>
> **start\_date** `string`
>
> Preview start date as a Meta-compatible datetime string.
>
> **render\_type** `string`
>
> Meta preview rendering mode.
>
> **place\_page\_id** `integer`
>
> Numeric ID of the Place Page to use in the preview.
>
> **creative\_feature** `string ("ig_video_native_subtitle" | "image_animation" | "product_browsing" | "product_metadata_automation" | "profile_card" | "standard_enhancements_catalog" | "text_overlay_translation")`
>
> Meta creative feature to apply while rendering the preview.
>
> **product\_item\_ids** `array`
>
> Product item IDs to include in the preview.
>
> **dynamic\_asset\_label** `string`
>
> Dynamic asset label to select for the preview.
>
> **dynamic\_creative\_spec** `object`
>
> JSON object describing the dynamic creative configuration.
>
> **dynamic\_customization** `object`
>
> JSON object describing dynamic preview customization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ad Study
>
> **Slug:** `METAADS_GET_AD_STUDY`
>
> Get one Meta ad study by ID, including projected cells and timing.
>
> #### Input Parameters
>
> **fields** `string`
>
> Ad-study fields to return. Provide individual Graph field names; a one-level nested projection such as cells\{id,name} is supported.
>
> **study\_id** `string` *required*
>
> Numeric Meta ad-study ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current Meta App
>
> **Slug:** `METAADS_GET_CURRENT_APP`
>
> Return selected metadata for the Meta application associated with the connected access token.
>
> #### Input Parameters
>
> **fields** `string`
>
> Application fields to return, as a CSV string or a list of individual Graph API field names. Meta can omit requested fields that are unavailable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Insights
>
> **Slug:** `METAADS_GET_INSIGHTS`
>
> Get insights data for a Meta Ads object (ad account, campaign, ad set, or ad) using the Meta Marketing API. Supports various metrics, breakdowns, and filtering options with flexible date ranges. Results are paginated; follow `paging.cursors.after` or `paging.next` to retrieve all rows. Missing metric values in results should not be assumed to be zero.
>
> #### Input Parameters
>
> **sort** `array`
>
> Fields to sort by with direction (\_ascending or \_descending suffix)
>
> **after** `string`
>
> Cursor for the next page of results, usually taken from paging.cursors.after in the previous response.
>
> **level** `string ("account" | "campaign" | "adset" | "ad")`
>
> Level at which to aggregate the data Must match the type of object referenced by `object_id` (e.g., 'account' for 'act\_...' IDs, 'campaign' for campaign IDs, 'adset' for ad set IDs, 'ad' for ad IDs); mismatches return empty or misleading metrics. Allowed values: 'account', 'campaign', 'adset', 'ad'.
>
> **limit** `integer`
>
> Maximum number of insight rows to return for this page. Use paging.cursors.after or paging.cursors.before from the response to request another page.
>
> **before** `string`
>
> Cursor for the previous page of results, usually taken from paging.cursors.before in the previous response.
>
> **fields** `string`
>
> List of metric fields to include in the response. Valid standalone fields include: impressions, clicks, spend, reach, cpc, cpm, ctr, frequency, account\_name, account\_id, campaign\_name, campaign\_id, adset\_name, adset\_id, ad\_name, ad\_id, objective, buying\_type, date\_start, date\_stop. For conversion/action metrics: 'actions' (returns all action types with counts), 'action\_values' (returns monetary values for all actions), 'conversions' (returns conversion-specific actions), 'conversion\_values' (returns monetary values for conversions). Breakdown dimensions such as publisher\_platform, platform\_position, impression\_device, age, gender, and country should be supplied through breakdowns; if included here they are moved automatically. Do NOT use 'conversion\_value' (singular) as it is not a valid field - use 'action\_values' or 'conversion\_values' instead.
>
> **filtering** `array`
>
> Filters to apply to the data
>
> **object\_id** `string` *required*
>
> ID of the object to get insights for (ad account, campaign, ad set, or ad). For ad accounts, the ID must include the act\_ prefix (e.g., act\_123456789). Campaign, ad set, and ad IDs are numeric only.
>
> **breakdowns** `array`
>
> List of breakdown dimensions to apply to the data, such as publisher\_platform, platform\_position, impression\_device, age, gender, country, region, or device\_platform.
>
> **time\_range** `object`
>
> Custom date range for the insights. If provided, date\_preset should be set to null/None to use this custom range instead. Must be a dict with keys `since` and `until` in YYYY-MM-DD format (e.g., \{'since': '2024-01-01', 'until': '2024-01-31'}). Never provide both time\_range and date\_preset simultaneously.
>
> **date\_preset** `string ("today" | "yesterday" | "last_7d" | "last_30d" | "this_month" | "last_month" | "this_quarter")`
>
> Predefined date range for the insights. Defaults to 'last\_30d' if neither date\_preset nor time\_range is specified. Allowed values: 'today', 'yesterday', 'last\_7d', 'last\_30d', 'this\_month', 'last\_month', 'this\_quarter'. Case-insensitive (e.g., 'LAST\_30D' is normalized to 'last\_30d'). Set to null/None only if you provide a custom time\_range.
>
> **time\_increment** `string`
>
> How to divide the selected date range into result periods. Use an integer from 1 to 90 for that many days per period, 'monthly' for calendar-month periods, or 'all\_days' for one period covering the full range. Omit this field to use Meta's default aggregation.
>
> **date\_range\_defaulted** `boolean`
>
> Internal field to track if date\_preset was defaulted. Do not set this manually.
>
> **field\_transformations** `array`
>
> Internal field to track any field transformations made. Do not set this manually.
>
> **breakdown\_transformations** `array`
>
> Internal field to track breakdown fields moved out of fields. Do not set this manually.
>
> **action\_attribution\_windows** `array`
>
> Attribution windows for conversion metrics. Defaults to `[7d_click]` to match Meta's unified attribution default; add `VIEW_1D`/`CLICK_28D`/etc. explicitly if you need legacy multi-window behavior. Different window values yield significantly different conversion counts; use consistent windows when comparing across campaigns or time periods.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Multiple Meta Objects
>
> **Slug:** `METAADS_GET_MULTIPLE_OBJECTS`
>
> Retrieve selected fields for up to 50 distinct Meta Marketing API objects. Results are keyed by object ID and may contain per-object errors; the connected token needs authorization for the requested objects and fields.
>
> #### Input Parameters
>
> **fields** `string` *required*
>
> Graph API fields to request for every object.
>
> **object\_ids** `array` *required*
>
> Distinct Meta Marketing API object IDs to retrieve (up to 50), such as ad accounts, campaigns, ad sets, ads, or ad creatives.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meta Object
>
> **Slug:** `METAADS_GET_OBJECT`
>
> Retrieve data for a Meta Marketing API object by numeric ID, an act\_-prefixed numeric ID, or me. Supports field selection for objects such as ad accounts, campaigns, ad sets, ads, creatives, pages, and users.
>
> #### Input Parameters
>
> **fields** `string`
>
> List of specific fields to retrieve from the object. If not specified, only basic fields (id, name) will be returned. Available fields depend on the object type. Common fields include: id, name, status, account\_id, created\_time, updated\_time. For ads: campaign\_id, adset\_id, creative. For campaigns: objective, buying\_type, daily\_budget. For ad creatives: asset\_feed\_spec, object\_story\_spec, image\_url, video\_id, title, body, link\_url, call\_to\_action\_type. For users: email, first\_name, last\_name. Note: For ad account objects, use 'ad\_account\_promotable\_objects' to retrieve promotable objects - the field name 'promotable\_objects' (without prefix) is not valid for ad accounts.
>
> **object\_id** `string` *required*
>
> The numeric ID of the Facebook Graph API object (e.g., '123456789012345'). Must be a numeric Facebook ID, not an image hash or other non-numeric identifier. Can be an ad account ID (with or without 'act\_' prefix), campaign ID, ad set ID, ad ID, ad creative ID, page ID, user ID, or any other Meta Marketing API object ID. For user info, use 'me' as the object\_id.
>
> **time\_range** `object`
>
> Custom date range for aggregating insights metrics.
>
> **date\_preset** `string ("today" | "yesterday" | "this_month" | "last_month" | "this_quarter" | "maximum" | "last_3d" | "last_7d" | "last_14d" | "last_28d" | "last_30d" | "last_90d" | "last_week_mon_sun" | "last_week_sun_sat" | "last_quarter" | "last_year" | "this_week_mon_today" | "this_week_sun_today" | "this_year")`
>
> Predefined date range options for aggregating insights metrics.
>
> **updated\_since** `integer`
>
> Unix timestamp to retrieve only objects updated since this time. Useful for incremental syncs and fetching recent changes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Page Accounts
>
> **Slug:** `METAADS_GET_PAGE_ACCOUNTS`
>
> Retrieve pages managed by the authenticated user, including page access tokens when requested. Results are paginated; use `paging.cursors.after` as the `after` input to retrieve the next page.
>
> #### Input Parameters
>
> **after** `string`
>
> Opaque cursor from paging.cursors.after in a previous response. Pass it unchanged to retrieve the next page.
>
> **limit** `integer`
>
> Maximum number of managed pages to return in this page of results.
>
> **fields** `string`
>
> Comma-separated list of fields to return for each page. Common fields: access\_token (page access token), name (page name), id (page ID), tasks (array of permissions/tasks), category (page category), category\_list (array of category objects with id and name).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pixel Event Stats
>
> **Slug:** `METAADS_GET_PIXEL_EVENT_STATS`
>
> Read recent Pixel event-count and processing statistics, optionally restricted to server events and one event name, to verify aggregate ingestion.
>
> #### Input Parameters
>
> **agent** `string`
>
> Partner-agent identifier used when the events were submitted.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous stats page; omit for the first page.
>
> **end\_time** `integer`
>
> Exclusive Unix timestamp in seconds; must be after start\_time.
>
> **pixel\_id** `string` *required*
>
> Numeric Pixel ID whose recent event statistics should be read.
>
> **event\_name** `string`
>
> Standard or custom event name to filter, such as Purchase.
>
> **start\_time** `integer`
>
> Inclusive Unix timestamp in seconds. Meta exposes up to seven recent days.
>
> **aggregation** `string ("event" | "pixel_fire" | "event_total_counts" | "match_keys" | "event_processing_results")`
>
> Grouping used for the returned statistics.
>
> **event\_source** `string ("WEB_ONLY" | "SERVER_ONLY")`
>
> Restrict statistics to browser/web or server-side event delivery.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `METAADS_GET_USER`
>
> Tool to retrieve information about the authenticated user from Meta (Facebook) Graph API. Use when you need to get the current user's profile information such as name, email, or other user details.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve about the authenticated user. Common fields: id (user's unique identifier), name (full name), email (requires email permission), first\_name, last\_name, picture (profile picture object), age\_range, birthday, gender, locale. By default returns id, name, and email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video
>
> **Slug:** `METAADS_GET_VIDEO`
>
> DEPRECATED: Use METAADS\_GET\_OBJECT instead. Tool to retrieve video information from Meta's Graph API by video ID. Use when you need to get video details such as the source URL for playback/download, permalink URL to view on Facebook, or other video metadata like title, description, length, and thumbnails.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve from the video object. Common fields include: id (video ID), source (direct video URL for playback/download), permalink\_url (permanent Facebook URL to view the video), created\_time (when video was created), title (video title), description (video description), length (duration in seconds), thumbnails (thumbnail images object), format (list of available video formats). By default returns id, source, and permalink\_url.
>
> **video\_id** `string` *required*
>
> The ID of the video to retrieve from Meta's Graph API
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Activities
>
> **Slug:** `METAADS_LIST_ACTIVITIES`
>
> List activity history for a Meta ad account or ad set.
>
> #### Input Parameters
>
> **after** `string`
>
> Opaque after cursor from the previous response's paging.cursors.after value. Omit for the first page.
>
> **limit** `integer`
>
> Maximum number of activities to return in this page.
>
> **since** `string`
>
> Optional lower datetime bound accepted by Meta for activity event times. Pass the provider datetime string without modification.
>
> **until** `string`
>
> Optional upper datetime bound accepted by Meta for activity event times. Pass the provider datetime string without modification.
>
> **fields** `string`
>
> Activity fields to return. Values are sent to Meta as a comma-separated list. Supported fields are actor\_id, actor\_name, application\_id, application\_name, date\_time\_in\_timezone, event\_time, event\_type, extra\_data, object\_id, object\_name, object\_type, tool, and translated\_event\_type.
>
> **object\_id** `string` *required*
>
> ID of the object whose activity history to list. Use an ad account ID with its act\_ prefix (for example, act\_123456789) or an ad set ID. Meta exposes this edge only for AdAccount and AdSet objects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Account Pixels
>
> **Slug:** `METAADS_LIST_AD_ACCOUNT_PIXELS`
>
> List the Pixels and consolidated datasets associated with an ad account so a usable data-source ID can be selected for Conversions API events.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum Pixels to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **sort\_by** `string ("LAST_FIRED_TIME" | "NAME")`
>
> Sort Pixels by name or by their most recent fired event time.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Account Recommendations
>
> **Slug:** `METAADS_LIST_AD_ACCOUNT_RECOMMENDATIONS`
>
> Return one page of Meta recommendations for an advertising account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum recommendation records to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Recommendation fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **recommendation\_names** `array`
>
> Meta recommendation names to include, such as ACCOUNT\_ERROR, AUTOMATIC\_PLACEMENTS, or CREATIVE\_FATIGUE.
>
> **recommendation\_stages** `array`
>
> Recommendation stages to include: MFR, PCR, or PFR.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Creatives
>
> **Slug:** `METAADS_LIST_AD_CREATIVES`
>
> List one page of ad creatives under a Meta Ads account to view or analyze creative assets.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of ad creatives to return per page (default 25).
>
> **fields** `string`
>
> Comma-separated list of fields to return for each ad creative. Supported fields include: id, name, status, account\_id, body, title, image\_url, image\_hash, video\_id, thumbnail\_url, link\_url, call\_to\_action\_type, object\_type, object\_id, object\_story\_spec, object\_story\_id, effective\_object\_story\_id, asset\_feed\_spec, template\_url, url\_tags, adlabels, applink\_treatment, authorization\_category, effective\_authorization\_category, and others. Note: 'effective\_status' is NOT supported for ad creatives (it's only available on Ads, Ad Sets, and Campaigns - use METAADS\_LIST\_ADS instead).
>
> **ad\_account\_id** `string` *required*
>
> The ad account ID to list ad creatives from. Can be provided with or without the 'act\_' prefix (e.g., 'act\_123456789' or '123456789').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Images
>
> **Slug:** `METAADS_LIST_AD_IMAGES`
>
> List one page of image assets in a Meta ad account, optionally restricted to exact image hashes.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum ad images to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Image fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **hashes** `array`
>
> Optional image hashes to match exactly in this ad account.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Network Analytics
>
> **Slug:** `METAADS_LIST_AD_NETWORK_ANALYTICS`
>
> Tool to retrieve ad network analytics for a Meta Business using the Meta Marketing API. Use when you need to get ad network performance metrics such as revenue or impressions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The Business ID to query ad network analytics for
>
> **limit** `integer`
>
> Maximum number of results to return per request (default 25, API default 2000)
>
> **metrics** `string` *required*
>
> Comma-separated list of metrics to retrieve. Example: fb\_ad\_network\_revenue
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Network Analytics Results
>
> **Slug:** `METAADS_LIST_AD_NETWORK_ANALYTICS_RESULTS`
>
> Tool to retrieve ad network analytics results for Facebook Audience Network. Use when you need to get performance data from ads displayed through Facebook Audience Network on third-party apps and websites for a specific business, app, or property.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve in the response. If not specified, returns default fields.
>
> **query\_id** `string`
>
> The query ID returned from a previous adnetworkanalytics request. Use this to retrieve the results of an asynchronous report generation. If not provided, returns all available results for the specified object ID.
>
> **object\_id** `string` *required*
>
> Business ID, App ID, or Property ID that uses Facebook Audience Network. This is the identifier for the entity whose ad network analytics results you want to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Rule History
>
> **Slug:** `METAADS_LIST_AD_RULE_HISTORY`
>
> Return one page of historical changes and executions for a Meta Automated Rule. Use next\_cursor to retrieve another page when has\_more is true.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum history entries to return in this page (1-100).
>
> **action** `string ("BUDGET_NOT_REDISTRIBUTED" | "CHANGED_BID" | "CHANGED_BUDGET" | "CONSOLIDATE_ASC_FRAGMENTATION" | "CONSOLIDATE_FRAGMENTATION" | "CONVERT_ASC_CP_SINGLE_INSTANCE" | "EMAIL" | "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET" | "ENABLE_ADVANTAGE_PLUS_AUDIENCE" | "ENABLE_ADVANTAGE_PLUS_CREATIVE" | "ENABLE_ADVANTAGE_PLUS_PLACEMENTS" | "ENABLE_AUTOFLOW" | "ENABLE_GEN_UNCROP" | "ENABLE_LANDING_PAGE_VIEWS" | "ENABLE_MUSIC" | "ENABLE_PIXELLESS_LPV_OPTIMIZATION_GOAL" | "ENABLE_PRODUCT_SET_BOOSTING" | "ENABLE_REELS_PLACEMENTS" | "ENABLE_SEMANTIC_BASED_AUDIENCE_EXPANSION" | "ENABLE_SHOPS_ADS" | "ENABLE_SHOPS_ADS_SAOFF" | "ENABLE_WTWA_UPSELL_IN_DUPLICATION" | "ENDPOINT_PINGED" | "ERROR" | "FACEBOOK_NOTIFICATION_SENT" | "MESSAGE_SENT" | "NOT_CHANGED" | "PAUSED" | "UNPAUSED")`
>
> Optional Meta Automated Rule history action to filter by.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> History fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **object\_id** `string`
>
> Optional ID of an affected ad object whose rule history should be returned.
>
> **ad\_rule\_id** `string` *required*
>
> Numeric ID of the Meta Automated Rule whose history should be listed.
>
> **hide\_no\_changes** `boolean`
>
> Whether to omit history entries where the rule made no change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ads
>
> **Slug:** `METAADS_LIST_ADS`
>
> List a page of ads under a Meta ad account, with optional selection of returned fields.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of ads to return per page (default 25, max 100)
>
> **fields** `string`
>
> Comma-separated list of fields to return. Common fields: id, name, adset\_id, campaign\_id, status, effective\_status, created\_time, updated\_time, creative, tracking\_specs, conversion\_specs, targeting, bid\_amount, source\_ad\_id, preview\_shareable\_link.
>
> **ad\_account\_id** `string` *required*
>
> The ad account ID (with or without 'act\_' prefix, e.g., 'act\_123456789' or '123456789')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Studies
>
> **Slug:** `METAADS_LIST_AD_STUDIES`
>
> List one page of A/B tests and other ad studies owned by a Meta business, including projected cells.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum ad studies to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Ad-study fields to return. Provide individual Graph field names; a one-level nested projection such as cells\{id,name} is supported.
>
> **business\_id** `string` *required*
>
> Numeric ID of the Meta business that owns the ad studies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ad Videos
>
> **Slug:** `METAADS_LIST_AD_VIDEOS`
>
> List one page of video assets in a Meta ad account, optionally filtered by title, dimensions, duration, or aspect ratio.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum ad videos to return in this page.
>
> **title** `string`
>
> Optional video title to use in Meta's video-name filter.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Video fields to return. Provide individual Graph API field names; they are sent to Meta as a comma-separated fields projection.
>
> **max\_width** `integer`
>
> Optional maximum video width in pixels.
>
> **min\_width** `integer`
>
> Optional minimum video width in pixels.
>
> **max\_height** `integer`
>
> Optional maximum video height in pixels.
>
> **max\_length** `integer`
>
> Optional maximum video duration for the filter.
>
> **min\_height** `integer`
>
> Optional minimum video height in pixels.
>
> **min\_length** `integer`
>
> Optional minimum video duration for the filter.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **max\_aspect\_ratio** `number`
>
> Optional maximum video width-to-height ratio.
>
> **min\_aspect\_ratio** `number`
>
> Optional minimum video width-to-height ratio.
>
> **include\_total\_count** `boolean`
>
> Set true to ask Meta for the total matching video count. Meta returns it as summary.total\_count when available.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Agencies
>
> **Slug:** `METAADS_LIST_AGENCIES`
>
> Tool to retrieve agencies associated with a Meta Business or Ad Account. Use when you need to get the list of agencies that have access to manage a specific business or ad account.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the Business or Ad Account to fetch agencies from. This can be a Business ID (numeric) or an Ad Account ID (with or without 'act\_' prefix).
>
> **limit** `integer`
>
> Maximum number of agencies to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each agency. Common fields: id, name. The 'id' field returns the agency ID, while 'name' returns the agency name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Assigned Pages
>
> **Slug:** `METAADS_LIST_ASSIGNED_PAGES`
>
> Tool to retrieve Facebook Pages assigned to a business user via Meta Marketing API. Use when you need to get the list of pages a business user has access to.
>
> #### Input Parameters
>
> **business\_user\_id** `string` *required*
>
> The ID of the business user. Can be obtained from GET /\{business\_id}/business\_users endpoint
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Assigned Users
>
> **Slug:** `METAADS_LIST_ASSIGNED_USERS`
>
> Tool to list users assigned to a Facebook Page or Ad Account within a specific business context. Use when you need to retrieve the list of users who have access to a Page or Ad Account and their associated task permissions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the Page or Ad Account to list assigned users for. For Ad Accounts, use the account ID with or without the 'act\_' prefix (e.g., 'act\_123456789' or '123456789'). For Pages, use the Page ID (e.g., '916958084834651').
>
> **after** `string`
>
> Cursor for forward pagination.
>
> **limit** `integer`
>
> Maximum number of results to return per page.
>
> **before** `string`
>
> Cursor for backward pagination.
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each assigned user. Available fields: id, name, tasks. Defaults to 'id,name,tasks' to retrieve all standard fields.
>
> **business** `string` *required*
>
> Business ID to filter assigned users by business context. This parameter is required when calling assigned\_users on Page or AdAccount objects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Ad Accounts
>
> **Slug:** `METAADS_LIST_BUSINESS_AD_ACCOUNTS`
>
> Retrieve a page of ad accounts owned by a specific Business Manager, including account IDs, names, and status.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of ad accounts to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve. Common fields: id, name, account\_id, account\_status, currency, timezone\_name, business\_name, business. The 'id' field returns the ad account ID prefixed with 'act\_', while 'account\_id' returns the numeric ID without prefix.
>
> **business\_id** `string` *required*
>
> The ID of the business to retrieve owned ad accounts for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Businesses
>
> **Slug:** `METAADS_LIST_BUSINESSES`
>
> List a page of Business Managers accessible to the authenticated Meta principal via /me/businesses. Requires the business\_management permission on the connected token.
>
> #### Input Parameters
>
> **after** `string`
>
> Pagination cursor. Pass the `paging.cursors.after` value from a previous response to fetch the next page.
>
> **limit** `integer`
>
> Maximum number of businesses to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each business. Common fields: id, name, created\_time, verification\_status, permitted\_roles, primary\_page, timezone\_id, vertical.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Invoices
>
> **Slug:** `METAADS_LIST_BUSINESS_INVOICES`
>
> Tool to retrieve business invoices from Meta Marketing API. Use when you need to fetch invoice data for a business including amounts, due dates, and payment status.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the business to retrieve invoices for
>
> **type** `string ("CM" | "DM" | "INV" | "PRO_FORMA")`
>
> Type of invoice from OmegaCustomerTrx.Type enum.
>
> **after** `string`
>
> Cursor for forward pagination.
>
> **limit** `integer`
>
> Maximum number of results to return per page.
>
> **before** `string`
>
> Cursor for backward pagination.
>
> **root\_id** `string`
>
> Root ID for filtering invoices. Use string form — Meta/Business IDs can exceed JavaScript's 2^53 safe integer limit and lose precision when an LLM JSON-parses them as `int`.
>
> **end\_date** `string`
>
> End date for filtering invoices (YYYY-MM-DD format)
>
> **invoice\_id** `string`
>
> Specific invoice ID to retrieve
>
> **start\_date** `string`
>
> Start date for filtering invoices (YYYY-MM-DD format)
>
> **issue\_end\_date** `string`
>
> Issue end date for filtering invoices (YYYY-MM-DD format)
>
> **issue\_start\_date** `string`
>
> Issue start date for filtering invoices (YYYY-MM-DD format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Users
>
> **Slug:** `METAADS_LIST_BUSINESS_USERS`
>
> List active human users associated with a Meta Business Manager.
>
> #### Input Parameters
>
> **after** `string`
>
> Opaque cursor from a previous response's paging.cursors.after value. Pass it unchanged to retrieve the next page.
>
> **limit** `integer`
>
> Maximum number of business users to return in this page.
>
> **fields** `string`
>
> Comma-separated BusinessUser fields to return. Common fields are id, name, and role.
>
> **business\_id** `string` *required*
>
> Business Manager ID whose active human users should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `METAADS_LIST_CAMPAIGNS`
>
> List one page of campaigns belonging to a Meta ad account.
>
> #### Input Parameters
>
> **after** `string`
>
> Opaque cursor from paging.cursors.after in a previous response. Pass it unchanged to retrieve the next page.
>
> **limit** `integer`
>
> Maximum number of campaigns to return on this page.
>
> **fields** `string`
>
> Campaign fields to return. The action sends these to Meta as a comma-separated fields parameter.
>
> **ad\_account\_id** `string` *required*
>
> Ad account ID, with or without the 'act\_' prefix.
>
> **effective\_status** `array`
>
> Return campaigns matching any supplied effective status. ARCHIVED is supported when archived records are needed; Meta v26 rejects DELETED for this list endpoint even though deleted status remains valid elsewhere.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Catalog Products
>
> **Slug:** `METAADS_LIST_CATALOG_PRODUCTS`
>
> Return one filtered page of products from a Meta product catalog.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum products to return in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Product fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **filter** `object`
>
> Meta Product Catalog filter object, encoded as JSON on the wire.
>
> **summary** `boolean`
>
> Whether Meta should include collection summary metadata.
>
> **catalog\_id** `string` *required*
>
> Numeric Meta product catalog ID.
>
> **error\_type** `string`
>
> Provider-defined catalog error code used to filter products.
>
> **error\_priority** `string ("HIGH" | "LOW" | "MEDIUM")`
>
> Return products associated with catalog errors of this priority.
>
> **bulk\_pagination** `boolean`
>
> Whether Meta should use bulk pagination for the product collection.
>
> **return\_only\_approved\_products** `boolean`
>
> Whether to return only products approved by Meta.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Catalog Product Sets
>
> **Slug:** `METAADS_LIST_CATALOG_PRODUCT_SETS`
>
> Return one filtered page of product sets from a Meta product catalog.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum product sets to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Product-set fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **parent\_id** `string`
>
> Return direct children of this numeric product-set ID.
>
> **catalog\_id** `string` *required*
>
> Numeric ID of the Meta product catalog whose product sets to list.
>
> **ancestor\_id** `string`
>
> Return descendants of this numeric product-set ID.
>
> **retailer\_id** `string`
>
> Filter product sets by their retailer identifier.
>
> **has\_children** `boolean`
>
> Filter by whether product sets have child sets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Ad Accounts
>
> **Slug:** `METAADS_LIST_CLIENT_AD_ACCOUNTS`
>
> List one page of client ad accounts shared with a Meta Business Manager.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of ad accounts to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve. Common fields: id, name, account\_id, currency, timezone\_name, account\_status, business\_name, business. The 'id' field returns the ad account ID prefixed with 'act\_', while 'account\_id' returns the numeric ID without prefix.
>
> **business\_id** `string` *required*
>
> The business ID to fetch client ad accounts from
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Apps
>
> **Slug:** `METAADS_LIST_CLIENT_APPS`
>
> Tool to retrieve client apps associated with a Meta Business using the Marketing API. Use when you need to get information about apps linked to a specific business.
>
> #### Input Parameters
>
> **after** `string`
>
> Cursor for forward pagination.
>
> **limit** `integer`
>
> Maximum number of results to return per page.
>
> **before** `string`
>
> Cursor for backward pagination.
>
> **business\_id** `string` *required*
>
> The ID of the Business object. Can be obtained from GET /me/businesses endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Instagram Assets
>
> **Slug:** `METAADS_LIST_CLIENT_INSTAGRAM_ASSETS`
>
> Tool to retrieve Instagram assets that are shared with a business as a client using the Meta Marketing API. Use when you need to fetch Instagram accounts or assets linked to a specific business ID.
>
> #### Input Parameters
>
> **after** `string`
>
> Cursor for pagination. Use the 'after' cursor from the previous response to fetch the next page of results.
>
> **limit** `integer`
>
> Maximum number of Instagram assets to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each Instagram asset. If not specified, default fields will be returned.
>
> **business\_id** `string` *required*
>
> The business ID whose client Instagram assets to retrieve. Can be obtained from /me/businesses endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Offsite Signal Container Business Objects
>
> **Slug:** `METAADS_LIST_CLIENT_OFFSITE_SIGNAL_CONTAINERS`
>
> Retrieve one page of client offsite signal container business objects for a business using the Meta Marketing API.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business ID - The ID of the business to query for client offsite signal container business objects
>
> **limit** `integer`
>
> Maximum number of client offsite signal container business objects to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve from the client offsite signal container business objects. If not specified, default fields will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Pages
>
> **Slug:** `METAADS_LIST_CLIENT_PAGES`
>
> Tool to retrieve client pages associated with a Meta business. Use when you need to get the list of pages that a business manages on behalf of clients.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the business to retrieve client pages for. Can be obtained via GET /me/businesses endpoint.
>
> **limit** `integer`
>
> Maximum number of client pages to return per request. Use this parameter to control pagination.
>
> **fields** `string`
>
> List of fields to retrieve for each client page. Common fields include: id, name, access\_token, category, tasks. If not specified, default fields are returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Clients
>
> **Slug:** `METAADS_LIST_CLIENTS`
>
> Tool to retrieve client businesses associated with a Meta Business Manager. Use when you need to get the list of businesses that are clients of a specific Business Manager.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business Manager ID to fetch client businesses from. Can be obtained from GET /me/businesses endpoint.
>
> **limit** `integer`
>
> Maximum number of client businesses to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each client business. Common fields: id, name. The 'id' field returns the client business ID, while 'name' returns the client business name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Collaborative Ads Collaboration Requests
>
> **Slug:** `METAADS_LIST_COLLABORATIVE_ADS_COLLABORATION_REQUESTS`
>
> Tool to retrieve collaborative ads collaboration requests for a Meta Business using the Marketing API. Use when you need to get collaboration requests related to collaborative advertising partnerships for a specific business.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The Business ID to retrieve collaborative ads collaboration requests for. This is typically obtained from the /me/businesses endpoint.
>
> **limit** `integer`
>
> Maximum number of collaboration requests to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each collaboration request. If not specified, default fields will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Collaborative Ads Suggested Partners
>
> **Slug:** `METAADS_LIST_COLLABORATIVE_ADS_SUGGESTED_PARTNERS`
>
> Tool to retrieve collaborative ads suggested partners for a business from Meta Marketing API. Use when you need to discover potential partnership opportunities for collaborative advertising campaigns.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of suggested partners to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each suggested partner. If not specified, default fields will be returned.
>
> **business\_id** `string` *required*
>
> Business ID to retrieve collaborative ads suggested partners for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Comments
>
> **Slug:** `METAADS_LIST_COMMENTS`
>
> Return one page from the comments edge of a Page-owned post, photo, video, comment, or reply. The connected token needs pages\_read\_engagement and pages\_read\_user\_content for that Page; Meta can require the Page MODERATE task to expose Page-post comment IDs.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum comments to return in this page (1-100).
>
> **order** `string ("chronological" | "reverse_chronological")`
>
> Order in which Meta returns comments.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Comment fields to return. Field availability depends on the parent type and the connected token's permissions.
>
> **filter** `string ("toplevel" | "stream")`
>
> Comment level filter. `toplevel` returns top-level comments; `stream` returns all levels in chronological order.
>
> **object\_id** `string` *required*
>
> Graph ID of a Page-owned post, photo, video, comment, or comment reply whose comments edge is readable. Composite Page-post IDs are accepted; the ID is not required to be numeric.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Audiences
>
> **Slug:** `METAADS_LIST_CUSTOM_AUDIENCES`
>
> List one page of custom audiences in a Meta ad account, with field projection and optional business, primary-audience, or Pixel constraints.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum custom audiences to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Custom-audience fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **pixel\_id** `string`
>
> Return custom audiences associated with this Pixel ID.
>
> **business\_id** `string`
>
> Return audiences associated with this Meta business ID.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **fetch\_primary\_audience** `boolean`
>
> Whether Meta should include each audience's primary audience data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Conversions
>
> **Slug:** `METAADS_LIST_CUSTOM_CONVERSIONS`
>
> List one page of custom-conversion definitions in a Meta ad account, with field projection and opaque cursor pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum custom conversions to return in this page. Use the returned cursor when Meta has more results.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Custom-conversion fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Initiated Audience Sharing Requests
>
> **Slug:** `METAADS_LIST_INITIATED_AUDIENCE_SHARING_REQUESTS`
>
> Tool to retrieve initiated audience sharing requests for a business using the Meta Marketing API. Use when you need to get the list of audience sharing requests that have been initiated by a business.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business ID to retrieve initiated audience sharing requests for. Can be obtained from the /me/businesses endpoint.
>
> **after** `string`
>
> Cursor for pagination - use the 'after' cursor from the previous response to fetch the next page
>
> **limit** `integer`
>
> Maximum number of sharing requests to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each sharing request. If not specified, default fields will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Leads
>
> **Slug:** `METAADS_LIST_LEADS`
>
> List one page of leads belonging to a Meta Ad or Leadgen Form.
>
> #### Input Parameters
>
> **after** `string`
>
> Opaque paging cursor from paging.cursors.after in a previous response. Pass it back unchanged to retrieve the next page.
>
> **limit** `integer`
>
> Maximum number of leads to return in this page.
>
> **fields** `string`
>
> Lead fields to return. Values are sent to Meta as one comma-separated fields parameter. Supported fields are id, created\_time, ad\_id, ad\_name, adset\_id, adset\_name, campaign\_id, campaign\_name, form\_id, field\_data, custom\_disclaimer\_responses, is\_organic, platform, partner\_name, post, post\_submission\_check\_result, home\_listing, retailer\_item\_id, and vehicle.
>
> **source\_object\_id** `string` *required*
>
> ID of the Meta Ad or Leadgen Form whose leads should be listed. This must be an Ad ID or Leadgen Form ID, not an ad account, campaign, ad set, Page, or lead ID. The connected user or system user must also have object-level access to the source and its leads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Managed Partner Ads Funding Source Details
>
> **Slug:** `METAADS_LIST_MANAGED_PARTNER_ADS_FUNDING_SOURCE_DETAILS`
>
> Tool to retrieve managed partner ads funding source details for a Meta Business. Use when you need to get funding source information for managed partner ads associated with a specific business.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business ID - The ID of the business to retrieve managed partner ads funding source details for. This should be a Business node ID, not a User ID or Ad Account ID.
>
> **limit** `integer`
>
> Maximum number of results to return per request (default 25)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Apps
>
> **Slug:** `METAADS_LIST_OWNED_APPS`
>
> Tool to retrieve apps owned by a business from Meta Marketing API. Use when you need to get information about apps associated with a business account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of owned apps to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve. Available fields: id, name, link, category
>
> **business\_id** `string` *required*
>
> The ID of the business to retrieve owned apps for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Businesses
>
> **Slug:** `METAADS_LIST_OWNED_BUSINESSES`
>
> Tool to retrieve businesses owned by a parent Business Manager from Meta Marketing API. Use when you need to list child businesses managed under a Business Manager account in a Tier-2 business hierarchy.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of owned businesses to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each owned business. Common fields: id, name, created\_time, link, timezone\_id, vertical, verification\_status
>
> **business\_id** `string` *required*
>
> The ID of the parent Business Manager to retrieve owned businesses from
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Instagram Assets
>
> **Slug:** `METAADS_LIST_OWNED_INSTAGRAM_ASSETS`
>
> Tool to list Instagram accounts/assets owned by a Meta Business. Use when you need to retrieve the Instagram Business Accounts associated with a specific Meta Business.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of Instagram assets to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to return for each Instagram asset (e.g., id,username). Common fields include: id, username, name, profile\_picture\_url, followers\_count, follows\_count, media\_count, ig\_id.
>
> **business\_id** `string` *required*
>
> Business ID - can be obtained from /me/businesses endpoint. This is the Meta Business ID that owns the Instagram assets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Offsite Signal Container Business Objects
>
> **Slug:** `METAADS_LIST_OWNED_OFFSITE_SIGNAL_CONTAINER_BUSINESS_OBJECTS`
>
> Retrieve one page of owned offsite signal container business objects associated with a specific business ID from the Meta Marketing API.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business ID - The ID of the business to query for owned offsite signal container business objects
>
> **limit** `integer`
>
> Maximum number of owned offsite signal container business objects to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve from the owned offsite signal container business objects. If not specified, default fields will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Pages
>
> **Slug:** `METAADS_LIST_OWNED_PAGES`
>
> Retrieve a page of Facebook Pages owned by a Business Manager from the Meta Marketing API.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pages to return per request (default 25)
>
> **fields** `string`
>
> Comma-separated list of Page fields to return. Common fields include: id, name, category, access\_token, category\_list, tasks, fan\_count, link, picture, verification\_status. If not specified, only basic fields (id, name) are returned.
>
> **business\_id** `string` *required*
>
> The ID of the Business Manager to list owned pages for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Product Catalogs
>
> **Slug:** `METAADS_LIST_OWNED_PRODUCT_CATALOGS`
>
> Return one page of product catalogs owned by a Meta Business Manager.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum product catalogs to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Product catalog fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **business\_id** `string` *required*
>
> Numeric ID of the Meta Business Manager that owns the catalogs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Client Ad Accounts
>
> **Slug:** `METAADS_LIST_PENDING_CLIENT_AD_ACCOUNTS`
>
> Tool to retrieve pending client ad account access requests for a Business Manager from Meta Ads. Use when you need to get ad accounts that are awaiting approval to be added as clients to a business.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pending client ad accounts to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve. Available fields: id (ad account ID), name (ad account name), permitted\_tasks (list of tasks permitted for this ad account).
>
> **business\_id** `string` *required*
>
> The ID of the Business Manager to retrieve pending client ad account access requests from
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Client Apps
>
> **Slug:** `METAADS_LIST_PENDING_CLIENT_APPS`
>
> Tool to retrieve pending client apps for a Meta Business. Use when you need to list apps that are pending approval or connection to a business account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pending client apps to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each pending client app. If not specified, default fields will be returned.
>
> **business\_id** `string` *required*
>
> The Business ID to retrieve pending client apps for. Can be retrieved from /me?fields=businesses endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Client Pages
>
> **Slug:** `METAADS_LIST_PENDING_CLIENT_PAGES`
>
> Tool to retrieve pending client pages for a Business Manager using the Meta Marketing API. Use when you need to see which Facebook Pages have pending access requests from the business.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pages to return per request (default 25)
>
> **business\_id** `string` *required*
>
> The Business Manager ID to retrieve pending client pages for. This is the numeric ID of the business.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Shared Offsite Signal Container Business Objects
>
> **Slug:** `METAADS_LIST_PENDING_OFFSITE_SIGNAL_CONTAINERS`
>
> Tool to retrieve pending shared offsite signal container business objects from Meta Marketing API. Use when you need to get information about pending shared offsite signal containers associated with a business account.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Business ID to retrieve pending shared offsite signal container business objects for
>
> **limit** `integer`
>
> Maximum number of items to return (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve from the pending shared offsite signal container business objects
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Owned Ad Accounts
>
> **Slug:** `METAADS_LIST_PENDING_OWNED_AD_ACCOUNTS`
>
> Tool to retrieve pending owned ad accounts for a Business Manager account from Meta Marketing API. Use when you need to list ad accounts with pending ownership status for a specific business.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pending ad accounts to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each pending ad account. Common fields: id, account\_id, name, currency, timezone\_name, account\_status.
>
> **business\_id** `string` *required*
>
> The Business ID to retrieve pending owned ad accounts for. This is the ID of the Business Manager account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Owned Pages
>
> **Slug:** `METAADS_LIST_PENDING_OWNED_PAGES`
>
> Tool to retrieve Pages with pending ownership status for a Business Manager from Meta Marketing API. Use when you need to get a list of Facebook Pages that are pending approval or verification for a business to own.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pages to return per request (default 25)
>
> **fields** `string`
>
> Comma-separated list of Page fields to return. Common fields include: id, name, category, access\_token, category\_list, tasks, fan\_count, link, picture, verification\_status. If not specified, only basic fields (id, name) are returned.
>
> **business\_id** `string` *required*
>
> The ID of the Business Manager to list pending owned pages for. This should be the business ID, not a user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pending Users
>
> **Slug:** `METAADS_LIST_PENDING_USERS`
>
> Tool to retrieve pending users from a Business Manager in Meta Marketing API. Use when you need to get information about users with pending invitations to a Business Manager.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The Business Manager ID to retrieve pending users from
>
> **limit** `integer`
>
> Maximum number of pending users to return per request (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to return. Common fields include: id, email, name, role. Specify the fields you want to retrieve in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Promotable Pages
>
> **Slug:** `METAADS_LIST_PROMOTABLE_PAGES`
>
> Return one page of Facebook Pages available for promotion from a Meta ad account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum promotable Pages to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Page fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Received Audience Sharing Requests
>
> **Slug:** `METAADS_LIST_RECEIVED_AUDIENCE_SHARING_REQUESTS`
>
> Retrieve a page of received audience sharing requests for a business using the Meta Marketing API. Use it to see requests from other businesses to share custom audiences.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The Business ID to retrieve received audience sharing requests for. This is the ID of the business entity that has received sharing requests from other businesses.
>
> **limit** `integer`
>
> Maximum number of audience sharing requests to return (default 25)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscribed Apps
>
> **Slug:** `METAADS_LIST_SUBSCRIBED_APPS`
>
> List one page of applications subscribed to a Meta ad account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum subscribed applications to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List System Users
>
> **Slug:** `METAADS_LIST_SYSTEM_USERS`
>
> List one page of system users associated with a Meta Business Manager account, with pagination information when returned.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of system users to return per page (default 25)
>
> **fields** `string`
>
> Comma-separated list of fields to retrieve for each system user. Common fields include: id, name, role. The 'id' field returns the system user's unique identifier, 'name' returns the display name, and 'role' indicates the permission level.
>
> **business\_id** `string` *required*
>
> The ID of the business to retrieve system users for. This is the Business Manager ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Targeting Search
>
> **Slug:** `METAADS_LIST_TARGETING_SEARCH`
>
> Tool to search for targeting options in Meta Ads Marketing API. Use when you need to find interests, locations, demographics, schools, or employers for ad targeting purposes.
>
> #### Input Parameters
>
> **q** `string` *required*
>
> The search query string to find current targeting options. Meta consolidates some detailed-targeting interests, so use the returned current ID instead of a cached historical ID when creating an ad set. For example, use 'fitness' for interests or 'New York' for locations.
>
> **type** `string ("adinterest" | "adgeolocation" | "adTargetingCategory" | "adeducationschool" | "adworkemployer")` *required*
>
> The targeting search type to query. Options: 'adinterest' (interests), 'adgeolocation' (locations), 'adTargetingCategory' (targeting categories), 'adeducationschool' (schools), 'adworkemployer' (employers).
>
> **class** `string`
>
> The demographic class for refined searches. Common values: 'demographics', 'family\_statuses', 'income', 'industries', 'life\_events'. Use this to narrow down search results to specific demographic categories.
>
> **limit** `integer`
>
> Maximum number of results to return. If not specified, the API will use its default limit.
>
> **location\_types** `array`
>
> For geolocation searches (type='adgeolocation'), specify location types to filter results. Common values: 'city', 'country', 'region', 'zip'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Targeting Suggestions
>
> **Slug:** `METAADS_LIST_TARGETING_SUGGESTIONS`
>
> Return Meta targeting options related to a provider-native seed targeting list for an ad account.
>
> #### Input Parameters
>
> **mode** `string ("best_performing" | "recently_used" | "related" | "suggestions")`
>
> Meta SDK suggestion mode controlling how seed entries are expanded.
>
> **limit** `integer`
>
> Maximum number of related targeting suggestions to return.
>
> **objects** `object`
>
> Provider-native Meta object context. Pass a parsed object; the action compact JSON-encodes it for the GET query.
>
> **app\_store** `string ("all_app_stores_for_android_and_ios" | "amazon_app_store" | "apk_mirror" | "apk_monk" | "apk_pure" | "aptoide_a1_store" | "bemobi_mobile_store" | "digital_turbine_store" | "does_not_exist" | "fb_android_store" | "fb_canvas" | "fb_gameroom" | "galaxy_store" | "google_play" | "horizon_world" | "instant_game" | "itunes" | "itunes_ipad" | "neon_android_store" | "none" | "oculus_app_store" | "oppo" | "roku_channel_store" | "uptodown" | "vivo" | "windows_10_store" | "windows_store" | "xiaomi")`
>
> Meta app store used to contextualize app-related suggestions.
>
> **countries** `array`
>
> Country codes used by Meta to contextualize targeting suggestions.
>
> **objective** `string ("APP_INSTALLS" | "BRAND_AWARENESS" | "CONVERSIONS" | "EVENT_RESPONSES" | "LEAD_GENERATION" | "LINK_CLICKS" | "LOCAL_AWARENESS" | "MESSAGES" | "OFFER_CLAIMS" | "OUTCOME_APP_PROMOTION" | "OUTCOME_AWARENESS" | "OUTCOME_ENGAGEMENT" | "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC" | "PAGE_LIKES" | "POST_ENGAGEMENT" | "PRODUCT_CATALOG_SALES" | "REACH" | "STORE_VISITS" | "VIDEO_VIEWS")`
>
> Campaign objective used by Meta to rank or filter suggestions.
>
> **limit\_type** `string ("behaviors" | "college_years" | "education_majors" | "education_schools" | "education_statuses" | "ethnic_affinity" | "family_statuses" | "generation" | "home_ownership" | "home_type" | "home_value" | "household_composition" | "income" | "industries" | "interested_in" | "interests" | "life_events" | "location_categories" | "moms" | "net_worth" | "office_type" | "politics" | "relationship_statuses" | "user_adclusters" | "work_employers" | "work_positions")`
>
> Meta targeting category to which suggestions should be limited.
>
> **session\_id** `integer`
>
> Unsigned Meta SDK session identifier for suggestion requests.
>
> **ad\_account\_id** `string` *required*
>
> Numeric ad account ID, with or without the act\_ prefix. The prefix is normalized before the request is sent.
>
> **targeting\_list** `array` *required*
>
> Provider-native seed targeting entries. Pass parsed objects such as interest IDs; the action compact JSON-encodes the list for Meta.
>
> **whitelisted\_types** `array`
>
> Meta SDK targeting field names allowed in the suggestions, such as interests, behaviors, or geo\_locations.
>
> **regulated\_countries** `array`
>
> Meta regulated country codes applied to the suggestions.
>
> **regulated\_categories** `array`
>
> Meta regulated ad categories applied to the suggestions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Permissions
>
> **Slug:** `METAADS_LIST_USER_PERMISSIONS`
>
> Inspect permission names and grant statuses for the connected Meta user, optionally filtered by permission or status.
>
> #### Input Parameters
>
> **status** `string ("granted" | "declined" | "expired")`
>
> Grant status to filter by.
>
> **permission** `string`
>
> Permission name to filter by, such as ads\_read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Video Tags
>
> **Slug:** `METAADS_LIST_VIDEO_TAGS`
>
> Return one page of TaggableSubject entries from a Video's `/tags` edge. This is video-only: the connected access token must be able to read that Video and its visible tags, so results depend on the video's ownership, privacy, and the token's Page or user permissions.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum video tags to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Video-tag fields to return. The edge returns a TaggableSubject (`id`, `name`) and can return `created_time`.
>
> **video\_id** `string` *required*
>
> Graph ID of the Video whose tags should be read. Composite and non-numeric Graph IDs are accepted; this action does not read tags from arbitrary object types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Video Thumbnails
>
> **Slug:** `METAADS_LIST_VIDEO_THUMBNAILS`
>
> List one page of available thumbnail variants for a Meta video. Use next\_cursor to retrieve another page when has\_more is true.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum video thumbnails to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous call. Omit it for the first page and pass it back unchanged.
>
> **fields** `string`
>
> Thumbnail fields to return. Provide individual Graph API field names, not a comma-separated string.
>
> **video\_id** `string` *required*
>
> Numeric ID of the Meta video whose thumbnail variants should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Preview Ad Creative
>
> **Slug:** `METAADS_PREVIEW_AD_CREATIVE`
>
> Retrieve a preview thumbnail URL for an ad creative, with optional thumbnail dimensions.
>
> #### Input Parameters
>
> **creative\_id** `string` *required*
>
> ID of the ad creative to preview.         Get this from:         - CreateAdCreative response         - Existing ad creative lookup         Format: 23842938523454
>
> **thumbnail\_width** `integer`
>
> Width of the preview thumbnail in pixels.         - Default: 150px         - Min: 50px         - Max: 1200px         Larger sizes give better quality but load slower.
>
> **thumbnail\_height** `integer`
>
> Height of the preview thumbnail in pixels.         - Default: 120px         - Min: 50px         - Max: 1200px         Choose based on your display needs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Ad Sets
>
> **Slug:** `METAADS_READ_ADSETS`
>
> Retrieve ad sets from a Meta ad account using the Marketing API. Returns information about the ad sets including their status, targeting, and other properties.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of adsets to return
>
> **fields** `string`
>
> Fields to return for each ad set. Select from the AdSetField enum values (e.g., name, id, status, daily\_budget, targeting, campaign\_id, effective\_status). Defaults to name, id, and status if not specified.
>
> **date\_preset** `string ("today" | "yesterday" | "this_month" | "last_month" | "this_quarter" | "maximum" | "data_maximum" | "last_3d" | "last_7d" | "last_14d" | "last_28d" | "last_30d" | "last_90d" | "last_week_mon_sun" | "last_week_sun_sat" | "last_quarter" | "last_year" | "this_week_mon_today" | "this_week_sun_today" | "this_year")`
>
> Predefined date range used to aggregate insights metrics. Values are case-insensitive (e.g., 'this\_year' or 'THIS\_YEAR').
>
> **is\_completed** `boolean`
>
> Filter adsets by completed status
>
> **ad\_account\_id** `string` *required*
>
> ID of the ad account to fetch adsets from
>
> **updated\_since** `integer`
>
> Time since the Adset has been updated (in seconds)
>
> **effective\_status** `array`
>
> Filter adsets by their effective status. Values are case-insensitive (e.g., 'active' or 'ACTIVE').
>
> **time\_range\_since** `string`
>
> Start date in YYYY-MM-DD format for custom date range
>
> **time\_range\_until** `string`
>
> End date in YYYY-MM-DD format for custom date range
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename Ad Object
>
> **Slug:** `METAADS_RENAME_AD_OBJECT`
>
> Rename an existing Meta campaign, ad set, ad, or ad creative.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Non-empty new display name. Surrounding whitespace is removed.
>
> **object\_id** `string` *required*
>
> Numeric ID of the existing campaign, ad set, ad, or ad creative.
>
> **object\_type** `string ("campaign" | "ad_set" | "ad" | "ad_creative")` *required*
>
> Advertising object type for the node being renamed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Conversion Events
>
> **Slug:** `METAADS_SEND_CONVERSION_EVENTS`
>
> Irreversibly submit 1-1,000 validated server conversion events to a Meta Pixel or dataset. A test\_event\_code routes events to Test Events but does not prevent targeting or measurement side effects; production submission requires explicit confirmation.
>
> #### Input Parameters
>
> **events** `array` *required*
>
> Batch of 1-1,000 server events. Local validation rejects the complete call when any event is invalid.
>
> **upload\_id** `string`
>
> ASCII-digit identifier shared by events in one offline upload. Preserved as a string.
>
> **upload\_tag** `string`
>
> Caller-defined offline upload tag.
>
> **namespace\_id** `string`
>
> ASCII-digit namespace ID for applicable offline uploads. Preserved as a string.
>
> **partner\_agent** `string`
>
> Stable lowercase integration or partner identifier sent with the events.
>
> **upload\_source** `string`
>
> Source label for an offline upload.
>
> **test\_event\_code** `string`
>
> Current Events Manager Test Events code. Test Events are not dropped and can still affect targeting and measurement; omit only for an explicitly confirmed production submission.
>
> **confirm\_production** `boolean`
>
> Set true only to submit without test\_event\_code. This local safety confirmation is never sent to Meta; Test Events can still affect targeting and measurement.
>
> **pixel\_or\_dataset\_id** `string` *required*
>
> Numeric Pixel ID for website events or dataset ID for offline/multi-source events. Never pass an ad account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Ad Object Status
>
> **Slug:** `METAADS_SET_AD_OBJECT_STATUS`
>
> Set an Ad, Ad Set, or Campaign to ACTIVE or PAUSED, or destructively ARCHIVE or DELETE it. Campaign status changes affect child delivery.
>
> #### Input Parameters
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")` *required*
>
> Configured status to set. ACTIVE resumes delivery; PAUSED stops delivery. ARCHIVED and DELETED are destructive and can restrict or prevent later updates. Changing Campaign status also affects child Ad Set and Ad delivery.
>
> **object\_id** `string` *required*
>
> Numeric ID of the existing Meta Ad, Ad Set, or Campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Async Insights Report
>
> **Slug:** `METAADS_START_ASYNC_INSIGHTS_REPORT`
>
> Start an asynchronous Meta Ads Insights report for an ad account, campaign, ad set, or ad and return its report-run ID.
>
> #### Input Parameters
>
> **sort** `string`
>
> Insight fields and directions used to sort report rows.
>
> **level** `string ("account" | "campaign" | "adset" | "ad")`
>
> Aggregation level: account, campaign, adset, or ad. Omit it to use the queried object's own level.
>
> **limit** `integer`
>
> Maximum insight rows Meta should process for the report.
>
> **fields** `string` *required*
>
> Insight metrics and dimensions to include. Provide individual Graph API field names; they are sent as one comma-separated projection.
>
> **summary** `string`
>
> Insight fields to aggregate in the report summary.
>
> **filtering** `array`
>
> Provider-native Insights filters applied to the report.
>
> **object\_id** `string` *required*
>
> Ad account ID with the act\_ prefix, or numeric campaign, ad-set, or ad ID.
>
> **breakdowns** `string`
>
> Insight breakdown dimensions, such as publisher\_platform or country.
>
> **time\_range** `object`
>
> One inclusive since/until date range, mutually exclusive with other date selectors.
>
> **date\_preset** `string ("today" | "yesterday" | "this_month" | "last_month" | "this_quarter" | "maximum" | "data_maximum" | "last_3d" | "last_7d" | "last_14d" | "last_28d" | "last_30d" | "last_90d" | "last_week_mon_sun" | "last_week_sun_sat" | "last_quarter" | "last_year" | "this_week_mon_today" | "this_week_sun_today" | "this_year")`
>
> Preset date window. Do not combine it with time\_range or time\_ranges.
>
> **export\_name** `string`
>
> Name assigned to the exported report.
>
> **graph\_cache** `boolean`
>
> Whether Meta may use its Graph cache for this report request.
>
> **time\_ranges** `array`
>
> One or more since/until date ranges, mutually exclusive with other date selectors.
>
> **export\_format** `string`
>
> Provider-supported export format for the asynchronous report.
>
> **export\_columns** `string`
>
> Columns to include when Meta prepares an exported report.
>
> **time\_increment** `string`
>
> Reporting bucket: an integer from 1 to 90 days, monthly, or all\_days.
>
> **default\_summary** `boolean`
>
> Whether Meta should include its default summary fields.
>
> **product\_id\_limit** `integer`
>
> Maximum product IDs included in product-level insight results.
>
> **action\_breakdowns** `string`
>
> Action dimensions to break down, such as action\_type or action\_device.
>
> **action\_report\_time** `string ("conversion" | "impression" | "lifetime" | "mixed")`
>
> Time basis for reporting actions: conversion, impression, lifetime, or mixed.
>
> **summary\_action\_breakdowns** `string`
>
> Action dimensions to apply to summary metrics.
>
> **action\_attribution\_windows** `string`
>
> Attribution windows for action metrics, such as 1d\_view or 7d\_click.
>
> **use\_account\_attribution\_setting** `boolean`
>
> Use the ad account attribution setting for the report.
>
> **use\_unified\_attribution\_setting** `boolean`
>
> Use each reporting object's unified attribution setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Ad Creative
>
> **Slug:** `METAADS_UPDATE_AD_CREATIVE`
>
> Update the name or status of an ad creative by ID. The tool reports success on an HTTP 200 response.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the ad creative. Use descriptive names to organize your creatives.
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")`
>
> New status for the ad creative. ACTIVE enables the creative, PAUSED disables it temporarily, DELETED removes it, ARCHIVED stores it for reference.
>
> **creative\_id** `string` *required*
>
> The ID of the ad creative to update. You can get this from the create\_ad\_creative or get\_ad\_creative actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Ad Set Targeting
>
> **Slug:** `METAADS_UPDATE_AD_SET_TARGETING`
>
> Replace the targeting specification of an existing Meta Ad Set.
>
> #### Input Parameters
>
> **ad\_set\_id** `string` *required*
>
> Numeric ID of the existing Meta Ad Set to update.
>
> **targeting** `object` *required*
>
> Nonempty provider-native targeting specification that replaces the Ad Set's current targeting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Ad Study
>
> **Slug:** `METAADS_UPDATE_AD_STUDY`
>
> Update mutable Meta ad-study settings, including replacing its study cells.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated study name.
>
> **type** `string ("BACKEND_AB_TESTING" | "CONTINUOUS_LIFT_CONFIG" | "CREATIVE_SPEND_ENFORCEMENT" | "GEO_LIFT" | "LIFT" | "PORTFOLIO_OPTIMIZER" | "SPLIT_TEST" | "VERSION_CONTROL")`
>
> Updated Meta ad-study type.
>
> **cells** `array`
>
> Replacement study cells and the ad entities assigned to each cell.
>
> **viewers** `array`
>
> Numeric Meta user IDs allowed to view the study.
>
> **end\_time** `integer`
>
> Unix timestamp when the study ends.
>
> **study\_id** `string` *required*
>
> Numeric Meta ad-study ID.
>
> **objectives** `array`
>
> Updated objective definitions for the study.
>
> **start\_time** `integer`
>
> Unix timestamp when the study starts.
>
> **description** `string`
>
> Updated study description.
>
> **client\_business** `string`
>
> Client business ID associated with the study.
>
> **confidence\_level** `number`
>
> Confidence level to use when evaluating the study.
>
> **cooldown\_start\_time** `integer`
>
> Unix timestamp when the study cooldown starts.
>
> **creative\_test\_config** `object`
>
> Creative-test configuration for the study.
>
> **observation\_end\_time** `integer`
>
> Unix timestamp when post-study observation ends.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign
>
> **Slug:** `METAADS_UPDATE_CAMPAIGN`
>
> Update an existing advertising campaign using the Meta Marketing API. Allows modification of campaign properties like name, status, budget, and bidding strategy. Only the fields that need to be updated should be included in the request.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the campaign
>
> **status** `string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")`
>
> Updated status of the campaign
>
> **spend\_cap** `number`
>
> Updated spend cap for the campaign in account currency (minimum value \$100 USD). May be supplied with a compatible daily\_budget or lifetime\_budget.
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to update
>
> **bid\_strategy** `string ("LOWEST_COST_WITHOUT_CAP" | "LOWEST_COST_WITH_BID_CAP" | "COST_CAP" | "LOWEST_COST_WITH_MIN_ROAS")`
>
> Updated bidding strategy for the campaign
>
> **daily\_budget** `number`
>
> Updated average daily budget in account currency. Meta may spend up to 75% over this amount on an individual day, while weekly spend remains capped at seven times the daily budget. Mutually exclusive with lifetime\_budget; spend\_cap may accompany a compatible daily budget.
>
> **lifetime\_budget** `number`
>
> Updated lifetime budget limit in account currency. Mutually exclusive with daily\_budget; spend\_cap may accompany a compatible lifetime budget.
>
> **special\_ad\_categories** `array`
>
> Updated list of special ad categories that apply to this campaign
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Ad Image
>
> **Slug:** `METAADS_UPLOAD_AD_IMAGE`
>
> Upload an image for use in Meta ad creatives using the Marketing API. The image can later be referenced by its hash when creating ad creatives.
>
> #### Input Parameters
>
> **image** `object` *required*
>
> Image to upload. Provide it through this action's file input; the file's name, media type, and bytes are sent to Meta.
>
> **ad\_account\_id** `string` *required*
>
> ID of the ad account to upload the image to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
