# Snapchat Snapchat Marketing API and Ads Manager integration for creating and managing ad campaigns, analyzing performance metrics, and accessing business accounts. - **Category:** marketing - **Auth:** OAUTH2 - **Composio Managed App Available?** No - **Tools:** 139 - **Triggers:** 0 - **Slug:** `SNAPCHAT` - **Version:** 20260316_00 ## Tools ### Add Users to Segment **Slug:** `SNAPCHAT_ADD_SEGMENT_USERS` Tool to add users to a Snapchat audience segment. Use when you need to populate a segment with user identifiers (email, phone, or mobile ad IDs). All identifiers must be normalized and SHA-256 hashed before submission. Maximum 100,000 identifiers per request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `users` | array | Yes | Array of user data objects. Each object contains a schema type and corresponding hashed identifiers. All identifiers must be normalized and SHA-256 hashed. Maximum 100,000 identifiers per request. | | `segment_id` | string | Yes | The ID of the segment to add users to | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Media Between Ad Accounts **Slug:** `SNAPCHAT_COPY_MEDIA` Copies media from one Snapchat ad account to another. Use this when you need to duplicate media assets (images, videos) across different ad accounts for campaign management or sharing creative assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `media_copy` | array | Yes | List of media items to copy, each specifying source media ID and source ad account ID | | `destination_ad_account_id` | string | Yes | The destination ad account ID where media will be copied to | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Account Role **Slug:** `SNAPCHAT_CREATE_ACCOUNT_ROLE` Tool to create new roles for members in a Snapchat Ad Account. Use when you need to grant access permissions to members. Note: Member must already have an Organization-level 'member' role before assigning Ad Account roles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roles` | array | Yes | List of role assignments to create. Each role assignment specifies a member_id, ad_account_id, and role type. | | `ad_account_id` | string | Yes | The Ad Account ID where roles will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ad Account **Slug:** `SNAPCHAT_CREATE_AD_ACCOUNT` Tool to create a new ad account within a Snapchat organization. Use when setting up a new advertising account for campaign management. Requires organization_id, billing center, and advertiser details. Can create test accounts for development purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adaccounts` | array | Yes | List of ad accounts to create (typically one account per request) | | `organization_id` | string | Yes | Organization ID where the ad account will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Estimate Ad Account Audience Size **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_AUDIENCE_SIZE_V2` Tool to estimate audience size for Snapchat ad campaigns. Use when you need to determine potential reach for specific targeting criteria before creating ad campaigns. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name for the audience size estimation (optional). | | `type` | string | No | Ad type (e.g., 'SNAP_ADS'). Optional parameter. | | `status` | string | No | Status (e.g., 'ACTIVE'). Optional parameter. | | `auto_bid` | boolean | No | Whether auto-bidding is enabled. Optional parameter. | | `bid_micro` | integer | No | Bid amount in micro units (1 micro = 0.000001). Optional parameter. | | `placement` | string | No | Placement type (e.g., 'CONTENT'). Optional parameter. | | `targeting` | object | Yes | Targeting specifications including geographic and demographic criteria. At least one targeting criterion must be specified. | | `ad_account_id` | string | Yes | The Ad Account identifier (UUID format). | | `optimization_goal` | string | No | Optimization goal for the ad campaign (e.g., 'APP_INSTALLS', 'SWIPES', 'PIXEL_PAGE_VIEW', 'IMPRESSIONS'). Optional parameter. | | `daily_budget_micro` | integer | No | Daily budget in micro units (1 micro = 0.000001). Optional parameter. | | `delivery_constraint` | string | No | Budget constraint type (e.g., 'DAILY_BUDGET'). Optional parameter. | | `included_content_types` | array | No | Content type filters. Optional parameter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ad account creative elements **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_CREATIVE_ELEMENTS` Tool to create new creative elements in a Snapchat ad account. Use when you need to create dynamic ad elements like buttons for product catalogs or dynamic collections. Once created, creative elements cannot be updated and are immutable. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Ad account ID where the creative elements will be created | | `creative_elements` | array | Yes | Array of creative elements to create. At least one element is required | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ad Account Dynamic Templates **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_DYNAMIC_TEMPLATES` Tool to create new dynamic templates for product ads in a Snapchat ad account. Use when you need to set up templates that define how product information from a catalog will be displayed in dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adaccount_id` | string | Yes | ID of the ad account to create dynamic templates for | | `dynamic_templates` | array | Yes | List of dynamic templates to create | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ad Account Event Details **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_EVENT_DETAILS` Tool to create event details for a Snapchat ad account. Use when scheduling advertising events or campaigns. Event details are immutable after creation and cannot be edited. Ensure the event is not referenced by active Reminder Creatives before deletion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | UUID of the ad account where the event will be created. This is the path parameter. | | `event_details` | array | Yes | Array of event details to create. Each event is immutable after creation and cannot be edited. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ad Account Interaction Zones **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_INTERACTION_ZONES` Create new interaction zones for an ad account in Snapchat Marketing API. Interaction zones are used for dynamic collections ads and contain 2-4 creative elements with matching interaction types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | The ID of the ad account to create interaction zones for | | `interaction_zones` | array | Yes | Array of interaction zone configurations to create | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Offer Disclaimers **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_OFFER_DISCLAIMERS` Tool to create new offer disclaimers for a Snapchat ad account. Use when you need to add legal disclaimers to offers in ads. STATIC disclaimers display custom text directly, while DYNAMIC disclaimers pull content from product catalogs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | UUID of the ad account to create offer disclaimers for. This is the path parameter in the URL. | | `offer_disclaimers` | array | Yes | List of offer disclaimer objects to create. Each disclaimer must have a name, ad_account_id, disclaimer_text (or null for DYNAMIC), and disclaimer_render_type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ad account reserved forecasting **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_RESERVED_FORECASTING` Tool to create a reserved forecasting for Snapchat ad accounts. Use when you need to forecast reach and frequency for planned campaigns with specific targeting and frequency caps. Requires minimum reach of 500,000 unique users and booking window between 12 hours and 365 days. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ad account ID for which to create the reserved forecasting. | | `type` | string | No | Ad Squad type. Valid values are 'SNAP_ADS' or 'LENS'. If not specified, defaults based on optimization_goal. | | `end_time` | string | Yes | Campaign end time in ISO 8601 format (e.g., '2025-06-19T10:00:00.000Z'). Maximum booking window is 365 days. | | `targeting` | object | Yes | Targeting configuration including geographic and demographic specifications. Radius and LOI targeting are not permitted. | | `start_time` | string | Yes | Campaign start time in ISO 8601 format (e.g., '2025-05-20T10:00:00.000Z'). Booking window minimum is 12 hours. | | `placement_v2` | object | Yes | Placement configuration for the ads. Use config='AUTOMATIC' for automatic placement. | | `optimization_goal` | string | Yes | Optimization goal for the campaign. Use 'VIDEO_VIEWS' for Snap Ads or 'USES' for Lenses. | | `delivery_constraint` | string | Yes | Delivery constraint for the campaign. Must be 'REACH_AND_FREQUENCY' for reserved forecasting. | | `cap_and_exclusion_config` | object | Yes | Frequency cap and exclusion configuration specifying impression limits per user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Adaccounts Targeting Insights **Slug:** `SNAPCHAT_CREATE_ADACCOUNTS_TARGETING_INSIGHTS` Tool to generate targeting insights for a Snapchat ad account. Use when you need to analyze and compare audience demographics, size, and characteristics between a base targeting spec and a target targeting spec. Returns detailed breakdowns including age groups, gender, languages, geographic distribution, and audience size estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The Ad Account ID to use for the targeting insights request | | `base_spec` | object | Yes | Base targeting specification to compare against. Defines the reference audience for comparison. | | `targeting_spec` | object | Yes | Target targeting specification to analyze. Defines the target audience to get insights for. | | `dimension_category` | string ("demo" | "geo" | "device" | "interest" | "engagement" | "aggregated") | No | Dimension category filter for targeting insights output. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ad Squad **Slug:** `SNAPCHAT_CREATE_AD_SQUAD` Tool to create a new ad squad within a campaign. Use when setting up ad delivery targeting, budgets, and placements for a Snapchat campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adsquads` | array | Yes | List of ad squads to create. At least one ad squad is required. | | `campaign_id` | string | Yes | Campaign ID to create the ad squad under. Must be a valid UUID of an existing campaign. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Billing Center **Slug:** `SNAPCHAT_CREATE_BILLING_CENTER` Tool to create one or more billing centers for a Snapchat Ads organization. Use when you need to set up new billing entities for managing ad spend and invoicing. Requires organization ID, billing center name, email address, and complete billing address information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `billingcenters` | array | Yes | List of billing centers to create (one or more) | | `organization_id` | string | Yes | The organization ID to create billing center(s) under | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Campaign **Slug:** `SNAPCHAT_CREATE_CAMPAIGN` Tool to create a new advertising campaign in Snapchat Marketing API. Use when you need to set up a new campaign with specified budget, timing, and objectives. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Campaign name (max 375 characters). This is the identifier shown in the Snapchat Ads Manager. | | `status` | string ("ACTIVE" | "PAUSED") | Yes | Initial campaign status. ACTIVE means the campaign can start delivering (if other conditions are met), PAUSED means it's created but not delivering. | | `end_time` | string | No | Campaign end time in ISO 8601 format. If not specified, campaign runs indefinitely until manually stopped. | | `buy_model` | string ("AUCTION" | "RESERVED") | No | Campaign buy model values. | | `start_time` | string | Yes | Campaign start time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). The campaign will not deliver before this time. | | `pacing_level` | string | No | Pacing level for budget optimization. Set to 'CAMPAIGN' to enable Smart Budgets at campaign level. | | `ad_account_id` | string | Yes | Ad Account ID where the campaign will be created. This is a UUID format identifier. | | `creation_state` | string | No | Creation state of the campaign. Set to 'PUBLISHED' if needed. | | `measurement_spec` | object | No | Measurement specification for app-related campaigns. | | `shared_properties` | object | No | Shared properties for Smart Budgets campaigns. | | `daily_budget_micro` | integer | No | Daily spend cap in micro-currency units (1,000,000 micro = 1 currency unit). If not set, no daily cap is enforced. | | `objective_v2_properties` | object | No | Objective V2 properties for campaign. | | `lifetime_spend_cap_micro` | integer | No | Total campaign spend limit in micro-currency units. Campaign stops when this limit is reached. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Catalog Role **Slug:** `SNAPCHAT_CREATE_CATALOG_ROLE` Tool to create new roles for a catalog in Snapchat Marketing API. Use when you need to assign catalog permissions to members. Members must already have the 'member' organizational role before receiving catalog roles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roles` | array | Yes | Array of role objects to create. Each role assigns permissions to a member for the specified catalog. | | `catalog_id` | string | Yes | The Catalog ID where the role will be created (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Catalog Facets **Slug:** `SNAPCHAT_CREATE_CATALOGS_FACETS` Tool to create catalog facets for grouping products by attributes like BRAND, COLOR, or AVAILABILITY. Use when you need to analyze product distribution across different attributes in a catalog. Returns grouped counts for specified product properties with optional filtering support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Integer between 1-50 specifying the number of groupings returned per facet | | `facets` | array | Yes | Array of facet specifications defining which attributes to group products by | | `filter` | object | No | Optional filter using property names as keys with operators (EQ, NEQ, GT, GTE, LT, LTE, CONTAINS). Use AND/OR for compound queries. Example: {'AVAILABILITY': {'EQ': 'IN_STOCK'}} or {'AND': [{'GENDER': {'EQ': 'UNISEX'}}, {'AVAILABILITY': {'EQ': 'IN_STOCK'}}]} | | `catalog_id` | string | Yes | The unique identifier for the catalog | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Catalog Flights **Slug:** `SNAPCHAT_CREATE_CATALOGS_FLIGHTS_SEARCH` Tool to search for flights within a Snapchat catalog using optional filters. Use when you need to retrieve and filter flight listings from a dynamic product ads catalog. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of flight results per page. Must be between 50 and 1000. | | `filter` | object | No | Filter object to narrow search results using flight properties. Supports logical operators (AND/OR) and comparison operators (EQ, NEQ, GT, GTE, LT, LTE, CONTAINS, etc.). Filterable properties include: ID, ORIGIN_AIRPORT, DESTINATION_AIRPORT, ORIGIN_CITY, DESTINATION_CITY, PRICE_AMOUNT, CUSTOM_LABEL_0 through CUSTOM_LABEL_4, ITEM_SET_ID, PRODUCT_STATUS, and ELIGIBLE_AD_TYPE. | | `catalog_id` | string | Yes | The unique identifier for the catalog to search within. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Catalogs Product Feed **Slug:** `SNAPCHAT_CREATE_CATALOGS_PRODUCT_FEEDS` Tool to create a new product feed under a specified catalog. Use when setting up product data synchronization for dynamic product ads. Note: Currently only one product feed can exist per catalog. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the product feed (maximum 375 characters) | | `status` | string ("ACTIVE" | "INACTIVE") | No | Enumeration of product feed status values | | `schedule` | object | No | Schedule configuration for automated feed fetching | | `feed_type` | string ("PRIMARY" | "SUPPLEMENTAL") | Yes | Type of product feed: PRIMARY (main feed) or SUPPLEMENTAL (additional data feed). Note: Only one product feed can exist per catalog. | | `catalog_id` | string | Yes | The unique identifier of the catalog under which to create the product feed | | `parent_feed_id` | string | No | Parent feed identifier. Required only when feed_type is SUPPLEMENTAL. | | `default_currency` | string | Yes | Three-letter ISO 4217 currency code (e.g., USD, EUR, GBP) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Catalog Product Set **Slug:** `SNAPCHAT_CREATE_CATALOGS_PRODUCT_SETS` Tool to create a new product set within a Snapchat catalog. Use when you need to define product groups using filters for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the product set | | `catalog_id` | string | Yes | The unique identifier of the catalog to create the product set in | | `description` | string | No | Description of the product set | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Media **Slug:** `SNAPCHAT_CREATE_MEDIA` Tool to create a new media file in a Snapchat ad account. Use when you need to register media assets (images, videos, lenses, or playable ads) before uploading content or associating with ad creatives. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `media` | array | Yes | List of media items to create. Each item represents a media file that will be created in the ad account. | | `ad_account_id` | string | Yes | Ad Account ID where the media will be created. This is the account identifier from your Snapchat Ads account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Organizations Catalogs **Slug:** `SNAPCHAT_CREATE_ORGANIZATIONS_CATALOGS` Tool to create new product catalogs within a Snapchat organization for Dynamic Product Ads. Use when you need to set up catalogs for automated ad generation based on product data feeds. Requires Organization Admin permission. Maximum 200 catalogs per organization, 10 per batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `catalogs` | array | Yes | Array of catalog configurations to create (minimum 1, maximum 10 per batch request) | | `organization_id` | string | Yes | Organization ID (path parameter) - the organization where catalogs will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Organization Role **Slug:** `SNAPCHAT_CREATE_ORG_ROLE` Tool to create a new role for an organization in Snapchat Marketing API. Use when you need to assign roles to organization members after they have been invited. Each member must be assigned one organization-level role type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roles` | array | Yes | List of roles to create for organization members. Each member must be assigned one organization-level role type. | | `organization_id` | string | Yes | UUID of the organization where the role will be created. This is used in the URL path. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Audience Segment **Slug:** `SNAPCHAT_CREATE_SEGMENT` Tool to create new audience segments (customer lists or lookalikes) in Snapchat Ads. Use when you need to create targeted audience segments for ad campaigns. Initial status returns as PENDING and transitions occur after processing. Note: An ad account can only have a maximum of 1000 customer list segments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `segments` | array | Yes | List of audience segments to create. Note: An ad account can have a maximum of 1000 customer list segments. | | `ad_account_id` | string | Yes | The ad account ID to create segments in. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Offer Disclaimer **Slug:** `SNAPCHAT_DELETE_ADACCOUNTS_OFFER_DISCLAIMERS` Tool to delete an offer disclaimer from a Snapchat ad account. Use when you need to remove an offer disclaimer that is no longer needed or was created in error. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | UUID of the ad account that owns the offer disclaimer. | | `offer_disclaimer_id` | string | Yes | UUID of the offer disclaimer to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ad Squad **Slug:** `SNAPCHAT_DELETE_ADSQUADS` Tool to permanently delete an ad squad from Snapchat Marketing API. Use when you need to remove an ad squad that is no longer needed. This operation cannot be undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the ad squad to delete. This is a permanent operation that cannot be undone. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete All Segment Users **Slug:** `SNAPCHAT_DELETE_ALL_SEGMENT_USERS` Tool to remove all users from a Snapchat audience segment. Use when you need to clear all users from a Customer List segment. Returns the updated segment with approximate_number_users set to 0. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `segment_id` | string | Yes | The identifier for the Customer List segment from which all users will be removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Campaign **Slug:** `SNAPCHAT_DELETE_CAMPAIGN` Tool to delete a campaign from Snapchat Marketing API. Use when you need to permanently remove a campaign from your Snapchat Ads account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `campaign_id` | string | Yes | The unique identifier of the campaign to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Catalog **Slug:** `SNAPCHAT_DELETE_CATALOGS` Tool to delete a catalog by ID from Snapchat Marketing API. Use when you need to permanently remove a catalog. This is a destructive operation that cannot be undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `catalog_id` | string | Yes | The unique identifier of the catalog to delete. This is the catalog ID obtained from list or create catalog operations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Event Details **Slug:** `SNAPCHAT_DELETE_EVENT_DETAILS` Tool to delete event details from Snapchat Marketing API. Use when you need to remove an Event Details entity. Use with caution as there is no way to reinstate a deleted entity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_details_id` | string | Yes | The ID of the Event Details entity to be deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Member **Slug:** `SNAPCHAT_DELETE_MEMBER` Tool to remove a member from an organization in Snapchat Marketing API. Use when you need to revoke access for a member. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `member_id` | string | Yes | The unique identifier of the member to delete from the organization. Obtain this from the list members or get member actions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete product feed **Slug:** `SNAPCHAT_DELETE_PRODUCT_FEEDS` Tool to permanently delete a product feed from Snapchat Ads. Use when you need to remove a product catalog feed. Requires Organization Admin permission. This action is irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `product_feed_id` | string | Yes | The unique identifier for the product feed to be deleted. This is the ID returned when creating a product feed or obtained from listing product feeds. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Role **Slug:** `SNAPCHAT_DELETE_ROLE` Tool to delete a role from Snapchat Marketing API. Use when you need to remove a role from an Organisation, Catalog or Ad Account. If deleting all of a Member's roles, consider also deleting the Member entity from the Organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role_id` | string | Yes | The unique identifier of the role to be removed from an Organisation, Catalog or Ad Account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Audience Segment **Slug:** `SNAPCHAT_DELETE_SEGMENT` Tool to delete an audience segment from Snapchat. Use when you need to permanently remove an audience segment. WARNING: This operation is irreversible - deleted segments cannot be retrieved. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `segment_id` | string | Yes | The unique identifier of the audience segment to delete. WARNING: Deleted audience segments cannot be retrieved, so use this with caution. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Users from Segment **Slug:** `SNAPCHAT_DELETE_SEGMENT_USERS` Tool to remove specific users from a Snapchat audience segment. Use when you need to delete certain user identifiers (email, phone, or mobile ad IDs) from a Customer List segment. All identifiers must be normalized and SHA-256 hashed before submission. Maximum 100,000 identifiers per request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `users` | array | Yes | Array of user data objects. Each object contains a schema type and corresponding hashed identifiers to remove. All identifiers must be normalized and SHA-256 hashed. Maximum 100,000 identifiers per request. | | `segment_id` | string | Yes | The ID of the segment to delete users from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account **Slug:** `SNAPCHAT_GET_AD_ACCOUNT` Tool to retrieve a specific ad account by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Unique identifier of the ad account to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Ad Squads **Slug:** `SNAPCHAT_GET_ADACCOUNTS_ADSQUADS` Tool to retrieve all ad squads in an ad account by ID. Use when you need to list or fetch ad squads for a specific Snapchat ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve ad squads for. Must be a valid UUID of an existing ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Ad Squad UI Render Data **Slug:** `SNAPCHAT_GET_ADACCOUNTS_AD_SQUAD_UI_RENDER_DATA` Tool to retrieve ad squad UI render data for a Snapchat ad account. Use when you need to fetch UI render data objects that determine available optimization goals together with campaign objectives. The conversion_location field indicates where conversions occur (APP, CALL, LEAD_FORM, PUBLIC_PROFILE, TEXT, or WEB). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | string | No | One or more Ad Squad UI Render Data ID values; use commas to separate multiple IDs | | `limit` | integer | No | Maximum number of results to return (value between 50-1000) | | `ad_account_id` | string | Yes | The Ad Account ID for which to retrieve UI render data objects | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Dynamic Templates **Slug:** `SNAPCHAT_GET_ADACCOUNTS_DYNAMIC_TEMPLATES` Tool to retrieve dynamic templates for a Snapchat ad account. Use when you need to list or fetch dynamic templates used for dynamic product ads in a specific ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve dynamic templates for. Must be a valid UUID of an existing ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Event Details **Slug:** `SNAPCHAT_GET_ADACCOUNTS_EVENT_DETAILS` Tool to retrieve all Event Details entities for a specific ad account. Use when you need to list event details associated with an ad account for reminder creative campaigns. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | The Ad Account identifier where event details are stored | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Interaction Zones **Slug:** `SNAPCHAT_GET_ADACCOUNTS_INTERACTION_ZONES` Tool to retrieve interaction zones for an ad account from Snapchat Marketing API. Use when you need to list all interaction zones configured for a specific ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | The ID of the ad account to retrieve interaction zones for (UUID format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Lead Generation Forms **Slug:** `SNAPCHAT_GET_AD_ACCOUNTS_LEAD_GENERATION_FORMS` Tool to retrieve all lead generation forms for a specific ad account from Snapchat Marketing API. Use when you need to list or fetch all lead gen forms associated with an advertising account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Unique identifier of the ad account to retrieve lead generation forms for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Leads Report **Slug:** `SNAPCHAT_GET_ADACCOUNTS_LEADS_REPORT` Tool to retrieve ad account leads report by ID from Snapchat Marketing API. Use when you need to fetch lead generation data for a specific ad account and report run. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Ad account ID for which to retrieve the leads report (UUID format). | | `report_run_id` | string | Yes | Unique identifier of the report run to retrieve. This ID is returned when requesting a leads report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Mobile Apps **Slug:** `SNAPCHAT_GET_ADACCOUNTS_MOBILE_APPS` Tool to retrieve all mobile apps associated with a Snapchat ad account by ID. Use when you need to list or fetch mobile apps for a specific ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve associated mobile apps for. Must be a valid UUID of an existing ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Offer Disclaimers **Slug:** `SNAPCHAT_GET_ADACCOUNTS_OFFER_DISCLAIMERS` Tool to retrieve all offer disclaimers for a specific ad account from Snapchat Marketing API. Use when you need to list or fetch legal disclaimers associated with an advertising account's offers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of disclaimers to return in a single page (1-1000). Default is 50. | | `cursor` | string | No | Pagination cursor pointing to a specific page of results. Use the value from the previous response's next_link field. | | `ad_account_id` | string | Yes | Unique identifier of the ad account to retrieve offer disclaimers for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Spend Guidance **Slug:** `SNAPCHAT_GET_ADACCOUNTS_SPEND_GUIDANCE` Tool to retrieve spend guidance for an ad account from Snapchat Marketing API. Use when you need bid and budget recommendations for specific signal types and optimization goals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `signal_id` | string | No | Signal ID (e.g., Pixel ID) to get guidance for. Required when signal_type is specified. | | `signal_type` | string ("PIXEL") | No | Signal type for spend guidance. | | `ad_account_id` | string | Yes | Ad Account ID for which to retrieve spend guidance (UUID format). | | `conversion_window` | string ("SWIPE_28DAY_VIEW_1DAY" | "SWIPE_7DAY") | No | Conversion window for spend guidance. | | `optimization_goal` | string ("PIXEL_PURCHASE" | "PIXEL_ADD_TO_CART" | "PIXEL_PAGE_VIEW" | "PIXEL_SIGNUP" | "LANDING_PAGE_VIEW" | "SWIPES" | "STORY_OPENS") | No | Optimization goal for spend guidance. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Stats **Slug:** `SNAPCHAT_GET_AD_ACCOUNTS_STATS` Tool to retrieve ad account statistics from Snapchat Marketing API. Use when you need performance metrics like impressions, swipes, spend, or video views for an ad account over a specified time period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated list of metric fields to retrieve (e.g., 'impressions,swipes,spend'). Common metrics include: impressions, swipes, spend, screen_time_millis, quartile_1, quartile_2, quartile_3, view_completion, video_views, uniques, frequency. If not provided, returns default metrics. | | `end_time` | string | No | End time for the stats query in ISO 8601 format with timezone offset (e.g., 2024-01-08T00:00:00-08:00). Must end at the beginning of an hour (minutes and seconds should be 00:00). If not provided, defaults to current time. | | `start_time` | string | No | Start time for the stats query in ISO 8601 format with timezone offset (e.g., 2024-01-01T00:00:00-08:00). If not provided, defaults to account creation date. | | `granularity` | string ("TOTAL" | "LIFETIME" | "DAY" | "HOUR") | No | Time granularity for statistics. | | `ad_account_id` | string | Yes | Ad Account ID (UUID format) for which to retrieve statistics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Stats Report **Slug:** `SNAPCHAT_GET_ADACCOUNTS_STATS_REPORT` Tool to retrieve ad account stats report by ID from Snapchat Marketing API. Use when you need to check the status of an async stats report or download a completed report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad account ID for which to retrieve the stats report (UUID format). | | `report_run_id` | string | Yes | Unique identifier of the report run to retrieve. This ID is returned when requesting an async stats report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad **Slug:** `SNAPCHAT_GET_AD_SQUAD` Tool to retrieve a specific ad squad by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing ad squad including targeting, budget, and placement settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Unique identifier of the ad squad to retrieve (UUID format). | | `targeting_v2` | boolean | No | Include targeting V2 data in the response. Set to true to get detailed targeting information. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad Restrictions **Slug:** `SNAPCHAT_GET_AD_SQUAD_RESTRICTIONS` Tool to retrieve ad type restrictions for a specific ad squad from Snapchat Marketing API. Use when you need to see which ad types are currently present in an ad squad and their counts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Unique identifier of the ad squad to retrieve ad restrictions for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad Audience Size **Slug:** `SNAPCHAT_GET_ADSQUADS_AUDIENCE_SIZE_V2` Tool to retrieve estimated audience size for a specific ad squad by ID. Use when you need to check the potential reach of an existing ad squad's targeting configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Ad squad ID to retrieve audience size for. Must be a valid UUID of an existing ad squad. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad Stats Report **Slug:** `SNAPCHAT_GET_ADSQUADS_STATS_REPORT` Tool to retrieve adsquads stats report by ID from Snapchat Marketing API. Use when checking the status of an async report or getting the download URL for a completed stats report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Ad Squad ID to retrieve stats report for (UUID format). | | `report_run_id` | string | Yes | The identifier of the report to fetch, returned from the initial async report creation request. Format: ASYNC_STATS:{id}:{timestamp}:{uuid} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad Stats **Slug:** `SNAPCHAT_GET_AD_SQUAD_STATS` Tool to retrieve performance statistics for a specific ad squad from Snapchat Marketing API. Use when you need to analyze ad squad performance metrics such as impressions, swipes, conversions, and spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics. | | `end_time` | string | No | End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time. | | `start_time` | string | No | Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad squad creation. | | `ad_squad_id` | string | Yes | Unique identifier of the ad squad to retrieve statistics for (UUID format). | | `granularity` | string ("TOTAL" | "DAY" | "HOUR") | No | Time granularity for statistics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Squad Targeting **Slug:** `SNAPCHAT_GET_AD_SQUAD_TARGETING` Tool to retrieve targeting specifications for a specific ad squad from Snapchat Marketing API. Use when you need to fetch detailed targeting criteria for an existing ad squad. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Unique identifier of the ad squad to retrieve targeting specifications for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Stats **Slug:** `SNAPCHAT_GET_AD_STATS` Tool to retrieve performance statistics for a specific ad from Snapchat Marketing API. Use when you need to analyze ad performance metrics such as impressions, swipes, conversions, and spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `test` | boolean | No | Enable test mode to retrieve statistics from test ads. Set to true for test/sandbox environments. | | `ad_id` | string | Yes | Unique identifier of the ad to retrieve statistics for (UUID format). | | `fields` | string | No | Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics. | | `end_time` | string | No | End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time. | | `start_time` | string | No | Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad creation. | | `granularity` | string ("TOTAL" | "DAY" | "HOUR") | No | Time granularity for statistics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Authenticated User **Slug:** `SNAPCHAT_GET_AUTHENTICATED_USER` Tool to retrieve information about the authenticated user from Snapchat Marketing API. Use when you need to fetch the current user's ID, email, display name, organization membership, or Snapchat username. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Billing Center **Slug:** `SNAPCHAT_GET_BILLING_CENTER` Tool to retrieve a specific billing center by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing billing center. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `billing_center_id` | string | Yes | Unique identifier of the billing center to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Campaign **Slug:** `SNAPCHAT_GET_CAMPAIGN` Tool to retrieve a specific campaign by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `campaign_id` | string | Yes | Unique identifier of the campaign to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Campaign Changelog **Slug:** `SNAPCHAT_GET_CAMPAIGN_CHANGELOG` Tool to retrieve changelog (audit log) for a campaign from Snapchat Marketing API. Use when you need to track changes made to a campaign, including who made the changes and what was modified. Note: changelogs are only available from July 16, 2019 onwards. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of changelog records to retrieve per request. Defaults to 50. | | `campaign_id` | string | Yes | Unique identifier of the campaign to retrieve changelog for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Campaigns by IDs **Slug:** `SNAPCHAT_GET_CAMPAIGNS_BY_IDS` Tool to fetch multiple campaigns by their IDs from Snapchat Marketing API. Use when you need to retrieve detailed information about specific campaigns in bulk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity_ids` | array | Yes | List of campaign IDs to retrieve. Each ID should be a UUID format identifier. | | `ad_account_id` | string | Yes | Ad Account ID to fetch campaigns from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Campaign Stats **Slug:** `SNAPCHAT_GET_CAMPAIGN_STATS` Tool to retrieve performance statistics for a specific campaign from Snapchat Marketing API. Use when you need to analyze campaign performance metrics such as impressions, swipes, conversions, and spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics. | | `end_time` | string | No | End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time. | | `start_time` | string | No | Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from campaign creation. | | `campaign_id` | string | Yes | Unique identifier of the campaign to retrieve statistics for (UUID format). | | `granularity` | string ("DAY" | "HOUR") | No | Time granularity for statistics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Catalog **Slug:** `SNAPCHAT_GET_CATALOGS` Tool to retrieve a specific catalog by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing catalog including its vertical, event sources, and product set details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `catalog_id` | string | Yes | Unique identifier of the catalog to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Catalog Product Sets **Slug:** `SNAPCHAT_GET_CATALOGS_PRODUCT_SETS` Tool to retrieve all product sets from a Snapchat catalog. Use when you need to list or view product sets within a specific catalog for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `catalog_id` | string | Yes | The unique identifier of the catalog to retrieve product sets from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dynamic Template **Slug:** `SNAPCHAT_GET_DYNAMIC_TEMPLATE` Tool to retrieve a specific dynamic template by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing dynamic template used for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier of the dynamic template to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dynamic Templates External Changelogs **Slug:** `SNAPCHAT_GET_DYNAMIC_TEMPLATES_EXTERNAL_CHANGELOGS` Tool to retrieve external changelogs for a dynamic template from Snapchat Marketing API. Use when you need to track modification history and audit changes made to a dynamic template. Note: changelogs are only available from July 16, 2019 onwards. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of changelog records to return. Use for pagination to manage large result sets. | | `dynamic_template_id` | string | Yes | Unique identifier of the dynamic template to retrieve changelogs for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Event Details **Slug:** `SNAPCHAT_GET_EVENT_DETAILS` Tool to retrieve event details by ID from Snapchat Marketing API. Use when you need to fetch detailed information about a specific event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_details_id` | string | Yes | The unique identifier for the Event Details entity (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Funding Source **Slug:** `SNAPCHAT_GET_FUNDING_SOURCE` Tool to retrieve a specific funding source by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about payment methods like credit cards, PayPal accounts, or lines of credit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `funding_source_id` | string | Yes | Unique identifier of the funding source to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Interaction Zone **Slug:** `SNAPCHAT_GET_INTERACTION_ZONE` Tool to retrieve a specific interaction zone by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing interaction zone including its creative elements and render type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interaction_zone_id` | string | Yes | Unique identifier of the interaction zone to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice **Slug:** `SNAPCHAT_GET_INVOICE` Tool to retrieve a specific invoice by its ID from Snapchat Marketing API. Use when you need to fetch detailed billing information including amounts, due dates, and optionally PDF content for a specific invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_id` | string | Yes | Invoice ID (UUID format) to retrieve. | | `include_pdf` | boolean | No | When set to true, includes the invoice_content attribute in the response containing Base64-encoded PDF content. | | `ad_account_id` | string | Yes | Ad Account ID (UUID format) for which to retrieve the invoice. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Media **Slug:** `SNAPCHAT_GET_MEDIA` Tool to retrieve a specific media file by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing media asset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `media_id` | string | Yes | Unique identifier of the media file to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Media by IDs **Slug:** `SNAPCHAT_GET_MEDIA_BY_IDS` Tool to fetch multiple media items by their IDs from Snapchat Marketing API. Use when you need to retrieve detailed information about specific media assets in bulk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity_ids` | array | Yes | List of media IDs to retrieve. Each ID should be a UUID format identifier. Maximum 2,000 entries. | | `ad_account_id` | string | Yes | Ad Account ID to fetch media from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Media Stats **Slug:** `SNAPCHAT_GET_MEDIA_STATS` Tool to retrieve performance statistics for a specific media from Snapchat Marketing API. Use when you need to analyze media performance metrics such as impressions, swipes, spend, and video views. Supports VIDEO and IMAGE media types only; reach metrics are not available. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns default metrics (impressions, spend). | | `end_time` | string | No | End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Required when granularity is DAY. | | `media_id` | string | Yes | Unique identifier of the media to retrieve statistics for (UUID format). | | `start_time` | string | No | Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Required when granularity is DAY. | | `granularity` | string ("LIFETIME" | "DAY") | Yes | Time granularity for statistics breakdown. LIFETIME returns all-time aggregate stats, DAY returns daily breakdown (requires start_time and end_time). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Member **Slug:** `SNAPCHAT_GET_MEMBER` Tool to retrieve a specific member by ID from a Snapchat organization. Use when you need to fetch detailed information about an existing member. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `member_id` | string | Yes | The unique identifier of the member to retrieve from the organization. Obtain this from the list members or create member actions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organization **Slug:** `SNAPCHAT_GET_ORGANIZATION` Tool to retrieve a specific organization by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Unique identifier of the organization to retrieve (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organizations Catalogs **Slug:** `SNAPCHAT_GET_ORGANIZATIONS_CATALOGS` Tool to retrieve all catalogs for a specific organization from Snapchat Marketing API. Use when you need to list all catalogs within an organization for Dynamic Product Ads. Supports pagination for large result sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of catalogs to return per page (default depends on API, typically 20-50). | | `cursor` | string | No | Pagination cursor for retrieving the next page of results. Obtained from the 'next_link' in the previous response's paging object. | | `organization_id` | string | Yes | Organization ID to retrieve catalogs for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organizations Mobile Apps **Slug:** `SNAPCHAT_GET_ORGANIZATIONS_MOBILE_APPS` Tool to retrieve mobile apps associated with a Snapchat organization by organization ID. Use when you need to list iOS and Android apps registered for tracking and campaigns. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned (between 50-1000) | | `ad_account_id` | string | No | Optional filter to retrieve apps for a specific Ad Account ID (UUID format) | | `organization_id` | string | Yes | The unique identifier for the organization (UUID format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organizations Public Profiles **Slug:** `SNAPCHAT_GET_ORGANIZATIONS_PUBLIC_PROFILES` Tool to retrieve organization public profiles by ID from Snapchat Marketing API. Use when you need to fetch public profile information for a specific organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Organization ID to retrieve public profiles from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Account Pixels **Slug:** `SNAPCHAT_GET_PIXELS` Tool to retrieve all Snap Pixels associated with an ad account. Use when you need to list conversion tracking pixels for a specific Snapchat ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve pixels for. Must be a valid UUID of an existing ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Product Feed **Slug:** `SNAPCHAT_GET_PRODUCT_FEEDS` Tool to retrieve a product feed by ID from Snapchat Marketing API. Use when you need to get details about a specific product feed including its configuration, schedule, and metadata for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `product_feed_id` | string | Yes | Unique identifier of the product feed to retrieve (UUID format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Product Feed Uploads **Slug:** `SNAPCHAT_GET_PRODUCT_FEEDS_FEED_UPLOADS` Tool to retrieve product feed upload history for a specific product feed. Use when you need to check the status, metrics, or processing details of product catalog uploads for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `product_feed_id` | string | Yes | The unique identifier of the product feed to retrieve uploads for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Product Set **Slug:** `SNAPCHAT_GET_PRODUCT_SETS` Tool to retrieve a specific product set by ID from Snapchat Marketing API. Use when you need to fetch details about a particular product set for dynamic product ads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the product set to retrieve (UUID format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Audience Segment **Slug:** `SNAPCHAT_GET_SEGMENT` Tool to retrieve a specific audience segment by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing segment including its status, size, and targeting availability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `segment_id` | string | Yes | The unique identifier of the audience segment to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Carriers **Slug:** `SNAPCHAT_GET_TARGETING_CARRIERS` Tool to retrieve available mobile carrier targeting options from Snapchat Marketing API. Use when you need to get the list of carriers that can be used for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Connection Types **Slug:** `SNAPCHAT_GET_TARGETING_CONNECTION_TYPES` Tool to retrieve available connection types for device targeting from Snapchat Marketing API. Use when you need to fetch the list of connection type options (WIFI, CELL) that can be used for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Advanced Demographics Targeting Options **Slug:** `SNAPCHAT_GET_TARGETING_DEMOGRAPHICS_ADVANCED_DEMOGRAPHICS` Tool to retrieve all available advanced demographics targeting options from Snapchat Marketing API. Use when you need to fetch the list of demographic segments available for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Demographics Age Group **Slug:** `SNAPCHAT_GET_TARGETING_DEMOGRAPHICS_AGE_GROUP` Tool to retrieve all available age group targeting options from Snapchat Marketing API. Use when you need to fetch the predefined age brackets (13-17, 18-20, 21-24, 25-34, 35+) for demographic targeting in ad campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Gender Targeting Options **Slug:** `SNAPCHAT_GET_TARGETING_DEMOGRAPHICS_GENDER` Tool to retrieve all available gender targeting options from Snapchat Marketing API. Use when you need to fetch the list of gender categories available for ad targeting (MALE, FEMALE, OTHER). #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Demographics Languages **Slug:** `SNAPCHAT_GET_TARGETING_DEMOGRAPHICS_LANGUAGES` Tool to retrieve all available language targeting options from Snapchat Marketing API. Use when you need to fetch language codes and names for demographic targeting in ad campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Device iOS OS Version **Slug:** `SNAPCHAT_GET_TARGETING_DEVICE_IOS_OS_VERSION` Tool to retrieve all available iOS OS version targeting options from Snapchat Marketing API. Use when you need to get the list of iOS versions that can be used for targeting with os_version_min and os_version_max parameters. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Device Marketing Names **Slug:** `SNAPCHAT_GET_TARGETING_DEVICE_MARKETING_NAMES` Tool to retrieve available device marketing names for targeting from Snapchat Marketing API. Use when you need to get the list of device makes and models that can be used for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Geo Postal Codes **Slug:** `SNAPCHAT_GET_TARGETING_GEO_POSTAL_CODE` Tool to retrieve postal code targeting options by country code from Snapchat Marketing API. Use when you need to get the list of postal codes available for ad targeting in a specific country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country_code` | string | Yes | ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA') to retrieve postal codes for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Geo Region **Slug:** `SNAPCHAT_GET_TARGETING_GEO_REGION` Tool to retrieve region targeting options for a specific country from Snapchat Marketing API. Use when you need to get the list of regions (states, provinces, etc.) that can be used for ad targeting within a particular country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country_code` | string | Yes | Two-letter ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA', 'GB') to retrieve regions for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Geo US Postal Codes **Slug:** `SNAPCHAT_GET_TARGETING_GEO_US_POSTAL_CODE` Tool to retrieve all US postal code targeting options from Snapchat Marketing API. Use when you need to get the list of US ZIP codes available for ad targeting with geographic hierarchy data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Page size - the number of entries to retrieve in one page. Must be between 10 and 10000. | | `cursor` | string | No | Pagination cursor for navigating through results. Omit or use empty string for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Geo US Region **Slug:** `SNAPCHAT_GET_TARGETING_GEO_US_REGION` Tool to retrieve all available US region targeting options from Snapchat Marketing API. Use when you need to fetch the list of US states/regions available for geographic ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Interests DLXC **Slug:** `SNAPCHAT_GET_TARGETING_INTERESTS_DLXC` Tool to retrieve Oracle Datalogix DLXC interest targeting options from Snapchat Marketing API. Use when you need to fetch available DLXC interest categories for ad targeting. Note: This endpoint is deprecated as of September 27, 2024. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Interests DLXP **Slug:** `SNAPCHAT_GET_TARGETING_INTERESTS_DLXP` Tool to retrieve Oracle Datalogix DLXP interest targeting options from Snapchat Marketing API. Use when you need to fetch business dealer and service targeting options for ad campaigns. Note: This endpoint is deprecated. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Interests DLXS **Slug:** `SNAPCHAT_GET_TARGETING_INTERESTS_DLXS` Tool to retrieve all available Oracle Datalogix (DLXS) interest targeting options from Snapchat Marketing API. Use when you need to get the list of DLXS interests that can be used for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Interests NLN **Slug:** `SNAPCHAT_GET_TARGETING_INTERESTS_NLN` Tool to retrieve all available Nielsen interest targeting options from Snapchat Marketing API. Use when you need to get Nielsen-based interest categories for audience targeting in ad campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Interests PLC **Slug:** `SNAPCHAT_GET_TARGETING_INTERESTS_PLC` Tool to retrieve all available PLC (Placed Visitation Segments) targeting options from Snapchat Marketing API. Use when you need to get location-based interest segments for audience targeting in ad campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Location Category LOI Options **Slug:** `SNAPCHAT_GET_TARGETING_LOCATION_CATEGORIES_LOI` Tool to retrieve all location category (LOI - Locations of Interest) targeting options from Snapchat Marketing API. Use when you need to fetch the list of venue types and business categories available for location-based ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting Metros **Slug:** `SNAPCHAT_GET_TARGETING_METROS` Tool to retrieve metro/DMA targeting options by country code from Snapchat Marketing API. Use when you need to get the list of metro areas available for ad targeting in a specific country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country_code` | string | Yes | ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA') to retrieve metro areas for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting OS Types **Slug:** `SNAPCHAT_GET_TARGETING_OS_TYPES` Tool to retrieve available OS type targeting options from Snapchat Marketing API. Use when you need to get the list of operating system types (e.g., iOS, Android) that can be used for ad targeting. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting OS Versions **Slug:** `SNAPCHAT_GET_TARGETING_OS_VERSIONS` Tool to retrieve available OS versions for targeting from Snapchat Marketing API. Use when you need to get the list of iOS or Android versions that can be used for targeting with os_version_min and os_version_max parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `os_type` | string ("iOS" | "ANDROID") | Yes | Operating system type to retrieve versions for (iOS or ANDROID) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting V1 Interests SCLS **Slug:** `SNAPCHAT_GET_TARGETING_V1_INTERESTS_SC_LS` Tool to retrieve all Snap Lifestyle Categories V1 targeting options from Snapchat Marketing API. Use when you need to fetch interest-based targeting categories for ad campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting V1 Interests Shp **Slug:** `SNAPCHAT_GET_TARGETING_V1_INTERESTS_SHP` Tool to retrieve first-party shopper segment targeting options from Snapchat Marketing API. Use when you need to get shopper segments for ad targeting based on consumer purchase behavior. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results to return. Must be between 50 and 1000. If not specified, API default is used. | | `country_code` | string | Yes | ISO ALPHA-2 country code in lowercase (e.g., 'us', 'gb', 'ca'). Required to retrieve shopper segments for the specified country. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting VAC Interests **Slug:** `SNAPCHAT_GET_TARGETING_V1_INTERESTS_VAC` Tool to retrieve First-Party Visitation Segments (VAC interests) for targeting from Snapchat Marketing API. Use when you need to fetch venue categories based on locations users have visited (e.g., restaurants, retail stores). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Page size for results. Must be between 50 and 1000 | | `is_hec` | boolean | No | Housing, Credit, Employment safe targeting flag. Set to true for HEC-compliant targeting | | `country_code` | string | No | ISO ALPHA-2 Country Code (lowercase) for target country (e.g., 'us', 'gb', 'ca') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Targeting V1 Options **Slug:** `SNAPCHAT_GET_TARGETING_V1_OPTIONS` Tool to retrieve all available targeting v1 options from Snapchat Marketing API. Use when you need to get the list of targeting dimensions available for ad targeting in a specific country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country_code` | string | No | ISO ALPHA-2 country code (uppercase, e.g., 'US', 'GB', 'CA') to filter targeting options by country. Required parameter. | | `is_intl_vac_enabled` | boolean | No | Whether to enable international VAC (Video Ad Comparison) options. Set to true to include international VAC targeting options. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Account Roles **Slug:** `SNAPCHAT_LIST_ACCOUNT_ROLES` Tool to retrieve all roles for a Snapchat Ad Account. Use when you need to view all member access permissions assigned within an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Controls pagination size. Must be between 50 and 1000 if specified. | | `ad_account_id` | string | Yes | The Ad Account ID for which to retrieve all roles (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ad Accounts **Slug:** `SNAPCHAT_LIST_AD_ACCOUNTS` Tool to retrieve all ad accounts associated with an organization from Snapchat Marketing API. Use when you need to list or fetch all ad accounts for a specific organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Unique identifier of the organization to retrieve ad accounts for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ads by Account **Slug:** `SNAPCHAT_LIST_ADS_BY_ACCOUNT` Tool to retrieve all ads for a specific ad account from Snapchat Marketing API. Use when you need to list all ads associated with an ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Unique identifier of the ad account to retrieve ads for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ads by Ad Squad **Slug:** `SNAPCHAT_LIST_ADS_BY_AD_SQUAD` Tool to retrieve all ads for a specific ad squad from Snapchat Marketing API. Use when you need to list all ads associated with an ad squad. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_squad_id` | string | Yes | Unique identifier of the ad squad to retrieve ads for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ads by Campaign **Slug:** `SNAPCHAT_LIST_ADS_BY_CAMPAIGN` Tool to retrieve all ads for a specific campaign from Snapchat Marketing API. Use when you need to list or fetch all ads associated with a particular campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `campaign_id` | string | Yes | Unique identifier of the campaign to retrieve ads for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ad Squads by Campaign **Slug:** `SNAPCHAT_LIST_AD_SQUADS` Tool to retrieve all ad squads for a specific campaign. Use when you need to list or fetch ad squads belonging to a particular Snapchat campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `campaign_id` | string | Yes | Campaign ID to retrieve ad squads for. Must be a valid UUID of an existing campaign. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Billing Centers **Slug:** `SNAPCHAT_LIST_BILLING_CENTERS` Tool to retrieve all billing centers for a Snapchat Ads organization. Use when you need to fetch a complete list of billing centers associated with an organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Unique identifier of the organization to retrieve billing centers for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Campaigns **Slug:** `SNAPCHAT_LIST_CAMPAIGNS` Tool to retrieve all campaigns for a specific ad account from Snapchat Marketing API. Use when you need to list all campaigns within an ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("updated_at-desc" | "created_at-desc") | No | Sort order for campaigns list. | | `ad_account_id` | string | Yes | Ad Account ID to retrieve campaigns from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Catalog Roles **Slug:** `SNAPCHAT_LIST_CATALOG_ROLES` Tool to retrieve all roles for a Snapchat catalog. Use when you need to view all member access permissions assigned within a catalog. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Controls pagination size. Must be between 50 and 1000 if specified. | | `catalog_id` | string | Yes | The Catalog ID for which to retrieve all roles (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Creatives **Slug:** `SNAPCHAT_LIST_CREATIVES` Tool to retrieve all creatives for a specific ad account from Snapchat Marketing API. Use when you need to list all creative assets within an ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve creatives from (UUID format). This is the unique identifier of your Snapchat ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Funding Sources **Slug:** `SNAPCHAT_LIST_FUNDING_SOURCES` Tool to retrieve all funding sources for a specific organization from Snapchat Marketing API. Use when you need to list all payment methods (credit cards, PayPal, lines of credit, coupons) available for an organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Organization ID to retrieve funding sources for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Invoices **Slug:** `SNAPCHAT_LIST_INVOICES` Tool to retrieve all invoices for an ad account from Snapchat Marketing API. Use when you need to fetch billing information for all invoices associated with a specific ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID (UUID format) for which to retrieve all invoices. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Media **Slug:** `SNAPCHAT_LIST_MEDIA` Tool to retrieve all media files for a specific Snapchat ad account. Use when you need to list all media assets (images, videos, lenses, or playable ads) available in an ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("created_at-asc" | "created_at-desc") | No | Sort order for media listing. | | `type` | string ("VIDEO" | "IMAGE" | "LENS_PACKAGE" | "PLAYABLE") | No | Media type filter for listing. | | `ad_account_id` | string | Yes | Ad Account ID (UUID format) for which to retrieve all media files. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Member Roles **Slug:** `SNAPCHAT_LIST_MEMBER_ROLES` Tool to retrieve all roles assigned to a member in Snapchat Marketing API. Use when you need to see all permissions a member has across organizations, ad accounts, and catalogs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of roles to return per page. Must be between 50 and 1000. Use for pagination control. | | `member_id` | string | Yes | The unique identifier of the member whose roles you want to retrieve. This includes roles within organizations, ad accounts, and catalogs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organization Members **Slug:** `SNAPCHAT_LIST_MEMBERS` Tool to retrieve all members of a Snapchat organization. Use when you need to view all users who have access to an organization, including their status (INVITED or MEMBER). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | Unique identifier of the organization to retrieve members from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organizations **Slug:** `SNAPCHAT_LIST_ORGANIZATIONS` Tool to retrieve all organizations that the authenticated user has access to from Snapchat Marketing API. Use when you need to list all organizations for the current user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `with_ad_accounts` | boolean | No | Include ad accounts in response. When set to true, the response will include detailed information about ad accounts associated with each organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organization Pixels **Slug:** `SNAPCHAT_LIST_ORG_PIXELS` Tool to retrieve all Snap Pixels for a specific organization from Snapchat Marketing API. Use when you need to list tracking pixels across all ad accounts within an organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | The ID of the organization to retrieve pixels from (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organization Roles **Slug:** `SNAPCHAT_LIST_ORG_ROLES` Tool to retrieve all roles for a Snapchat organization. Use when you need to view all member access permissions assigned within an organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Controls pagination size. Must be between 50 and 1000 if specified. | | `organization_id` | string | Yes | The Organization ID for which to retrieve all roles (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Phone Numbers **Slug:** `SNAPCHAT_LIST_PHONE_NUMBERS` Tool to retrieve all verified phone numbers associated with a Snapchat ad account. Use when you need to list or fetch phone numbers for calling and texting features. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Ad Account ID to retrieve associated phone numbers for. Must be a valid UUID of an existing ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audience Segments **Slug:** `SNAPCHAT_LIST_SEGMENTS` Tool to retrieve all audience segments for an ad account from Snapchat Marketing API. Use when you need to fetch a complete list of segments including customer lists, lookalikes, and engagement audiences. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_account_id` | string | Yes | Unique identifier of the ad account to retrieve segments for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Sponsored Content **Slug:** `SNAPCHAT_LIST_SPONSORED_CONTENT` Tool to retrieve organic sponsored content from Snapchat Ads Library. Use when you need to list all available sponsored content from the library with pagination support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination token for retrieving subsequent result sets. Use the cursor from the previous response's paging.next_link to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Transactions **Slug:** `SNAPCHAT_LIST_TRANSACTIONS` Tool to retrieve all transactions for an organization from Snapchat Marketing API. Use when you need to fetch transaction history including payments, refunds, and other billing activities. Supports filtering by time range and ad account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_time` | string | No | End time of transactions in UTC format (yyyy-mm-ddThh:mm:ss). Filters transactions created on or before this time. | | `start_time` | string | No | Start time of transactions in UTC format (yyyy-mm-ddThh:mm:ss). Filters transactions created on or after this time. | | `ad_account_id` | string | No | Ad Account ID to filter transactions for a specific ad account (UUID format). | | `organization_id` | string | Yes | Unique identifier of the organization to retrieve transactions for (UUID format). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Ads Library Sponsored Content **Slug:** `SNAPCHAT_SEARCH_ADS_LIBRARY_SPONSORED_CONTENT` Tool to search for sponsored content by creator name in Snapchat Ads Library. Use when you need to find ads associated with a specific creator. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return | | `cursor` | string | No | Pagination cursor for retrieving next page of results | | `creator_name` | string | Yes | Name of the creator to search for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Catalog Products **Slug:** `SNAPCHAT_SEARCH_CATALOG_PRODUCTS` Tool to search a catalog for products given a provided filter. Use when you need to find specific products in a catalog based on attributes like brand, availability, price, or other properties. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of products to return per page. Must be between 50 and 1000. If not specified, the API default will be used. | | `filter` | object | No | Filtering criteria using various product properties. Supports logical operators (AND, OR) with up to two nesting levels and maximum 10 fields per operator. Filterable properties include: AGE_GROUP, AVAILABILITY, BRAND, COLOR, CONDITION, GENDER, PRICE_AMOUNT, PRODUCT_TYPE, SIZE, TITLE, ID, ITEM_GROUP_ID, PRODUCT_SET_ID, CUSTOM_LABEL_0-4, GOOGLE_PRODUCT_CATEGORY, PRODUCT_STATUS, MEDIA_ELIGIBLE_AD_TYPE, PRICE_CURRENCY, SALE_PRICE_AMOUNT. Comparison operations: EQ, NEQ, GT, GTE, LT, LTE, CONTAINS, NOT_CONTAINS, I_CONTAINS, I_NOT_CONTAINS, STARTS_WITH, I_STARTS_WITH, IS_ANY, IS_NOT_ANY, I_IS_ANY, I_IS_NOT_ANY. | | `catalog_id` | string | Yes | The unique identifier of the catalog to search. This is the Catalog ID that you want to query for products. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Catalogs Hotels **Slug:** `SNAPCHAT_SEARCH_CATALOGS_HOTELS` Tool to search for hotels in a Snapchat catalog using filters and pagination. Use when you need to find specific hotels in a catalog by name, price, rating, location, or other attributes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results to return per page. Must be between 50 and 1000. | | `filter` | object | No | Optional filter to narrow search results. Supports AND/OR logical operators with up to 2 levels of nesting. Filter operators include: EQ (equal), NEQ (not equal), GT (greater than), GTE (greater than or equal), LT (less than), LTE (less than or equal), CONTAINS, NOT_CONTAINS, I_CONTAINS (case-insensitive contains), I_NOT_CONTAINS, STARTS_WITH, I_STARTS_WITH, IS_ANY, IS_NOT_ANY, I_IS_ANY, I_IS_NOT_ANY. Filterable fields include: ID, NAME, BASE_PRICE_AMOUNT, SALE_PRICE_AMOUNT, BRAND, NEIGHBORHOOD, STAR_RATING, LOYALTY_PROGRAM, ACTIVITY, CUSTOM_LABEL_0 through CUSTOM_LABEL_4, LOCALITY, POSTAL_CODE, COUNTRY_CODE, NUMBER_OF_RATERS, GUEST_RATING_SCORE, PRODUCT_SET_ID, PRODUCT_STATUS, ELIGIBLE_AD_TYPE. | | `catalog_id` | string | Yes | The identifier for the catalog to search in. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ad Account **Slug:** `SNAPCHAT_UPDATE_AD_ACCOUNT` Tool to update an existing ad account within a Snapchat organization. Use when modifying ad account settings such as name, status, billing, or spend caps. Requires the ad account ID and organization ID. All account fields must be provided in the update request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adaccounts` | array | Yes | List of ad accounts to update (typically one account per request) | | `organization_id` | string | Yes | Organization ID that owns the ad account | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ad Squad **Slug:** `SNAPCHAT_UPDATE_AD_SQUAD` Tool to update an existing ad squad within a campaign. Use when modifying ad delivery targeting, budgets, placements, or other settings for an existing Snapchat ad squad. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adsquads` | array | Yes | List of ad squads to update. Each ad squad must include an 'id' field. At least one ad squad is required. | | `campaign_id` | string | Yes | Campaign ID that the ad squad belongs to. Must be a valid UUID of an existing campaign. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Billing Center **Slug:** `SNAPCHAT_UPDATE_BILLING_CENTER` Tool to update one or more existing billing centers for a Snapchat Ads organization. Use when you need to modify billing center details such as name, email address, or billing address information. Requires the billing center ID along with organization ID and updated billing information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `billingcenters` | array | Yes | List of billing centers to update (one or more) | | `organization_id` | string | Yes | The organization ID that owns the billing center(s) to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Campaign **Slug:** `SNAPCHAT_UPDATE_CAMPAIGN` Tool to update an existing advertising campaign in Snapchat Marketing API. Use when you need to modify campaign properties like name, status, budget, timing, or objectives. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Updated campaign name (max 375 characters). If not provided, the existing name is retained. | | `status` | string ("ACTIVE" | "PAUSED") | No | Campaign status values. | | `end_time` | string | No | Updated campaign end time in ISO 8601 format. If not specified, campaign runs indefinitely until manually stopped. If not provided, the existing end_time is retained. | | `buy_model` | string ("AUCTION" | "RESERVED") | No | Campaign buy model values. | | `objective` | string ("AWARENESS" | "APP_INSTALLS" | "APP_VISITS" | "DRIVE_TRAFFIC" | "ENGAGEMENT" | "LEAD_GENERATION" | "PROMOTE_PLACES" | "VIDEO_VIEWS" | "BRAND_AWARENESS" | "WEBSITE_CONVERSIONS") | No | Campaign objective values. | | `start_time` | string | No | Updated campaign start time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). The campaign will not deliver before this time. If not provided, the existing start_time is retained. | | `campaign_id` | string | Yes | Unique identifier of the campaign to update (UUID format). | | `pacing_level` | string | No | Updated pacing level for budget optimization. Set to 'CAMPAIGN' to enable Smart Budgets at campaign level. If not provided, the existing pacing_level is retained. | | `ad_account_id` | string | Yes | Ad Account ID where the campaign exists. This is a UUID format identifier. | | `creation_state` | string | No | Updated creation state of the campaign. Set to 'PUBLISHED' if needed. If not provided, the existing creation_state is retained. | | `measurement_spec` | object | No | Measurement specification for app-related campaigns. | | `shared_properties` | object | No | Shared properties for Smart Budgets campaigns. | | `daily_budget_micro` | integer | No | Updated daily spend cap in micro-currency units (1,000,000 micro = 1 currency unit). If not set, the existing daily_budget_micro is retained. | | `objective_v2_properties` | object | No | Objective V2 properties for campaign. | | `lifetime_spend_cap_micro` | integer | No | Updated total campaign spend limit in micro-currency units. Campaign stops when this limit is reached. If not provided, the existing lifetime_spend_cap_micro is retained. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Audience Segment **Slug:** `SNAPCHAT_UPDATE_SEGMENT` Tool to update existing audience segments in Snapchat Ads. Use when you need to modify the name, description, or retention period of audience segments. Only these three fields can be updated; other segment properties are read-only. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `segments` | array | Yes | List of audience segments to update. Only name, description, and retention_in_days can be modified. | | `ad_account_id` | string | Yes | The ad account ID that owns the segments to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload Media Multipart **Slug:** `SNAPCHAT_UPLOAD_MEDIA_MULTIPART` Tool to upload large media files using multipart upload in Snapchat Marketing API. Use when uploading media files larger than 32MB or when you need to upload in chunks for reliability. Start with INIT action to get upload session details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("INIT" | "ADD" | "FINALIZE") | Yes | Action type for multipart upload. INIT starts a new upload session, ADD uploads a file chunk, FINALIZE completes the upload. | | `add_path` | string | No | Relative endpoint path for uploading file chunks, returned from INIT. Required for ADD action. | | `media_id` | string | Yes | Unique identifier of the media file to upload (UUID format). This media should be created first using Create Media action. | | `file_name` | string | No | Name of the file being uploaded. Required for INIT action. | | `file_path` | string | No | Local file path of the chunk to upload. Required for ADD action. | | `file_size` | integer | No | Total file size in bytes. Required for INIT action. Maximum 1GB (1073741824 bytes). | | `upload_id` | string | No | Upload session identifier returned from INIT. Required for ADD and FINALIZE actions. | | `part_number` | integer | No | The part number of the chunk being uploaded (0-indexed). Required for ADD action. | | `finalize_path` | string | No | Relative endpoint path for completing the upload, returned from INIT. Required for FINALIZE action. | | `number_of_parts` | integer | No | Expected number of file chunks. Required for INIT action. Each part can be up to 32MB. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Conversion Event **Slug:** `SNAPCHAT_VALIDATE_CONVERSION_EVENT` Tool to validate conversion events before sending them to Snapchat Conversion API. Use when testing pixel implementation or verifying event data format. Checks event structure, required fields, and data types without actually recording the events. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `events` | array | Yes | List of conversion events to validate (typically 1-100 events per request) | | `pixel_id` | string | Yes | Snap Pixel ID to validate events for. This must be a valid pixel ID from your Snapchat ad account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |