Skip to main content
Snapchat logo
  • Category: marketing
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 144
  • Triggers: 0
  • Slug: SNAPCHAT
  • Version: 20261101_00

Tools

Slug: SNAPCHAT_ADD_SEGMENT_USERSTool 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

array
required
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.
string
required
The ID of the segment to add users to

Output

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

array
required
List of media items to copy, each specifying source media ID and source ad account ID
string
required
The destination ad account ID where media will be copied to

Output

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

array
required
List of role assignments to create. Each role assignment specifies a member_id, ad_account_id, and role type.
string
required
The Ad Account ID where roles will be created

Output

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

array
required
List of ad accounts to create (typically one account per request)
string
required
Organization ID where the ad account will be created

Output

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

string
Name for the audience size estimation (optional).
string
Ad type (e.g., ‘SNAP_ADS’). Optional parameter.
string
Status (e.g., ‘ACTIVE’). Optional parameter.
boolean
Whether auto-bidding is enabled. Optional parameter.
integer
Bid amount in micro units (1 micro = 0.000001). Optional parameter.
string
Placement type (e.g., ‘CONTENT’). Optional parameter.
object
required
Targeting specifications including geographic and demographic criteria. At least one targeting criterion must be specified.
string
required
The Ad Account identifier (UUID format).
string
Optimization goal for the ad campaign (e.g., ‘APP_INSTALLS’, ‘SWIPES’, ‘PIXEL_PAGE_VIEW’, ‘IMPRESSIONS’). Optional parameter.
integer
Daily budget in micro units (1 micro = 0.000001). Optional parameter.
string
Budget constraint type (e.g., ‘DAILY_BUDGET’). Optional parameter.
array
Content type filters. Optional parameter.

Output

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

string
required
Ad account ID where the creative elements will be created
array
required
Array of creative elements to create. At least one element is required

Output

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

string
required
ID of the ad account to create dynamic templates for
array
required
List of dynamic templates to create

Output

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

string
required
UUID of the ad account where the event will be created. This is the path parameter.
array
required
Array of event details to create. Each event is immutable after creation and cannot be edited.

Output

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

string
required
The ID of the ad account to create interaction zones for
array
required
Array of interaction zone configurations to create

Output

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

string
required
UUID of the ad account to create offer disclaimers for. This is the path parameter in the URL.
array
required
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

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

string
required
The ad account ID for which to create the reserved forecasting.
string
Ad Squad type. Valid values are ‘SNAP_ADS’ or ‘LENS’. If not specified, defaults based on optimization_goal.
string
required
Campaign end time in ISO 8601 format (e.g., ‘2025-06-19T10:00:00.000Z’). Maximum booking window is 365 days.
object
required
Targeting configuration including geographic and demographic specifications. Radius and LOI targeting are not permitted.
string
required
Campaign start time in ISO 8601 format (e.g., ‘2025-05-20T10:00:00.000Z’). Booking window minimum is 12 hours.
object
required
Placement configuration for the ads. Use config=‘AUTOMATIC’ for automatic placement.
string
required
Optimization goal for the campaign. Use ‘VIDEO_VIEWS’ for Snap Ads or ‘USES’ for Lenses.
string
required
Delivery constraint for the campaign. Must be ‘REACH_AND_FREQUENCY’ for reserved forecasting.
object
required
Frequency cap and exclusion configuration specifying impression limits per user.

Output

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

string
required
The Ad Account ID to use for the targeting insights request
object
required
Base targeting specification to compare against. Defines the reference audience for comparison.
object
required
Target targeting specification to analyze. Defines the target audience to get insights for.
string ("demo" | "geo" | "device" | "interest" | "engagement" | "aggregated")
Dimension category filter for targeting insights output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_CREATE_ADSCreate static or dynamic ads in a Snapchat ad squad.

Input Parameters

array
required
Ads to create. At least one ad is required.
string
required
ID of the ad squad that will contain the ads.

Output

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

array
required
List of ad squads to create. At least one ad squad is required.
string
required
Campaign ID to create the ad squad under. Must be a valid UUID of an existing campaign.

Output

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

array
required
List of billing centers to create (one or more)
string
required
The organization ID to create billing center(s) under

Output

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

string
required
Campaign name (max 375 characters). This is the identifier shown in the Snapchat Ads Manager.
string ("ACTIVE" | "PAUSED")
required
Initial campaign status. ACTIVE means the campaign can start delivering (if other conditions are met), PAUSED means it’s created but not delivering.
string
Campaign end time in ISO 8601 format. If not specified, campaign runs indefinitely until manually stopped.
string ("AUCTION" | "RESERVED")
Campaign buy model values.
string
required
Campaign start time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). The campaign will not deliver before this time.
string
Pacing level for budget optimization. Set to ‘CAMPAIGN’ to enable Smart Budgets at campaign level.
string
required
Ad Account ID where the campaign will be created. This is a UUID format identifier.
string
Creation state of the campaign. Set to ‘PUBLISHED’ if needed.
object
Measurement specification for app-related campaigns.
object
Shared properties for Smart Budgets campaigns.
integer
Daily spend cap in micro-currency units (1,000,000 micro = 1 currency unit). If not set, no daily cap is enforced.
object
Objective V2 properties for campaign.
integer
Total campaign spend limit in micro-currency units. Campaign stops when this limit is reached.

Output

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

array
required
Array of role objects to create. Each role assigns permissions to a member for the specified catalog.
string
required
The Catalog ID where the role will be created (UUID format).

Output

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

integer
Integer between 1-50 specifying the number of groupings returned per facet
array
required
Array of facet specifications defining which attributes to group products by
object
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’}}]}
string
required
The unique identifier for the catalog

Output

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

integer
Number of flight results per page. Must be between 50 and 1000.
object
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.
string
required
The unique identifier for the catalog to search within.

Output

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

string
required
Name of the product feed (maximum 375 characters)
string ("ACTIVE" | "INACTIVE")
Enumeration of product feed status values
object
Schedule configuration for automated feed fetching
string ("PRIMARY" | "SUPPLEMENTAL")
required
Type of product feed: PRIMARY (main feed) or SUPPLEMENTAL (additional data feed). Note: Only one product feed can exist per catalog.
string
required
The unique identifier of the catalog under which to create the product feed
string
Parent feed identifier. Required only when feed_type is SUPPLEMENTAL.
string
required
Three-letter ISO 4217 currency code (e.g., USD, EUR, GBP)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_CREATE_CATALOGS_PRODUCT_SETSCreate a new product set within a Snapchat catalog for dynamic product ads, supplying a name and optional description.

Input Parameters

string
required
Name of the product set
string
required
The unique identifier of the catalog to create the product set in
string
Description of the product set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_CREATE_CREATIVESCreate static, dynamic catalog, or Showcase ad creatives in an ad account.

Input Parameters

array
required
One or more creative definitions to create.
string
required
Ad account that will own the creatives.

Output

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

array
required
List of media items to create. Each item represents a media file that will be created in the ad account.
string
required
Ad Account ID where the media will be created. This is the account identifier from your Snapchat Ads account.

Output

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

array
required
Array of catalog configurations to create (minimum 1, maximum 10 per batch request)
string
required
Organization ID (path parameter) - the organization where catalogs will be created

Output

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

array
required
List of roles to create for organization members. Each member must be assigned one organization-level role type.
string
required
UUID of the organization where the role will be created. This is used in the URL path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_CREATE_SEGMENTCreate audience segments in a Snapchat ad account for targeted ad campaigns. An ad account can have a maximum of 1,000 customer list segments.

Input Parameters

array
required
List of audience segments to create. Note: An ad account can have a maximum of 1000 customer list segments.
string
required
The ad account ID to create segments in.

Output

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

string
required
UUID of the ad account that owns the offer disclaimer.
string
required
UUID of the offer disclaimer to delete.

Output

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

string
required
The unique identifier of the ad squad to delete. This is a permanent operation that cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_DELETE_ALL_SEGMENT_USERSRemove all users from a Snapchat Customer List audience segment. The response may include updated segment details.

Input Parameters

string
required
The identifier for the Customer List segment from which all users will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_DELETE_CAMPAIGNTool to delete a campaign from Snapchat Marketing API. Use when you need to permanently remove a campaign from your Snapchat Ads account.

Input Parameters

string
required
The unique identifier of the campaign to delete.

Output

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

string
required
The unique identifier of the catalog to delete. This is the catalog ID obtained from list or create catalog operations.

Output

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

string
required
The ID of the Event Details entity to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_DELETE_MEMBERTool to remove a member from an organization in Snapchat Marketing API. Use when you need to revoke access for a member.

Input Parameters

string
required
The unique identifier of the member to delete from the organization. Obtain this from the list members or get member actions.

Output

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

string
required
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

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

string
required
The unique identifier of the role to be removed from an Organisation, Catalog or Ad Account.

Output

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

string
required
The unique identifier of the audience segment to delete. WARNING: Deleted audience segments cannot be retrieved, so use this with caution.

Output

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

array
required
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.
string
required
The ID of the segment to delete users from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADRetrieve the current details of one Snapchat ad by its ID.

Input Parameters

string
required
Unique identifier of the ad to retrieve (UUID format).
boolean
Whether to include a deleted ad and return its deleted flag.

Output

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

string
required
Unique identifier of the ad account to retrieve (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_ADSQUADSList ad squads for a Snapchat ad account by ID. Results are paginated; use the cursor to request another page.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Ad Account ID to retrieve ad squads for. Must be a valid UUID of an existing ad account.

Output

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

string
One or more Ad Squad UI Render Data ID values; use commas to separate multiple IDs
integer
Maximum number of results to return (value between 50-1000)
string
required
The Ad Account ID for which to retrieve UI render data objects

Output

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

string
required
Ad Account ID to retrieve dynamic templates for. Must be a valid UUID of an existing ad account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_EVENT_DETAILSList event details for a Snapchat ad account, including those associated with reminder creative campaigns. The response may include pagination information.

Input Parameters

string
required
The Ad Account identifier where event details are stored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_INTERACTION_ZONESList interaction zones for a Snapchat ad account. Results are paginated; use the cursor to request another page.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
The ID of the ad account to retrieve interaction zones for (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_AD_ACCOUNTS_LEAD_GENERATION_FORMSList lead generation forms associated with a Snapchat ad account. The response may include pagination information.

Input Parameters

string
required
Unique identifier of the ad account to retrieve lead generation forms for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_LEADS_REPORTRetrieve the status of a Snapchat ad account leads report for a specific report run, including a download URL when available.

Input Parameters

string
required
Ad account ID for which to retrieve the leads report (UUID format).
string
required
Unique identifier of the report run to retrieve. This ID is returned when requesting a leads report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_MOBILE_APPSList mobile apps associated with a Snapchat ad account by ID. The response may include pagination information.

Input Parameters

string
required
Ad Account ID to retrieve associated mobile apps for. Must be a valid UUID of an existing ad account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_OFFER_DISCLAIMERSList offer disclaimers associated with a Snapchat ad account. Results are paginated; use the cursor to request another page.

Input Parameters

integer
Maximum number of disclaimers to return in a single page (1-1000). Default is 50.
string
Pagination cursor pointing to a specific page of results. Use the value from the previous response’s next_link field.
string
required
Unique identifier of the ad account to retrieve offer disclaimers for (UUID format).

Output

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

string
Signal ID (e.g., Pixel ID) to get guidance for. Required when signal_type is specified.
string ("PIXEL")
Signal type for spend guidance.
string
required
Ad Account ID for which to retrieve spend guidance (UUID format).
string ("SWIPE_28DAY_VIEW_1DAY" | "SWIPE_7DAY")
Conversion window for spend guidance.
string ("PIXEL_PURCHASE" | "PIXEL_ADD_TO_CART" | "PIXEL_PAGE_VIEW" | "PIXEL_SIGNUP" | "LANDING_PAGE_VIEW" | "SWIPES" | "STORY_OPENS")
Optimization goal for spend guidance.

Output

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

string
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.
string
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.
string
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.
string ("TOTAL" | "LIFETIME" | "DAY" | "HOUR")
Time granularity for statistics.
string
required
Ad Account ID (UUID format) for which to retrieve statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_ADACCOUNTS_STATS_REPORTRetrieve the status and available download URL for an asynchronous Snapchat ad account stats report by report run ID.

Input Parameters

string
required
Ad account ID for which to retrieve the stats report (UUID format).
string
required
Unique identifier of the report run to retrieve. This ID is returned when requesting an async stats report.

Output

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

string
required
Unique identifier of the ad squad to retrieve (UUID format).
boolean
Include targeting V2 data in the response. Set to true to get detailed targeting information.

Output

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

string
required
Unique identifier of the ad squad to retrieve ad restrictions for (UUID format).

Output

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

string
required
Ad squad ID to retrieve audience size for. Must be a valid UUID of an existing ad squad.

Output

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

string
required
Ad Squad ID to retrieve stats report for (UUID format).
string
required
The identifier of the report to fetch, returned from the initial async report creation request. Format: ASYNC_STATS:{id}:{timestamp}:{uuid}

Output

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

string
Comma-separated list of metric fields to include in the response (e.g., ‘impressions,swipes,spend’). If not specified, returns all available metrics.
string
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
string
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad squad creation.
string
required
Unique identifier of the ad squad to retrieve statistics for (UUID format).
string ("TOTAL" | "DAY" | "HOUR")
Time granularity for statistics.

Output

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

string
required
Unique identifier of the ad squad to retrieve targeting specifications for (UUID format).

Output

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

boolean
Enable test mode to retrieve statistics from test ads. Set to true for test/sandbox environments.
string
required
Unique identifier of the ad to retrieve statistics for (UUID format).
string
Comma-separated list of metric fields to include in the response (e.g., ‘impressions,swipes,spend’). If not specified, returns all available metrics.
string
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
string
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad creation.
string ("TOTAL" | "DAY" | "HOUR")
Time granularity for statistics.

Output

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

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

string
required
Unique identifier of the billing center to retrieve (UUID format).

Output

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

string
required
Unique identifier of the campaign to retrieve (UUID format).

Output

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

integer
Maximum number of changelog records to retrieve per request. Defaults to 50.
string
required
Unique identifier of the campaign to retrieve changelog for (UUID format).

Output

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

array
required
List of campaign IDs to retrieve. Each ID should be a UUID format identifier.
string
required
Ad Account ID to fetch campaigns from (UUID format).

Output

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

string
Comma-separated list of metric fields to include in the response (e.g., ‘impressions,swipes,spend’). If not specified, returns all available metrics.
string
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
string
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from campaign creation.
string
required
Unique identifier of the campaign to retrieve statistics for (UUID format).
string ("DAY" | "HOUR")
Time granularity for statistics.

Output

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

string
required
Unique identifier of the catalog to retrieve (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_CATALOGS_PRODUCT_SETSList product sets within a Snapchat catalog for dynamic product ads, with optional page size and cursor.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
The unique identifier of the catalog to retrieve product sets from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_CREATIVERetrieve the current definition and review state of one Snapchat creative.

Input Parameters

string
required
Unique identifier of the creative to retrieve (UUID format).

Output

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

string
required
Unique identifier of the dynamic template to retrieve (UUID format).

Output

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

integer
Maximum number of changelog records to return. Use for pagination to manage large result sets.
string
required
Unique identifier of the dynamic template to retrieve changelogs for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_EVENT_DETAILSTool to retrieve event details by ID from Snapchat Marketing API. Use when you need to fetch detailed information about a specific event.

Input Parameters

string
required
The unique identifier for the Event Details entity (UUID format).

Output

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

string
required
Unique identifier of the funding source to retrieve (UUID format).

Output

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

string
required
Unique identifier of the interaction zone to retrieve (UUID format).

Output

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

string
required
Invoice ID (UUID format) to retrieve.
boolean
When set to true, includes the invoice_content attribute in the response containing Base64-encoded PDF content.
string
required
Ad Account ID (UUID format) for which to retrieve the invoice.

Output

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

string
required
Unique identifier of the media file to retrieve (UUID format).

Output

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

array
required
List of media IDs to retrieve. Each ID should be a UUID format identifier. Maximum 2,000 entries.
string
required
Ad Account ID to fetch media from (UUID format).

Output

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

string
Comma-separated list of metric fields to include in the response (e.g., ‘impressions,swipes,spend’). If not specified, returns default metrics (impressions, spend).
string
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Required when granularity is DAY.
string
required
Unique identifier of the media to retrieve statistics for (UUID format).
string
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Required when granularity is DAY.
string ("LIFETIME" | "DAY")
required
Time granularity for statistics breakdown. LIFETIME returns all-time aggregate stats, DAY returns daily breakdown (requires start_time and end_time).

Output

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

string
required
The unique identifier of the member to retrieve from the organization. Obtain this from the list members or create member actions.

Output

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

string
required
Unique identifier of the organization to retrieve (UUID format).

Output

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

integer
Maximum number of catalogs to return per page (default depends on API, typically 20-50).
string
Pagination cursor for retrieving the next page of results. Obtained from the ‘next_link’ in the previous response’s paging object.
string
required
Organization ID to retrieve catalogs for (UUID format).

Output

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

integer
Limit the number of results returned (between 50-1000)
string
Optional filter to retrieve apps for a specific Ad Account ID (UUID format)
string
required
The unique identifier for the organization (UUID format)

Output

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

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Organization ID to retrieve public profiles from (UUID format).

Output

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

string
required
Ad Account ID to retrieve pixels for. Must be a valid UUID of an existing ad account.

Output

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

string
required
Unique identifier of the product feed to retrieve (UUID format)

Output

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

string
required
The unique identifier of the product feed to retrieve uploads for (UUID format).

Output

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

string
required
The unique identifier of the product set to retrieve (UUID format)

Output

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

string
required
The unique identifier of the audience segment to retrieve.

Output

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

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

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

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

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

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

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

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

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

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘GB’, ‘CA’) to retrieve postal codes for

Output

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

string
required
Two-letter ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘CA’, ‘GB’) to retrieve regions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_TARGETING_GEO_US_POSTAL_CODERetrieve a page of US postal code targeting options from the Snapchat Marketing API, including geographic hierarchy data. Supports cursor pagination and a page size of 10 to 10,000.

Input Parameters

integer
Page size - the number of entries to retrieve in one page. Must be between 10 and 10000.
string
Pagination cursor for navigating through results. Omit or use empty string for the first page.

Output

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

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

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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_GET_TARGETING_INTERESTS_NLNRetrieve a page of Nielsen interest targeting options from Snapchat Marketing API for audience targeting in ad campaigns. Supports a page size and cursor for subsequent pages.

Input Parameters

integer
Maximum number of results per page. Default is 1000.
string
Pagination cursor from paging.next_link of previous response.

Output

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

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

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

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘GB’, ‘CA’) to retrieve metro areas for

Output

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

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

string ("iOS" | "ANDROID")
required
Operating system type to retrieve versions for (iOS or ANDROID)

Output

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

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

integer
Number of results to return. Must be between 50 and 1000. If not specified, API default is used.
string
required
ISO ALPHA-2 country code in lowercase (e.g., ‘us’, ‘gb’, ‘ca’). Required to retrieve shopper segments for the specified country.

Output

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

integer
Page size for results. Must be between 50 and 1000
boolean
Housing, Credit, Employment safe targeting flag. Set to true for HEC-compliant targeting
string
ISO ALPHA-2 Country Code (lowercase) for target country (e.g., ‘us’, ‘gb’, ‘ca’)

Output

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

string
ISO ALPHA-2 country code (uppercase, e.g., ‘US’, ‘GB’, ‘CA’) to filter targeting options by country. Required parameter.
boolean
Whether to enable international VAC (Video Ad Comparison) options. Set to true to include international VAC targeting options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_ACCOUNT_ROLESList role assignments for a Snapchat ad account. Results are returned one page at a time, with a next link when more results are available.

Input Parameters

integer
Controls pagination size. Must be between 50 and 1000 if specified.
string
required
The Ad Account ID for which to retrieve all roles (UUID format).

Output

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

string
required
Unique identifier of the organization to retrieve ad accounts for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_ADS_BY_ACCOUNTList ads associated with a Snapchat ad account. Results are paginated, with an optional limit and cursor for retrieving further pages.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Unique identifier of the ad account to retrieve ads for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_ADS_BY_AD_SQUADList ads associated with a Snapchat ad squad. Results are paginated, with an optional limit and cursor for retrieving further pages.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Unique identifier of the ad squad to retrieve ads for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_ADS_BY_CAMPAIGNList ads associated with a Snapchat campaign. Results are paginated, with an optional limit and cursor for retrieving further pages.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Unique identifier of the campaign to retrieve ads for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_AD_SQUADSList ad squads belonging to a Snapchat campaign. Results are returned one page at a time, with pagination information for fetching further pages.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Campaign ID to retrieve ad squads for. Must be a valid UUID of an existing campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_BILLING_CENTERSList billing centers for a Snapchat Ads organization. The response may include pagination information for additional results.

Input Parameters

string
required
Unique identifier of the organization to retrieve billing centers for (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_CAMPAIGNSList campaigns for a Snapchat Ads account, with optional sorting and pagination. The response may include information for retrieving additional pages.

Input Parameters

string ("updated_at-desc" | "created_at-desc")
Sort order for campaigns list.
integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Ad Account ID to retrieve campaigns from (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_CATALOG_ROLESList role assignments for a Snapchat catalog to view member access permissions. The response may include a link to additional results.

Input Parameters

integer
Controls pagination size. Must be between 50 and 1000 if specified.
string
required
The Catalog ID for which to retrieve all roles (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_CREATIVESList creative assets for a Snapchat ad account, with optional page size and cursor.

Input Parameters

integer
Maximum number of results per page. Range: 50-1000.
string
Pagination cursor from paging.next_link of previous response.
string
required
Ad Account ID to retrieve creatives from (UUID format). This is the unique identifier of your Snapchat ad account.

Output

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

string
required
Organization ID to retrieve funding sources for (UUID format).

Output

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

string
required
Ad Account ID (UUID format) for which to retrieve all invoices.

Output

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

string ("created_at-asc" | "created_at-desc")
Sort order for media listing.
string ("VIDEO" | "IMAGE" | "LENS_PACKAGE" | "PLAYABLE")
Media type filter for listing.
string
required
Ad Account ID (UUID format) for which to retrieve all media files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_MEMBER_ROLESList roles assigned to a Snapchat member across organizations, ad accounts, and catalogs. Returns one page of results with pagination information when available.

Input Parameters

integer
Maximum number of roles to return per page. Must be between 50 and 1000. Use for pagination control.
string
required
The unique identifier of the member whose roles you want to retrieve. This includes roles within organizations, ad accounts, and catalogs.

Output

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

string
required
Unique identifier of the organization to retrieve members from (UUID format).

Output

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

boolean
Include ad accounts in response. When set to true, the response will include detailed information about ad accounts associated with each organization.

Output

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

string
required
The ID of the organization to retrieve pixels from (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_LIST_ORG_ROLESList role assignments for a Snapchat organization to view member access permissions. Returns one page of results with pagination information when available.

Input Parameters

integer
Controls pagination size. Must be between 50 and 1000 if specified.
string
required
The Organization ID for which to retrieve all roles (UUID format).

Output

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

string
required
Ad Account ID to retrieve associated phone numbers for. Must be a valid UUID of an existing ad account.

Output

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

string
required
Unique identifier of the ad account to retrieve segments for (UUID format).

Output

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

string
Pagination token for retrieving subsequent result sets. Use the cursor from the previous response’s paging.next_link to fetch the next page.

Output

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

string
End time of transactions in UTC format (yyyy-mm-ddThh:mm:ss). Filters transactions created on or before this time.
string
Start time of transactions in UTC format (yyyy-mm-ddThh:mm:ss). Filters transactions created on or after this time.
string
Ad Account ID to filter transactions for a specific ad account (UUID format).
string
required
Unique identifier of the organization to retrieve transactions for (UUID format).

Output

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

integer
Maximum number of results to return
string
Pagination cursor for retrieving next page of results
string
required
Name of the creator to search for

Output

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

integer
Number of products to return per page. Must be between 50 and 1000. If not specified, the API default will be used.
object
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.
string
required
The unique identifier of the catalog to search. This is the Catalog ID that you want to query for products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_SEARCH_CATALOGS_HOTELSSearch for hotels in a Snapchat catalog using optional filters and a page size. Find hotels by name, price, rating, location, or other attributes; the response may include paging information.

Input Parameters

integer
Number of results to return per page. Must be between 50 and 1000.
object
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.
string
required
The identifier for the catalog to search in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_UPDATE_AD_ACCOUNTUpdate ad accounts within a Snapchat organization, including settings such as name, status, billing, or spend caps. The request requires account and organization IDs and several account details; other fields are optional.

Input Parameters

array
required
List of ad accounts to update (typically one account per request)
string
required
Organization ID that owns the ad account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_UPDATE_ADSReplace complete Snapchat ad objects. This PUT operation is not a partial update. Omitting attributes that have default values resets them to those defaults, including tracking configuration. Retrieve current ad values first and include every value that must be preserved.

Input Parameters

array
required
One or more complete ad objects. PUT replaces each ad’s editable configuration; omitted attributes with defaults are reset, so retrieve current values first and include everything that must be preserved.
string
required
ID of the ad squad containing every ad in the batch.

Output

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

array
required
List of ad squads to update. Each ad squad must include an ‘id’ field. At least one ad squad is required.
string
required
Campaign ID that the ad squad belongs to. Must be a valid UUID of an existing campaign.

Output

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

array
required
List of billing centers to update (one or more)
string
required
The organization ID that owns the billing center(s) to update

Output

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

string
Updated campaign name (max 375 characters). If not provided, the existing name is retained.
string ("ACTIVE" | "PAUSED")
Campaign status values.
string
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.
string ("AUCTION" | "RESERVED")
Campaign buy model values.
string ("AWARENESS" | "APP_INSTALLS" | "APP_VISITS" | "DRIVE_TRAFFIC" | "ENGAGEMENT" | "LEAD_GENERATION" | "PROMOTE_PLACES" | "VIDEO_VIEWS" | "BRAND_AWARENESS" | "WEBSITE_CONVERSIONS")
Campaign objective values.
string
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.
string
required
Unique identifier of the campaign to update (UUID format).
string
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.
string
required
Ad Account ID where the campaign exists. This is a UUID format identifier.
string
Updated creation state of the campaign. Set to ‘PUBLISHED’ if needed. If not provided, the existing creation_state is retained.
object
Measurement specification for app-related campaigns.
object
Shared properties for Smart Budgets campaigns.
integer
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.
object
Objective V2 properties for campaign.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_UPDATE_SEGMENTUpdate existing audience segments in a Snapchat ad account. Each segment update requires its ID, name, and retention period; a description can also be supplied.

Input Parameters

array
required
List of audience segments to update. Only name, description, and retention_in_days can be modified.
string
required
The ad account ID that owns the segments to update.

Output

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

object
The file chunk to upload. Required for ADD action.
string ("INIT" | "ADD" | "FINALIZE")
required
Action type for multipart upload. INIT starts a new upload session, ADD uploads a file chunk, FINALIZE completes the upload.
string
Relative endpoint path for uploading file chunks, returned from INIT. Required for ADD action.
string
required
Unique identifier of the media file to upload (UUID format). This media should be created first using Create Media action.
string
Name of the file being uploaded. Required for INIT action.
integer
Total file size in bytes. Required for INIT action. Maximum 1GB (1073741824 bytes).
string
Upload session identifier returned from INIT. Required for ADD and FINALIZE actions.
integer
The part number of the chunk being uploaded (0-indexed). Required for ADD action.
string
Relative endpoint path for completing the upload, returned from INIT. Required for FINALIZE action.
integer
Expected number of file chunks. Required for INIT action. Each part can be up to 32MB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNAPCHAT_VALIDATE_CONVERSION_EVENTSubmit conversion events for a Snap Pixel to Snapchat’s validation endpoint to test event data before sending it to the Conversions API. The result can report success for every submitted event; other validation details depend on Snapchat’s response.

Input Parameters

array
required
List of conversion events to validate (typically 1-100 events per request)
string
required
Snap Pixel ID to validate events for. This must be a valid pixel ID from your Snapchat ad account.

Output

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