Skip to main content
Meta Ads logo
  • Category: ads & conversion
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 95
  • Triggers: 0
  • Slug: METAADS
  • Version: 20261103_00

Tools

Slug: METAADS_COPY_AD_OBJECTCopy a Meta Campaign, Ad Set, or Ad while explicitly selecting its resource type and supported copy options.

Input Parameters

string
ISO 8601 end time for the copy. Supported for Campaign and Ad Set copies.
boolean
Whether to copy nested children. Supported for Campaign and Ad Set copies.
string
required
ID of the source Campaign, Ad Set, or Ad.
string
ISO 8601 start time for the copy. Supported for Campaign and Ad Set copies.
string ("campaign" | "ad_set" | "ad")
required
Source resource type, which selects Meta’s typed copy contract.
string ("ACTIVE" | "PAUSED" | "INHERITED_FROM_SOURCE")
Status to assign to copied objects.
object
Meta rename strategy and options for the copied objects.
boolean
Whether to create a dynamic-creative Ad Set; supported only for Ad Set copies.
object
Ad creative parameter overrides; supported only for Ad copies.
object
Campaign parameter overrides; supported only for Campaign copies.
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.
boolean
Whether to migrate the copy to Advantage+; supported only for Campaign copies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_ADCreate a new ad within an ad set using the Meta Marketing API, with image, video, or carousel creative content.

Input Parameters

string
required
Name of the ad
string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")
Initial status of the ad
object
required
Creative specifications for the ad
string
required
ID of the ad set to create the ad in. The referenced ad set and its parent campaign must already exist.
integer
Bid amount in cents (overrides ad set bid)
string
required
ID of the ad account (e.g. ‘act_123456789’). Must start with ‘act_’.
array
Tracking specifications for the ad

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_AD_CREATIVECreate 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_AD_SETCreate a new ad set within a campaign using the Meta Marketing API. Supports detailed targeting options, budgets, and optimization goals.

Input Parameters

string
required
Name of the ad set
string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")
Initial status of the ad set
string
End time in ISO 8601 format
object
required
Targeting specifications for the ad set
string
required
ID of the ad account to create the ad set in
integer
Bid amount in cents. Required for LOWEST_COST_WITH_BID_CAP and COST_CAP. Do not use with LOWEST_COST_WITH_MIN_ROAS.
string
Start time in ISO 8601 format
string
required
ID of the campaign to create the ad set in
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.
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.
string ("IMPRESSIONS" | "LINK_CLICKS" | "APP_INSTALLS" | "POST_ENGAGEMENT" | "THRUPLAY")
required
The billing event for the ad set
object
Bid constraint values for bid strategies that require them.
number
Lifetime budget limit for this ad set in account currency. Use for ad set-level budgets.
object
Object promoted by the ad set.
string ("APP_INSTALLS" | "CONVERSATIONS" | "LINK_CLICKS" | "OFFSITE_CONVERSIONS" | "PAGE_LIKES" | "POST_ENGAGEMENT" | "REACH" | "THRUPLAY" | "VALUE")
required
The optimization goal for the ad set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_AD_STUDYCreate a Meta A/B test or other ad study under a business, including its cells and tested ad entities.

Input Parameters

string
required
Name of the ad study.
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.
array
required
Study cells and the campaigns, ad sets, ads, or ad accounts each tests.
array
Positive numeric Meta user IDs allowed to view the study.
integer
required
Study end time as a Unix timestamp in seconds.
array
Meta study objective objects.
integer
required
Study start time as a Unix timestamp in seconds.
string
required
Numeric ID of the Meta business that will own the ad study.
string
Optional description of the ad study.
string
Numeric ID of the client business.
number
Statistical confidence level for the study.
integer
Cooldown start time as a Unix timestamp in seconds.
object
Meta creative-test configuration object.
integer
Observation end time as a Unix timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_AD_VIDEOUpload an ad video asset; Meta may keep processing it after returning its ID.

Input Parameters

string
Optional internal name for the ad video.
string
Optional title for the ad video.
object
One local video file to upload directly, up to 100 MiB. Provide exactly one of video or file_url.
string
Public HTTP(S) URL that Meta can fetch for the video. Provide exactly one of file_url or video.
string
Optional description for the ad video.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_CAMPAIGNCreate a new advertising campaign using the Meta Marketing API. Supports various campaign objectives, budgets, and bidding strategies.

Input Parameters

string
required
Name of the campaign
string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")
Initial status of the campaign
string ("OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_ENGAGEMENT" | "OUTCOME_AWARENESS" | "OUTCOME_TRAFFIC" | "OUTCOME_APP_PROMOTION")
required
The objective of the campaign
string
required
The ID of the ad account to create the campaign in
string ("LOWEST_COST_WITHOUT_CAP" | "LOWEST_COST_WITH_BID_CAP" | "COST_CAP")
Bidding strategy for the campaign
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.
number
Lifetime budget limit in account currency. Mutually exclusive with daily_budget - provide one or the other, not both.
array
List of special ad categories that apply to this campaign
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_CUSTOM_AUDIENCECreate 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

string
required
Name of the custom audience
object
Rule for website/app custom audiences
boolean
Whether to prefill the audience with available data
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.
string
required
The ID of the ad account to create the custom audience in
string
Description of the custom audience
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.
integer
Number of days to keep the audience data
string ("USER_PROVIDED_ONLY" | "PARTNER_PROVIDED_ONLY" | "BOTH_USER_AND_PARTNER_PROVIDED")
Source of the customer file data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_CUSTOM_CONVERSIONCreate 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

string
required
Name of the custom conversion.
object
Matching rule as a JSON object.
string
Optional description of the custom conversion.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
object
Advanced multi-source matching rule as a JSON object.
string
Numeric ID of the Pixel, offline event set, or other event source.
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.
string ("app" | "business_messaging" | "chat" | "email" | "other" | "phone_call" | "physical_store" | "system_generated" | "website")
Source from which conversion actions originate.
number
Default monetary value assigned to matching conversions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_CREATE_LEAD_FORMCreate 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

string
required
Internal name for the lead form.
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.
string
required
Numeric Facebook Page ID that will own the lead form. Ad account IDs and act_ prefixes are not accepted.
array
required
Questions shown in the form, in display order.
object
Introductory context card shown before the questions.
object
Privacy-policy link displayed by the form.
object
Page shown after the form is submitted.
object
Additional disclaimer and consent checkboxes.
object
String key-value metadata returned with leads for attribution.
string
URL used for the form’s follow-up action.
boolean
Whether to add a review step that favors higher-intent leads.
boolean
Whether email questions should require a work email address.
boolean
Whether people outside the ad’s target audience are blocked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_DELETE_AD_OBJECTDelete 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

string
required
ID of the Ad Set, Ad, or Ad Creative to delete.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_DELETE_CAMPAIGNDelete 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

string
required
ID of the campaign to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_ESTIMATE_AD_DELIVERYEstimate monthly audience delivery for targeting and optimization settings in a Meta ad account.

Input Parameters

string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
object
required
Provider-native Meta targeting specification. Pass an object; the action compact JSON-encodes it for Meta.
object
Optional provider-native promoted object required by some optimization goals. Pass an object; the action compact JSON-encodes it for Meta.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_ESTIMATE_TARGETING_REACHEstimate 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

string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
object
required
Structured Meta targeting specification used to estimate audience reach. It is serialized to compact JSON in the query.
string
App-store URL for reach estimates for a mobile app campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GENERATE_AD_PREVIEWSRender previews for a provider-native creative specification in a Meta ad account and return the generated HTML bodies.

Input Parameters

object
Provider-native Page post specification used when creative contains only a Page ID as object_id; unsupported with RIGHT_COLUMN_STANDARD.
integer
Optional preview viewport width in pixels.
integer
Optional preview viewport height in pixels.
string
Optional locale used to render localized preview content.
object
required
Provider-native Meta AdCreative specification. Pass the creative object without stringifying it; the action compact JSON-encodes it for Meta.
string
End date-time used by trip-related fields in the creative.
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.
string
Start date-time used by trip-related fields in the creative.
string
Optional Meta SDK render mode; currently only FALLBACK is supported.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
string
Place Page ID used to render a dynamic local ad preview.
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.
array
Product Item IDs used to render a dynamic ad preview.
string
Asset label selecting a specific dynamic asset customization variation.
object
Provider-native dynamic creative specification for a dynamic ad.
object
Provider-native multilingual customization for a dynamic ad.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_AD_ACCOUNTSRetrieve one page of directly assigned ad accounts for the authenticated user, including account IDs, names, and other requested account details.

Input Parameters

integer
Maximum number of ad accounts to return (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_AD_CREATIVEGet Ad Creative

Input Parameters

string
List of fields to include in the response.
string
required
The ID of the ad creative to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_AD_PREVIEWRender a placement-specific preview for an existing Meta Ad or Ad Creative.

Input Parameters

object
JSON object describing the post to render.
integer
Preview width in pixels, when a custom size is needed.
integer
Preview height in pixels, when a custom size is needed.
string
Locale in which to render the preview, such as en_US.
string
Preview end date as a Meta-compatible datetime string.
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.
string
required
Numeric ID of the existing Meta Ad or Ad Creative to preview.
string
Preview start date as a Meta-compatible datetime string.
string
Meta preview rendering mode.
integer
Numeric ID of the Place Page to use in the preview.
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.
array
Product item IDs to include in the preview.
string
Dynamic asset label to select for the preview.
object
JSON object describing the dynamic creative configuration.
object
JSON object describing dynamic preview customization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_AD_STUDYGet one Meta ad study by ID, including projected cells and timing.

Input Parameters

string
Ad-study fields to return. Provide individual Graph field names; a one-level nested projection such as cells{id,name} is supported.
string
required
Numeric Meta ad-study ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_CURRENT_APPReturn selected metadata for the Meta application associated with the connected access token.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_INSIGHTSGet 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

array
Fields to sort by with direction (_ascending or _descending suffix)
string
Cursor for the next page of results, usually taken from paging.cursors.after in the previous response.
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’.
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.
string
Cursor for the previous page of results, usually taken from paging.cursors.before in the previous response.
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.
array
Filters to apply to the data
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.
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.
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.
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.
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.
boolean
Internal field to track if date_preset was defaulted. Do not set this manually.
array
Internal field to track any field transformations made. Do not set this manually.
array
Internal field to track breakdown fields moved out of fields. Do not set this manually.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_MULTIPLE_OBJECTSRetrieve 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

string
required
Graph API fields to request for every object.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_OBJECTRetrieve 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

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.
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.
object
Custom date range for aggregating insights metrics.
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.
integer
Unix timestamp to retrieve only objects updated since this time. Useful for incremental syncs and fetching recent changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_PAGE_ACCOUNTSRetrieve 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

string
Opaque cursor from paging.cursors.after in a previous response. Pass it unchanged to retrieve the next page.
integer
Maximum number of managed pages to return in this page of results.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_PIXEL_EVENT_STATSRead recent Pixel event-count and processing statistics, optionally restricted to server events and one event name, to verify aggregate ingestion.

Input Parameters

string
Partner-agent identifier used when the events were submitted.
string
Opaque next_cursor from a previous stats page; omit for the first page.
integer
Exclusive Unix timestamp in seconds; must be after start_time.
string
required
Numeric Pixel ID whose recent event statistics should be read.
string
Standard or custom event name to filter, such as Purchase.
integer
Inclusive Unix timestamp in seconds. Meta exposes up to seven recent days.
string ("event" | "pixel_fire" | "event_total_counts" | "match_keys" | "event_processing_results")
Grouping used for the returned statistics.
string ("WEB_ONLY" | "SERVER_ONLY")
Restrict statistics to browser/web or server-side event delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_USERTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_GET_VIDEODEPRECATED: 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

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.
string
required
The ID of the video to retrieve from Meta’s Graph API

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_ACTIVITIESList activity history for a Meta ad account or ad set.

Input Parameters

string
Opaque after cursor from the previous response’s paging.cursors.after value. Omit for the first page.
integer
Maximum number of activities to return in this page.
string
Optional lower datetime bound accepted by Meta for activity event times. Pass the provider datetime string without modification.
string
Optional upper datetime bound accepted by Meta for activity event times. Pass the provider datetime string without modification.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_ACCOUNT_PIXELSList 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

integer
Maximum Pixels to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string ("LAST_FIRED_TIME" | "NAME")
Sort Pixels by name or by their most recent fired event time.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_ACCOUNT_RECOMMENDATIONSReturn one page of Meta recommendations for an advertising account.

Input Parameters

integer
Maximum recommendation records to return in this page.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Recommendation fields to return. Provide individual Graph API field names, not a comma-separated string.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
array
Meta recommendation names to include, such as ACCOUNT_ERROR, AUTOMATIC_PLACEMENTS, or CREATIVE_FATIGUE.
array
Recommendation stages to include: MFR, PCR, or PFR.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_CREATIVESList one page of ad creatives under a Meta Ads account to view or analyze creative assets.

Input Parameters

integer
Maximum number of ad creatives to return per page (default 25).
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).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_IMAGESList one page of image assets in a Meta ad account, optionally restricted to exact image hashes.

Input Parameters

integer
Maximum ad images to return in this page.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Image fields to return. Provide individual Graph API field names, not a comma-separated string.
array
Optional image hashes to match exactly in this ad account.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_NETWORK_ANALYTICSTool 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

string
required
The Business ID to query ad network analytics for
integer
Maximum number of results to return per request (default 25, API default 2000)
string
required
Comma-separated list of metrics to retrieve. Example: fb_ad_network_revenue

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_NETWORK_ANALYTICS_RESULTSTool 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

string
Comma-separated list of fields to retrieve in the response. If not specified, returns default fields.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_RULE_HISTORYReturn 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

integer
Maximum history entries to return in this page (1-100).
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.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
History fields to return. Provide individual Graph API field names, not a comma-separated string.
string
Optional ID of an affected ad object whose rule history should be returned.
string
required
Numeric ID of the Meta Automated Rule whose history should be listed.
boolean
Whether to omit history entries where the rule made no change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_ADSList a page of ads under a Meta ad account, with optional selection of returned fields.

Input Parameters

integer
Maximum number of ads to return per page (default 25, max 100)
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.
string
required
The ad account ID (with or without ‘act_’ prefix, e.g., ‘act_123456789’ or ‘123456789’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_STUDIESList one page of A/B tests and other ad studies owned by a Meta business, including projected cells.

Input Parameters

integer
Maximum ad studies to return in this page.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Ad-study fields to return. Provide individual Graph field names; a one-level nested projection such as cells{id,name} is supported.
string
required
Numeric ID of the Meta business that owns the ad studies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AD_VIDEOSList one page of video assets in a Meta ad account, optionally filtered by title, dimensions, duration, or aspect ratio.

Input Parameters

integer
Maximum ad videos to return in this page.
string
Optional video title to use in Meta’s video-name filter.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Video fields to return. Provide individual Graph API field names; they are sent to Meta as a comma-separated fields projection.
integer
Optional maximum video width in pixels.
integer
Optional minimum video width in pixels.
integer
Optional maximum video height in pixels.
integer
Optional maximum video duration for the filter.
integer
Optional minimum video height in pixels.
integer
Optional minimum video duration for the filter.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
number
Optional maximum video width-to-height ratio.
number
Optional minimum video width-to-height ratio.
boolean
Set true to ask Meta for the total matching video count. Meta returns it as summary.total_count when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_AGENCIESTool 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

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).
integer
Maximum number of agencies to return (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_ASSIGNED_PAGESTool 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

string
required
The ID of the business user. Can be obtained from GET /{business_id}/business_users endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_ASSIGNED_USERSTool 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

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’).
string
Cursor for forward pagination.
integer
Maximum number of results to return per page.
string
Cursor for backward pagination.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_BUSINESS_AD_ACCOUNTSRetrieve a page of ad accounts owned by a specific Business Manager, including account IDs, names, and status.

Input Parameters

integer
Maximum number of ad accounts to return (default 25)
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.
string
required
The ID of the business to retrieve owned ad accounts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_BUSINESSESList 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

string
Pagination cursor. Pass the paging.cursors.after value from a previous response to fetch the next page.
integer
Maximum number of businesses to return per page (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_BUSINESS_INVOICESTool 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

string
required
ID of the business to retrieve invoices for
string ("CM" | "DM" | "INV" | "PRO_FORMA")
Type of invoice from OmegaCustomerTrx.Type enum.
string
Cursor for forward pagination.
integer
Maximum number of results to return per page.
string
Cursor for backward pagination.
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.
string
End date for filtering invoices (YYYY-MM-DD format)
string
Specific invoice ID to retrieve
string
Start date for filtering invoices (YYYY-MM-DD format)
string
Issue end date for filtering invoices (YYYY-MM-DD format)
string
Issue start date for filtering invoices (YYYY-MM-DD format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_BUSINESS_USERSList active human users associated with a Meta Business Manager.

Input Parameters

string
Opaque cursor from a previous response’s paging.cursors.after value. Pass it unchanged to retrieve the next page.
integer
Maximum number of business users to return in this page.
string
Comma-separated BusinessUser fields to return. Common fields are id, name, and role.
string
required
Business Manager ID whose active human users should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CAMPAIGNSList one page of campaigns belonging to a Meta ad account.

Input Parameters

string
Opaque cursor from paging.cursors.after in a previous response. Pass it unchanged to retrieve the next page.
integer
Maximum number of campaigns to return on this page.
string
Campaign fields to return. The action sends these to Meta as a comma-separated fields parameter.
string
required
Ad account ID, with or without the ‘act_’ prefix.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CATALOG_PRODUCTSReturn one filtered page of products from a Meta product catalog.

Input Parameters

integer
Maximum products to return in this page (1-500).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Product fields to return. Provide individual Graph API field names, not a comma-separated string.
object
Meta Product Catalog filter object, encoded as JSON on the wire.
boolean
Whether Meta should include collection summary metadata.
string
required
Numeric Meta product catalog ID.
string
Provider-defined catalog error code used to filter products.
string ("HIGH" | "LOW" | "MEDIUM")
Return products associated with catalog errors of this priority.
boolean
Whether Meta should use bulk pagination for the product collection.
boolean
Whether to return only products approved by Meta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CATALOG_PRODUCT_SETSReturn one filtered page of product sets from a Meta product catalog.

Input Parameters

integer
Maximum product sets to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Product-set fields to return. Provide individual Graph API field names, not a comma-separated string.
string
Return direct children of this numeric product-set ID.
string
required
Numeric ID of the Meta product catalog whose product sets to list.
string
Return descendants of this numeric product-set ID.
string
Filter product sets by their retailer identifier.
boolean
Filter by whether product sets have child sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENT_AD_ACCOUNTSList one page of client ad accounts shared with a Meta Business Manager.

Input Parameters

integer
Maximum number of ad accounts to return (default 25)
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.
string
required
The business ID to fetch client ad accounts from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENT_APPSTool 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

string
Cursor for forward pagination.
integer
Maximum number of results to return per page.
string
Cursor for backward pagination.
string
required
The ID of the Business object. Can be obtained from GET /me/businesses endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENT_INSTAGRAM_ASSETSTool 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

string
Cursor for pagination. Use the ‘after’ cursor from the previous response to fetch the next page of results.
integer
Maximum number of Instagram assets to return per page (default 25)
string
Comma-separated list of fields to retrieve for each Instagram asset. If not specified, default fields will be returned.
string
required
The business ID whose client Instagram assets to retrieve. Can be obtained from /me/businesses endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENT_OFFSITE_SIGNAL_CONTAINERSRetrieve one page of client offsite signal container business objects for a business using the Meta Marketing API.

Input Parameters

string
required
Business ID - The ID of the business to query for client offsite signal container business objects
integer
Maximum number of client offsite signal container business objects to return (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENT_PAGESTool 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

string
required
The ID of the business to retrieve client pages for. Can be obtained via GET /me/businesses endpoint.
integer
Maximum number of client pages to return per request. Use this parameter to control pagination.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CLIENTSTool 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

string
required
Business Manager ID to fetch client businesses from. Can be obtained from GET /me/businesses endpoint.
integer
Maximum number of client businesses to return (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_COLLABORATIVE_ADS_COLLABORATION_REQUESTSTool 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

string
required
The Business ID to retrieve collaborative ads collaboration requests for. This is typically obtained from the /me/businesses endpoint.
integer
Maximum number of collaboration requests to return per page (default 25)
string
Comma-separated list of fields to retrieve for each collaboration request. If not specified, default fields will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_COLLABORATIVE_ADS_SUGGESTED_PARTNERSTool 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

integer
Maximum number of suggested partners to return (default 25)
string
Comma-separated list of fields to retrieve for each suggested partner. If not specified, default fields will be returned.
string
required
Business ID to retrieve collaborative ads suggested partners for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_COMMENTSReturn 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

integer
Maximum comments to return in this page (1-100).
string ("chronological" | "reverse_chronological")
Order in which Meta returns comments.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Comment fields to return. Field availability depends on the parent type and the connected token’s permissions.
string ("toplevel" | "stream")
Comment level filter. toplevel returns top-level comments; stream returns all levels in chronological order.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CUSTOM_AUDIENCESList one page of custom audiences in a Meta ad account, with field projection and optional business, primary-audience, or Pixel constraints.

Input Parameters

integer
Maximum custom audiences to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Custom-audience fields to return. Provide individual Graph API field names, not a comma-separated string.
string
Return custom audiences associated with this Pixel ID.
string
Return audiences associated with this Meta business ID.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
boolean
Whether Meta should include each audience’s primary audience data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_CUSTOM_CONVERSIONSList one page of custom-conversion definitions in a Meta ad account, with field projection and opaque cursor pagination.

Input Parameters

integer
Maximum custom conversions to return in this page. Use the returned cursor when Meta has more results.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Custom-conversion fields to return. Provide individual Graph API field names, not a comma-separated string.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_INITIATED_AUDIENCE_SHARING_REQUESTSTool 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

string
required
Business ID to retrieve initiated audience sharing requests for. Can be obtained from the /me/businesses endpoint.
string
Cursor for pagination - use the ‘after’ cursor from the previous response to fetch the next page
integer
Maximum number of sharing requests to return per page (default 25)
string
Comma-separated list of fields to retrieve for each sharing request. If not specified, default fields will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_LEADSList one page of leads belonging to a Meta Ad or Leadgen Form.

Input Parameters

string
Opaque paging cursor from paging.cursors.after in a previous response. Pass it back unchanged to retrieve the next page.
integer
Maximum number of leads to return in this page.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_MANAGED_PARTNER_ADS_FUNDING_SOURCE_DETAILSTool 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

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.
integer
Maximum number of results to return per request (default 25)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_APPSTool 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

integer
Maximum number of owned apps to return (default 25)
string
Comma-separated list of fields to retrieve. Available fields: id, name, link, category
string
required
The ID of the business to retrieve owned apps for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_BUSINESSESTool 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

integer
Maximum number of owned businesses to return (default 25)
string
Comma-separated list of fields to retrieve for each owned business. Common fields: id, name, created_time, link, timezone_id, vertical, verification_status
string
required
The ID of the parent Business Manager to retrieve owned businesses from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_INSTAGRAM_ASSETSTool 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

integer
Maximum number of Instagram assets to return (default 25)
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.
string
required
Business ID - can be obtained from /me/businesses endpoint. This is the Meta Business ID that owns the Instagram assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_OFFSITE_SIGNAL_CONTAINER_BUSINESS_OBJECTSRetrieve one page of owned offsite signal container business objects associated with a specific business ID from the Meta Marketing API.

Input Parameters

string
required
Business ID - The ID of the business to query for owned offsite signal container business objects
integer
Maximum number of owned offsite signal container business objects to return (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_PAGESRetrieve a page of Facebook Pages owned by a Business Manager from the Meta Marketing API.

Input Parameters

integer
Maximum number of pages to return per request (default 25)
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.
string
required
The ID of the Business Manager to list owned pages for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_OWNED_PRODUCT_CATALOGSReturn one page of product catalogs owned by a Meta Business Manager.

Input Parameters

integer
Maximum product catalogs to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Product catalog fields to return. Provide individual Graph API field names, not a comma-separated string.
string
required
Numeric ID of the Meta Business Manager that owns the catalogs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_CLIENT_AD_ACCOUNTSTool 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

integer
Maximum number of pending client ad accounts to return (default 25)
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).
string
required
The ID of the Business Manager to retrieve pending client ad account access requests from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_CLIENT_APPSTool 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

integer
Maximum number of pending client apps to return (default 25)
string
Comma-separated list of fields to retrieve for each pending client app. If not specified, default fields will be returned.
string
required
The Business ID to retrieve pending client apps for. Can be retrieved from /me?fields=businesses endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_CLIENT_PAGESTool 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

integer
Maximum number of pages to return per request (default 25)
string
required
The Business Manager ID to retrieve pending client pages for. This is the numeric ID of the business.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_OFFSITE_SIGNAL_CONTAINERSTool 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

string
required
Business ID to retrieve pending shared offsite signal container business objects for
integer
Maximum number of items to return (default 25)
string
Comma-separated list of fields to retrieve from the pending shared offsite signal container business objects

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_OWNED_AD_ACCOUNTSTool 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

integer
Maximum number of pending ad accounts to return per page (default 25)
string
Comma-separated list of fields to retrieve for each pending ad account. Common fields: id, account_id, name, currency, timezone_name, account_status.
string
required
The Business ID to retrieve pending owned ad accounts for. This is the ID of the Business Manager account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_OWNED_PAGESTool 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

integer
Maximum number of pages to return per request (default 25)
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PENDING_USERSTool 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

string
required
The Business Manager ID to retrieve pending users from
integer
Maximum number of pending users to return per request (default 25)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_PROMOTABLE_PAGESReturn one page of Facebook Pages available for promotion from a Meta ad account.

Input Parameters

integer
Maximum promotable Pages to return in this page.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Page fields to return. Provide individual Graph API field names, not a comma-separated string.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_RECEIVED_AUDIENCE_SHARING_REQUESTSRetrieve 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

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.
integer
Maximum number of audience sharing requests to return (default 25)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_SUBSCRIBED_APPSList one page of applications subscribed to a Meta ad account.

Input Parameters

integer
Maximum subscribed applications to return in this page.
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_SYSTEM_USERSList one page of system users associated with a Meta Business Manager account, with pagination information when returned.

Input Parameters

integer
Maximum number of system users to return per page (default 25)
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.
string
required
The ID of the business to retrieve system users for. This is the Business Manager ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_TARGETING_SEARCHTool 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

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.
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).
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.
integer
Maximum number of results to return. If not specified, the API will use its default limit.
array
For geolocation searches (type=‘adgeolocation’), specify location types to filter results. Common values: ‘city’, ‘country’, ‘region’, ‘zip’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_TARGETING_SUGGESTIONSReturn Meta targeting options related to a provider-native seed targeting list for an ad account.

Input Parameters

string ("best_performing" | "recently_used" | "related" | "suggestions")
Meta SDK suggestion mode controlling how seed entries are expanded.
integer
Maximum number of related targeting suggestions to return.
object
Provider-native Meta object context. Pass a parsed object; the action compact JSON-encodes it for the GET query.
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.
array
Country codes used by Meta to contextualize targeting suggestions.
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.
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.
integer
Unsigned Meta SDK session identifier for suggestion requests.
string
required
Numeric ad account ID, with or without the act_ prefix. The prefix is normalized before the request is sent.
array
required
Provider-native seed targeting entries. Pass parsed objects such as interest IDs; the action compact JSON-encodes the list for Meta.
array
Meta SDK targeting field names allowed in the suggestions, such as interests, behaviors, or geo_locations.
array
Meta regulated country codes applied to the suggestions.
array
Meta regulated ad categories applied to the suggestions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_USER_PERMISSIONSInspect permission names and grant statuses for the connected Meta user, optionally filtered by permission or status.

Input Parameters

string ("granted" | "declined" | "expired")
Grant status to filter by.
string
Permission name to filter by, such as ads_read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_VIDEO_TAGSReturn 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

integer
Maximum video tags to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Video-tag fields to return. The edge returns a TaggableSubject (id, name) and can return created_time.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_LIST_VIDEO_THUMBNAILSList one page of available thumbnail variants for a Meta video. Use next_cursor to retrieve another page when has_more is true.

Input Parameters

integer
Maximum video thumbnails to return in this page (1-100).
string
Opaque next_cursor from a previous call. Omit it for the first page and pass it back unchanged.
string
Thumbnail fields to return. Provide individual Graph API field names, not a comma-separated string.
string
required
Numeric ID of the Meta video whose thumbnail variants should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_PREVIEW_AD_CREATIVERetrieve a preview thumbnail URL for an ad creative, with optional thumbnail dimensions.

Input Parameters

string
required
ID of the ad creative to preview. Get this from: - CreateAdCreative response - Existing ad creative lookup Format: 23842938523454
integer
Width of the preview thumbnail in pixels. - Default: 150px - Min: 50px - Max: 1200px Larger sizes give better quality but load slower.
integer
Height of the preview thumbnail in pixels. - Default: 120px - Min: 50px - Max: 1200px Choose based on your display needs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_READ_ADSETSRetrieve 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

integer
Maximum number of adsets to return
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.
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’).
boolean
Filter adsets by completed status
string
required
ID of the ad account to fetch adsets from
integer
Time since the Adset has been updated (in seconds)
array
Filter adsets by their effective status. Values are case-insensitive (e.g., ‘active’ or ‘ACTIVE’).
string
Start date in YYYY-MM-DD format for custom date range
string
End date in YYYY-MM-DD format for custom date range

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_RENAME_AD_OBJECTRename an existing Meta campaign, ad set, ad, or ad creative.

Input Parameters

string
required
Non-empty new display name. Surrounding whitespace is removed.
string
required
Numeric ID of the existing campaign, ad set, ad, or ad creative.
string ("campaign" | "ad_set" | "ad" | "ad_creative")
required
Advertising object type for the node being renamed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_SEND_CONVERSION_EVENTSIrreversibly 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

array
required
Batch of 1-1,000 server events. Local validation rejects the complete call when any event is invalid.
string
ASCII-digit identifier shared by events in one offline upload. Preserved as a string.
string
Caller-defined offline upload tag.
string
ASCII-digit namespace ID for applicable offline uploads. Preserved as a string.
string
Stable lowercase integration or partner identifier sent with the events.
string
Source label for an offline upload.
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.
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.
string
required
Numeric Pixel ID for website events or dataset ID for offline/multi-source events. Never pass an ad account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_SET_AD_OBJECT_STATUSSet an Ad, Ad Set, or Campaign to ACTIVE or PAUSED, or destructively ARCHIVE or DELETE it. Campaign status changes affect child delivery.

Input Parameters

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.
string
required
Numeric ID of the existing Meta Ad, Ad Set, or Campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_START_ASYNC_INSIGHTS_REPORTStart an asynchronous Meta Ads Insights report for an ad account, campaign, ad set, or ad and return its report-run ID.

Input Parameters

string
Insight fields and directions used to sort report rows.
string ("account" | "campaign" | "adset" | "ad")
Aggregation level: account, campaign, adset, or ad. Omit it to use the queried object’s own level.
integer
Maximum insight rows Meta should process for the report.
string
required
Insight metrics and dimensions to include. Provide individual Graph API field names; they are sent as one comma-separated projection.
string
Insight fields to aggregate in the report summary.
array
Provider-native Insights filters applied to the report.
string
required
Ad account ID with the act_ prefix, or numeric campaign, ad-set, or ad ID.
string
Insight breakdown dimensions, such as publisher_platform or country.
object
One inclusive since/until date range, mutually exclusive with other date selectors.
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.
string
Name assigned to the exported report.
boolean
Whether Meta may use its Graph cache for this report request.
array
One or more since/until date ranges, mutually exclusive with other date selectors.
string
Provider-supported export format for the asynchronous report.
string
Columns to include when Meta prepares an exported report.
string
Reporting bucket: an integer from 1 to 90 days, monthly, or all_days.
boolean
Whether Meta should include its default summary fields.
integer
Maximum product IDs included in product-level insight results.
string
Action dimensions to break down, such as action_type or action_device.
string ("conversion" | "impression" | "lifetime" | "mixed")
Time basis for reporting actions: conversion, impression, lifetime, or mixed.
string
Action dimensions to apply to summary metrics.
string
Attribution windows for action metrics, such as 1d_view or 7d_click.
boolean
Use the ad account attribution setting for the report.
boolean
Use each reporting object’s unified attribution setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_UPDATE_AD_CREATIVEUpdate the name or status of an ad creative by ID. The tool reports success on an HTTP 200 response.

Input Parameters

string
New name for the ad creative. Use descriptive names to organize your creatives.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_UPDATE_AD_SET_TARGETINGReplace the targeting specification of an existing Meta Ad Set.

Input Parameters

string
required
Numeric ID of the existing Meta Ad Set to update.
object
required
Nonempty provider-native targeting specification that replaces the Ad Set’s current targeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_UPDATE_AD_STUDYUpdate mutable Meta ad-study settings, including replacing its study cells.

Input Parameters

string
Updated study name.
string ("BACKEND_AB_TESTING" | "CONTINUOUS_LIFT_CONFIG" | "CREATIVE_SPEND_ENFORCEMENT" | "GEO_LIFT" | "LIFT" | "PORTFOLIO_OPTIMIZER" | "SPLIT_TEST" | "VERSION_CONTROL")
Updated Meta ad-study type.
array
Replacement study cells and the ad entities assigned to each cell.
array
Numeric Meta user IDs allowed to view the study.
integer
Unix timestamp when the study ends.
string
required
Numeric Meta ad-study ID.
array
Updated objective definitions for the study.
integer
Unix timestamp when the study starts.
string
Updated study description.
string
Client business ID associated with the study.
number
Confidence level to use when evaluating the study.
integer
Unix timestamp when the study cooldown starts.
object
Creative-test configuration for the study.
integer
Unix timestamp when post-study observation ends.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_UPDATE_CAMPAIGNUpdate 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

string
New name for the campaign
string ("ACTIVE" | "PAUSED" | "DELETED" | "ARCHIVED")
Updated status of the campaign
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.
string
required
ID of the campaign to update
string ("LOWEST_COST_WITHOUT_CAP" | "LOWEST_COST_WITH_BID_CAP" | "COST_CAP" | "LOWEST_COST_WITH_MIN_ROAS")
Updated bidding strategy for the campaign
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.
number
Updated lifetime budget limit in account currency. Mutually exclusive with daily_budget; spend_cap may accompany a compatible lifetime budget.
array
Updated list of special ad categories that apply to this campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: METAADS_UPLOAD_AD_IMAGEUpload 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

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.
string
required
ID of the ad account to upload the image to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not