Snapchat

snapchat

Snapchat Marketing API and Ads Manager integration for creating and managing ad campaigns, analyzing performance metrics, and accessing business accounts.

Marketing Social Media Marketing Web del proveedor

Acciones

140

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (140)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Users to SegmentSNAPCHAT_ADD_SEGMENT_USERSAcción

Tool to add users to a Snapchat audience segment. Use when you need to populate a segment with user identifiers (email, phone, or mobile ad IDs). All identifiers must be normalized and SHA-256 hashed before submission. Maximum 100,000 identifiers per request.

Parámetros de entrada

usersobject[]Obligatorio
Array of user data objects. Each object contains a schema type and corresponding hashed identifiers. All identifiers must be normalized and SHA-256 hashed. Maximum 100,000 identifiers per request.
segment_idstringObligatorio
The ID of the segment to add users to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy Media Between Ad AccountsSNAPCHAT_COPY_MEDIAAcción

Copies media from one Snapchat ad account to another. Use this when you need to duplicate media assets (images, videos) across different ad accounts for campaign management or sharing creative assets.

Parámetros de entrada

media_copyobject[]Obligatorio
List of media items to copy, each specifying source media ID and source ad account ID
destination_ad_account_idstringObligatorio
The destination ad account ID where media will be copied to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Account RoleSNAPCHAT_CREATE_ACCOUNT_ROLEAcción

Tool to create new roles for members in a Snapchat Ad Account. Use when you need to grant access permissions to members. Note: Member must already have an Organization-level 'member' role before assigning Ad Account roles.

Parámetros de entrada

rolesobject[]Obligatorio
List of role assignments to create. Each role assignment specifies a member_id, ad_account_id, and role type.
ad_account_idstringObligatorio
The Ad Account ID where roles will be created

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Ad AccountSNAPCHAT_CREATE_AD_ACCOUNTAcción

Tool to create a new ad account within a Snapchat organization. Use when setting up a new advertising account for campaign management. Requires organization_id, billing center, and advertiser details. Can create test accounts for development purposes.

Parámetros de entrada

adaccountsobject[]Obligatorio
List of ad accounts to create (typically one account per request)
organization_idstringObligatorio
Organization ID where the ad account will be created

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Estimate Ad Account Audience SizeSNAPCHAT_CREATE_ADACCOUNTS_AUDIENCE_SIZE_V2Acción

Tool to estimate audience size for Snapchat ad campaigns. Use when you need to determine potential reach for specific targeting criteria before creating ad campaigns.

Parámetros de entrada

namestring
Name for the audience size estimation (optional).
typestring
Ad type (e.g., 'SNAP_ADS'). Optional parameter.
statusstring
Status (e.g., 'ACTIVE'). Optional parameter.
auto_bidboolean
Whether auto-bidding is enabled. Optional parameter.
bid_microinteger
Bid amount in micro units (1 micro = 0.000001). Optional parameter.
placementstring
Placement type (e.g., 'CONTENT'). Optional parameter.
targetingobjectObligatorio
Targeting specifications including geographic and demographic criteria. At least one targeting criterion must be specified.
ad_account_idstringObligatorio
The Ad Account identifier (UUID format).
optimization_goalstring
Optimization goal for the ad campaign (e.g., 'APP_INSTALLS', 'SWIPES', 'PIXEL_PAGE_VIEW', 'IMPRESSIONS'). Optional parameter.
daily_budget_microinteger
Daily budget in micro units (1 micro = 0.000001). Optional parameter.
delivery_constraintstring
Budget constraint type (e.g., 'DAILY_BUDGET'). Optional parameter.
included_content_typesstring[]
Content type filters. Optional parameter.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ad account creative elementsSNAPCHAT_CREATE_ADACCOUNTS_CREATIVE_ELEMENTSAcción

Tool to create new creative elements in a Snapchat ad account. Use when you need to create dynamic ad elements like buttons for product catalogs or dynamic collections. Once created, creative elements cannot be updated and are immutable.

Parámetros de entrada

idstringObligatorio
Ad account ID where the creative elements will be created
creative_elementsobject[]Obligatorio
Array of creative elements to create. At least one element is required

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Ad Account Dynamic TemplatesSNAPCHAT_CREATE_ADACCOUNTS_DYNAMIC_TEMPLATESAcción

Tool to create new dynamic templates for product ads in a Snapchat ad account. Use when you need to set up templates that define how product information from a catalog will be displayed in dynamic product ads.

Parámetros de entrada

adaccount_idstringObligatorio
ID of the ad account to create dynamic templates for
dynamic_templatesobject[]Obligatorio
List of dynamic templates to create

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Ad Account Event DetailsSNAPCHAT_CREATE_ADACCOUNTS_EVENT_DETAILSAcción

Tool to create event details for a Snapchat ad account. Use when scheduling advertising events or campaigns. Event details are immutable after creation and cannot be edited. Ensure the event is not referenced by active Reminder Creatives before deletion.

Parámetros de entrada

ad_account_idstringObligatorio
UUID of the ad account where the event will be created. This is the path parameter.
event_detailsobject[]Obligatorio
Array of event details to create. Each event is immutable after creation and cannot be edited.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Ad Account Interaction ZonesSNAPCHAT_CREATE_ADACCOUNTS_INTERACTION_ZONESAcción

Create new interaction zones for an ad account in Snapchat Marketing API. Interaction zones are used for dynamic collections ads and contain 2-4 creative elements with matching interaction types.

Parámetros de entrada

ad_account_idstringObligatorio
The ID of the ad account to create interaction zones for
interaction_zonesobject[]Obligatorio
Array of interaction zone configurations to create

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Offer DisclaimersSNAPCHAT_CREATE_ADACCOUNTS_OFFER_DISCLAIMERSAcción

Tool to create new offer disclaimers for a Snapchat ad account. Use when you need to add legal disclaimers to offers in ads. STATIC disclaimers display custom text directly, while DYNAMIC disclaimers pull content from product catalogs.

Parámetros de entrada

idstringObligatorio
UUID of the ad account to create offer disclaimers for. This is the path parameter in the URL.
offer_disclaimersobject[]Obligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ad account reserved forecastingSNAPCHAT_CREATE_ADACCOUNTS_RESERVED_FORECASTINGAcción

Tool to create a reserved forecasting for Snapchat ad accounts. Use when you need to forecast reach and frequency for planned campaigns with specific targeting and frequency caps. Requires minimum reach of 500,000 unique users and booking window between 12 hours and 365 days.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Adaccounts Targeting InsightsSNAPCHAT_CREATE_ADACCOUNTS_TARGETING_INSIGHTSAcción

Tool to generate targeting insights for a Snapchat ad account. Use when you need to analyze and compare audience demographics, size, and characteristics between a base targeting spec and a target targeting spec. Returns detailed breakdowns including age groups, gender, languages, geographic distribution, and audience size estimates.

Parámetros de entrada

idstringObligatorio
The Ad Account ID to use for the targeting insights request
base_specobjectObligatorio
Base targeting specification to compare against. Defines the reference audience for comparison.
targeting_specobjectObligatorio
Target targeting specification to analyze. Defines the target audience to get insights for.
dimension_categorystringenum
Dimension category filter for targeting insights output.
demogeodeviceinterestengagementaggregated

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Ad SquadSNAPCHAT_CREATE_AD_SQUADAcción

Tool to create a new ad squad within a campaign. Use when setting up ad delivery targeting, budgets, and placements for a Snapchat campaign.

Parámetros de entrada

adsquadsobject[]Obligatorio
List of ad squads to create. At least one ad squad is required.
campaign_idstringObligatorio
Campaign ID to create the ad squad under. Must be a valid UUID of an existing campaign.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Billing CenterSNAPCHAT_CREATE_BILLING_CENTERAcción

Tool to create one or more billing centers for a Snapchat Ads organization. Use when you need to set up new billing entities for managing ad spend and invoicing. Requires organization ID, billing center name, email address, and complete billing address information.

Parámetros de entrada

billingcentersobject[]Obligatorio
List of billing centers to create (one or more)
organization_idstringObligatorio
The organization ID to create billing center(s) under

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CampaignSNAPCHAT_CREATE_CAMPAIGNAcción

Tool to create a new advertising campaign in Snapchat Marketing API. Use when you need to set up a new campaign with specified budget, timing, and objectives.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Catalog RoleSNAPCHAT_CREATE_CATALOG_ROLEAcción

Tool to create new roles for a catalog in Snapchat Marketing API. Use when you need to assign catalog permissions to members. Members must already have the 'member' organizational role before receiving catalog roles.

Parámetros de entrada

rolesobject[]Obligatorio
Array of role objects to create. Each role assigns permissions to a member for the specified catalog.
catalog_idstringObligatorio
The Catalog ID where the role will be created (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Catalog FacetsSNAPCHAT_CREATE_CATALOGS_FACETSAcción

Tool to create catalog facets for grouping products by attributes like BRAND, COLOR, or AVAILABILITY. Use when you need to analyze product distribution across different attributes in a catalog. Returns grouped counts for specified product properties with optional filtering support.

Parámetros de entrada

limitinteger
Integer between 1-50 specifying the number of groupings returned per facet
facetsobject[]Obligatorio
Array of facet specifications defining which attributes to group products by
filterobject
Optional filter using property names as keys with operators (EQ, NEQ, GT, GTE, LT, LTE, CONTAINS). Use AND/OR for compound queries. Example: {'AVAILABILITY': {'EQ': 'IN_STOCK'}} or {'AND': [{'GENDER': {'EQ': 'UNISEX'}}, {'AVAILABILITY': {'EQ': 'IN_STOCK'}}]}
catalog_idstringObligatorio
The unique identifier for the catalog

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Catalog FlightsSNAPCHAT_CREATE_CATALOGS_FLIGHTS_SEARCHAcción

Tool to search for flights within a Snapchat catalog using optional filters. Use when you need to retrieve and filter flight listings from a dynamic product ads catalog.

Parámetros de entrada

limitinteger
Number of flight results per page. Must be between 50 and 1000.
filterobject
Filter object to narrow search results using flight properties. Supports logical operators (AND/OR) and comparison operators (EQ, NEQ, GT, GTE, LT, LTE, CONTAINS, etc.). Filterable properties include: ID, ORIGIN_AIRPORT, DESTINATION_AIRPORT, ORIGIN_CITY, DESTINATION_CITY, PRICE_AMOUNT, CUSTOM_LABEL_0 through CUSTOM_LABEL_4, ITEM_SET_ID, PRODUCT_STATUS, and ELIGIBLE_AD_TYPE.
catalog_idstringObligatorio
The unique identifier for the catalog to search within.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Catalogs Product FeedSNAPCHAT_CREATE_CATALOGS_PRODUCT_FEEDSAcción

Tool to create a new product feed under a specified catalog. Use when setting up product data synchronization for dynamic product ads. Note: Currently only one product feed can exist per catalog.

Parámetros de entrada

namestringObligatorio
Name of the product feed (maximum 375 characters)
statusstringenum
Enumeration of product feed status values
ACTIVEINACTIVE
scheduleobject
Schedule configuration for automated feed fetching
feed_typestringObligatorioenum
Type of product feed: PRIMARY (main feed) or SUPPLEMENTAL (additional data feed). Note: Only one product feed can exist per catalog.
PRIMARYSUPPLEMENTAL
catalog_idstringObligatorio
The unique identifier of the catalog under which to create the product feed
parent_feed_idstring
Parent feed identifier. Required only when feed_type is SUPPLEMENTAL.
default_currencystringObligatorio
Three-letter ISO 4217 currency code (e.g., USD, EUR, GBP)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Catalog Product SetSNAPCHAT_CREATE_CATALOGS_PRODUCT_SETSAcción

Tool to create a new product set within a Snapchat catalog. Use when you need to define product groups using filters for dynamic product ads.

Parámetros de entrada

namestringObligatorio
Name of the product set
catalog_idstringObligatorio
The unique identifier of the catalog to create the product set in
descriptionstring
Description of the product set

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create MediaSNAPCHAT_CREATE_MEDIAAcción

Tool to create a new media file in a Snapchat ad account. Use when you need to register media assets (images, videos, lenses, or playable ads) before uploading content or associating with ad creatives.

Parámetros de entrada

mediaobject[]Obligatorio
List of media items to create. Each item represents a media file that will be created in the ad account.
ad_account_idstringObligatorio
Ad Account ID where the media will be created. This is the account identifier from your Snapchat Ads account.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Organizations CatalogsSNAPCHAT_CREATE_ORGANIZATIONS_CATALOGSAcción

Tool to create new product catalogs within a Snapchat organization for Dynamic Product Ads. Use when you need to set up catalogs for automated ad generation based on product data feeds. Requires Organization Admin permission. Maximum 200 catalogs per organization, 10 per batch.

Parámetros de entrada

catalogsobject[]Obligatorio
Array of catalog configurations to create (minimum 1, maximum 10 per batch request)
organization_idstringObligatorio
Organization ID (path parameter) - the organization where catalogs will be created

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Organization RoleSNAPCHAT_CREATE_ORG_ROLEAcción

Tool to create a new role for an organization in Snapchat Marketing API. Use when you need to assign roles to organization members after they have been invited. Each member must be assigned one organization-level role type.

Parámetros de entrada

rolesobject[]Obligatorio
List of roles to create for organization members. Each member must be assigned one organization-level role type.
organization_idstringObligatorio
UUID of the organization where the role will be created. This is used in the URL path.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Audience SegmentSNAPCHAT_CREATE_SEGMENTAcción

Tool to create new audience segments (customer lists or lookalikes) in Snapchat Ads. Use when you need to create targeted audience segments for ad campaigns. Initial status returns as PENDING and transitions occur after processing. Note: An ad account can only have a maximum of 1000 customer list segments.

Parámetros de entrada

segmentsobject[]Obligatorio
List of audience segments to create. Note: An ad account can have a maximum of 1000 customer list segments.
ad_account_idstringObligatorio
The ad account ID to create segments in.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Offer DisclaimerSNAPCHAT_DELETE_ADACCOUNTS_OFFER_DISCLAIMERSAcción

Tool to delete an offer disclaimer from a Snapchat ad account. Use when you need to remove an offer disclaimer that is no longer needed or was created in error.

Parámetros de entrada

ad_account_idstringObligatorio
UUID of the ad account that owns the offer disclaimer.
offer_disclaimer_idstringObligatorio
UUID of the offer disclaimer to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Ad SquadSNAPCHAT_DELETE_ADSQUADSAcción

Tool to permanently delete an ad squad from Snapchat Marketing API. Use when you need to remove an ad squad that is no longer needed. This operation cannot be undone.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete All Segment UsersSNAPCHAT_DELETE_ALL_SEGMENT_USERSAcción

Tool to remove all users from a Snapchat audience segment. Use when you need to clear all users from a Customer List segment. Returns the updated segment with approximate_number_users set to 0.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CampaignSNAPCHAT_DELETE_CAMPAIGNAcción

Tool to delete a campaign from Snapchat Marketing API. Use when you need to permanently remove a campaign from your Snapchat Ads account.

Parámetros de entrada

campaign_idstringObligatorio
The unique identifier of the campaign to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CatalogSNAPCHAT_DELETE_CATALOGSAcción

Tool to delete a catalog by ID from Snapchat Marketing API. Use when you need to permanently remove a catalog. This is a destructive operation that cannot be undone.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Event DetailsSNAPCHAT_DELETE_EVENT_DETAILSAcción

Tool to delete event details from Snapchat Marketing API. Use when you need to remove an Event Details entity. Use with caution as there is no way to reinstate a deleted entity.

Parámetros de entrada

event_details_idstringObligatorio
The ID of the Event Details entity to be deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete MemberSNAPCHAT_DELETE_MEMBERAcción

Tool to remove a member from an organization in Snapchat Marketing API. Use when you need to revoke access for a member.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete product feedSNAPCHAT_DELETE_PRODUCT_FEEDSAcción

Tool to permanently delete a product feed from Snapchat Ads. Use when you need to remove a product catalog feed. Requires Organization Admin permission. This action is irreversible.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete RoleSNAPCHAT_DELETE_ROLEAcción

Tool to delete a role from Snapchat Marketing API. Use when you need to remove a role from an Organisation, Catalog or Ad Account. If deleting all of a Member's roles, consider also deleting the Member entity from the Organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Audience SegmentSNAPCHAT_DELETE_SEGMENTAcción

Tool to delete an audience segment from Snapchat. Use when you need to permanently remove an audience segment. WARNING: This operation is irreversible - deleted segments cannot be retrieved.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Users from SegmentSNAPCHAT_DELETE_SEGMENT_USERSAcción

Tool to remove specific users from a Snapchat audience segment. Use when you need to delete certain user identifiers (email, phone, or mobile ad IDs) from a Customer List segment. All identifiers must be normalized and SHA-256 hashed before submission. Maximum 100,000 identifiers per request.

Parámetros de entrada

usersobject[]Obligatorio
Array of user data objects. Each object contains a schema type and corresponding hashed identifiers to remove. All identifiers must be normalized and SHA-256 hashed. Maximum 100,000 identifiers per request.
segment_idstringObligatorio
The ID of the segment to delete users from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad AccountSNAPCHAT_GET_AD_ACCOUNTAcción

Tool to retrieve a specific ad account by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Ad SquadsSNAPCHAT_GET_ADACCOUNTS_ADSQUADSAcción

Tool to retrieve all ad squads in an ad account by ID. Use when you need to list or fetch ad squads for a specific Snapchat ad account.

Parámetros de entrada

ad_account_idstringObligatorio
Ad Account ID to retrieve ad squads for. Must be a valid UUID of an existing ad account.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Ad Squad UI Render DataSNAPCHAT_GET_ADACCOUNTS_AD_SQUAD_UI_RENDER_DATAAcción

Tool to retrieve ad squad UI render data for a Snapchat ad account. Use when you need to fetch UI render data objects that determine available optimization goals together with campaign objectives. The conversion_location field indicates where conversions occur (APP, CALL, LEAD_FORM, PUBLIC_PROFILE, TEXT, or WEB).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Dynamic TemplatesSNAPCHAT_GET_ADACCOUNTS_DYNAMIC_TEMPLATESAcción

Tool to retrieve dynamic templates for a Snapchat ad account. Use when you need to list or fetch dynamic templates used for dynamic product ads in a specific ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Event DetailsSNAPCHAT_GET_ADACCOUNTS_EVENT_DETAILSAcción

Tool to retrieve all Event Details entities for a specific ad account. Use when you need to list event details associated with an ad account for reminder creative campaigns.

Parámetros de entrada

ad_account_idstringObligatorio
The Ad Account identifier where event details are stored

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Interaction ZonesSNAPCHAT_GET_ADACCOUNTS_INTERACTION_ZONESAcción

Tool to retrieve interaction zones for an ad account from Snapchat Marketing API. Use when you need to list all interaction zones configured for a specific ad account.

Parámetros de entrada

ad_account_idstringObligatorio
The ID of the ad account to retrieve interaction zones for (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Lead Generation FormsSNAPCHAT_GET_AD_ACCOUNTS_LEAD_GENERATION_FORMSAcción

Tool to retrieve all lead generation forms for a specific ad account from Snapchat Marketing API. Use when you need to list or fetch all lead gen forms associated with an advertising account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Leads ReportSNAPCHAT_GET_ADACCOUNTS_LEADS_REPORTAcción

Tool to retrieve ad account leads report by ID from Snapchat Marketing API. Use when you need to fetch lead generation data for a specific ad account and report run.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Mobile AppsSNAPCHAT_GET_ADACCOUNTS_MOBILE_APPSAcción

Tool to retrieve all mobile apps associated with a Snapchat ad account by ID. Use when you need to list or fetch mobile apps for a specific ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Offer DisclaimersSNAPCHAT_GET_ADACCOUNTS_OFFER_DISCLAIMERSAcción

Tool to retrieve all offer disclaimers for a specific ad account from Snapchat Marketing API. Use when you need to list or fetch legal disclaimers associated with an advertising account's offers.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Spend GuidanceSNAPCHAT_GET_ADACCOUNTS_SPEND_GUIDANCEAcción

Tool to retrieve spend guidance for an ad account from Snapchat Marketing API. Use when you need bid and budget recommendations for specific signal types and optimization goals.

Parámetros de entrada

signal_idstring
Signal ID (e.g., Pixel ID) to get guidance for. Required when signal_type is specified.
signal_typestringenum
Signal type for spend guidance.
PIXEL
ad_account_idstringObligatorio
Ad Account ID for which to retrieve spend guidance (UUID format).
conversion_windowstringenum
Conversion window for spend guidance.
SWIPE_28DAY_VIEW_1DAYSWIPE_7DAY
optimization_goalstringenum
Optimization goal for spend guidance.
PIXEL_PURCHASEPIXEL_ADD_TO_CARTPIXEL_PAGE_VIEWPIXEL_SIGNUPLANDING_PAGE_VIEWSWIPESSTORY_OPENS

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account StatsSNAPCHAT_GET_AD_ACCOUNTS_STATSAcción

Tool to retrieve ad account statistics from Snapchat Marketing API. Use when you need performance metrics like impressions, swipes, spend, or video views for an ad account over a specified time period.

Parámetros de entrada

fieldsstring
Comma-separated list of metric fields to retrieve (e.g., 'impressions,swipes,spend'). Common metrics include: impressions, swipes, spend, screen_time_millis, quartile_1, quartile_2, quartile_3, view_completion, video_views, uniques, frequency. If not provided, returns default metrics.
end_timestring
End time for the stats query in ISO 8601 format with timezone offset (e.g., 2024-01-08T00:00:00-08:00). Must end at the beginning of an hour (minutes and seconds should be 00:00). If not provided, defaults to current time.
start_timestring
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.
granularitystringenum
Time granularity for statistics.
TOTALLIFETIMEDAYHOUR
ad_account_idstringObligatorio
Ad Account ID (UUID format) for which to retrieve statistics.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account Stats ReportSNAPCHAT_GET_ADACCOUNTS_STATS_REPORTAcción

Tool to retrieve ad account stats report by ID from Snapchat Marketing API. Use when you need to check the status of an async stats report or download a completed report.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad SquadSNAPCHAT_GET_AD_SQUADAcción

Tool to retrieve a specific ad squad by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing ad squad including targeting, budget, and placement settings.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Squad RestrictionsSNAPCHAT_GET_AD_SQUAD_RESTRICTIONSAcción

Tool to retrieve ad type restrictions for a specific ad squad from Snapchat Marketing API. Use when you need to see which ad types are currently present in an ad squad and their counts.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Squad Audience SizeSNAPCHAT_GET_ADSQUADS_AUDIENCE_SIZE_V2Acción

Tool to retrieve estimated audience size for a specific ad squad by ID. Use when you need to check the potential reach of an existing ad squad's targeting configuration.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Squad Stats ReportSNAPCHAT_GET_ADSQUADS_STATS_REPORTAcción

Tool to retrieve adsquads stats report by ID from Snapchat Marketing API. Use when checking the status of an async report or getting the download URL for a completed stats report.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Squad StatsSNAPCHAT_GET_AD_SQUAD_STATSAcción

Tool to retrieve performance statistics for a specific ad squad from Snapchat Marketing API. Use when you need to analyze ad squad performance metrics such as impressions, swipes, conversions, and spend.

Parámetros de entrada

fieldsstring
Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics.
end_timestring
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
start_timestring
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad squad creation.
ad_squad_idstringObligatorio
Unique identifier of the ad squad to retrieve statistics for (UUID format).
granularitystringenum
Time granularity for statistics.
TOTALDAYHOUR

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Squad TargetingSNAPCHAT_GET_AD_SQUAD_TARGETINGAcción

Tool to retrieve targeting specifications for a specific ad squad from Snapchat Marketing API. Use when you need to fetch detailed targeting criteria for an existing ad squad.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad StatsSNAPCHAT_GET_AD_STATSAcción

Tool to retrieve performance statistics for a specific ad from Snapchat Marketing API. Use when you need to analyze ad performance metrics such as impressions, swipes, conversions, and spend.

Parámetros de entrada

testboolean
Enable test mode to retrieve statistics from test ads. Set to true for test/sandbox environments.
ad_idstringObligatorio
Unique identifier of the ad to retrieve statistics for (UUID format).
fieldsstring
Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics.
end_timestring
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
start_timestring
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from ad creation.
granularitystringenum
Time granularity for statistics.
TOTALDAYHOUR

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Authenticated UserSNAPCHAT_GET_AUTHENTICATED_USERAcción

Tool to retrieve information about the authenticated user from Snapchat Marketing API. Use when you need to fetch the current user's ID, email, display name, organization membership, or Snapchat username.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Billing CenterSNAPCHAT_GET_BILLING_CENTERAcción

Tool to retrieve a specific billing center by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing billing center.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CampaignSNAPCHAT_GET_CAMPAIGNAcción

Tool to retrieve a specific campaign by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing campaign.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaign ChangelogSNAPCHAT_GET_CAMPAIGN_CHANGELOGAcción

Tool to retrieve changelog (audit log) for a campaign from Snapchat Marketing API. Use when you need to track changes made to a campaign, including who made the changes and what was modified. Note: changelogs are only available from July 16, 2019 onwards.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaigns by IDsSNAPCHAT_GET_CAMPAIGNS_BY_IDSAcción

Tool to fetch multiple campaigns by their IDs from Snapchat Marketing API. Use when you need to retrieve detailed information about specific campaigns in bulk.

Parámetros de entrada

entity_idsobject[]Obligatorio
List of campaign IDs to retrieve. Each ID should be a UUID format identifier.
ad_account_idstringObligatorio
Ad Account ID to fetch campaigns from (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaign StatsSNAPCHAT_GET_CAMPAIGN_STATSAcción

Tool to retrieve performance statistics for a specific campaign from Snapchat Marketing API. Use when you need to analyze campaign performance metrics such as impressions, swipes, conversions, and spend.

Parámetros de entrada

fieldsstring
Comma-separated list of metric fields to include in the response (e.g., 'impressions,swipes,spend'). If not specified, returns all available metrics.
end_timestring
End time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats up to current time.
start_timestring
Start time for statistics range in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). If not specified, returns stats from campaign creation.
campaign_idstringObligatorio
Unique identifier of the campaign to retrieve statistics for (UUID format).
granularitystringenum
Time granularity for statistics.
DAYHOUR

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CatalogSNAPCHAT_GET_CATALOGSAcción

Tool to retrieve a specific catalog by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing catalog including its vertical, event sources, and product set details.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Catalog Product SetsSNAPCHAT_GET_CATALOGS_PRODUCT_SETSAcción

Tool to retrieve all product sets from a Snapchat catalog. Use when you need to list or view product sets within a specific catalog for dynamic product ads.

Parámetros de entrada

catalog_idstringObligatorio
The unique identifier of the catalog to retrieve product sets from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dynamic TemplateSNAPCHAT_GET_DYNAMIC_TEMPLATEAcción

Tool to retrieve a specific dynamic template by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing dynamic template used for dynamic product ads.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dynamic Templates External ChangelogsSNAPCHAT_GET_DYNAMIC_TEMPLATES_EXTERNAL_CHANGELOGSAcción

Tool to retrieve external changelogs for a dynamic template from Snapchat Marketing API. Use when you need to track modification history and audit changes made to a dynamic template. Note: changelogs are only available from July 16, 2019 onwards.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Event DetailsSNAPCHAT_GET_EVENT_DETAILSAcción

Tool to retrieve event details by ID from Snapchat Marketing API. Use when you need to fetch detailed information about a specific event.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Funding SourceSNAPCHAT_GET_FUNDING_SOURCEAcción

Tool to retrieve a specific funding source by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about payment methods like credit cards, PayPal accounts, or lines of credit.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Interaction ZoneSNAPCHAT_GET_INTERACTION_ZONEAcción

Tool to retrieve a specific interaction zone by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing interaction zone including its creative elements and render type.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get InvoiceSNAPCHAT_GET_INVOICEAcción

Tool to retrieve a specific invoice by its ID from Snapchat Marketing API. Use when you need to fetch detailed billing information including amounts, due dates, and optionally PDF content for a specific invoice.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MediaSNAPCHAT_GET_MEDIAAcción

Tool to retrieve a specific media file by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing media asset.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Media by IDsSNAPCHAT_GET_MEDIA_BY_IDSAcción

Tool to fetch multiple media items by their IDs from Snapchat Marketing API. Use when you need to retrieve detailed information about specific media assets in bulk.

Parámetros de entrada

entity_idsobject[]Obligatorio
List of media IDs to retrieve. Each ID should be a UUID format identifier. Maximum 2,000 entries.
ad_account_idstringObligatorio
Ad Account ID to fetch media from (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Media StatsSNAPCHAT_GET_MEDIA_STATSAcción

Tool to retrieve performance statistics for a specific media from Snapchat Marketing API. Use when you need to analyze media performance metrics such as impressions, swipes, spend, and video views. Supports VIDEO and IMAGE media types only; reach metrics are not available.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MemberSNAPCHAT_GET_MEMBERAcción

Tool to retrieve a specific member by ID from a Snapchat organization. Use when you need to fetch detailed information about an existing member.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OrganizationSNAPCHAT_GET_ORGANIZATIONAcción

Tool to retrieve a specific organization by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organizations CatalogsSNAPCHAT_GET_ORGANIZATIONS_CATALOGSAcción

Tool to retrieve all catalogs for a specific organization from Snapchat Marketing API. Use when you need to list all catalogs within an organization for Dynamic Product Ads. Supports pagination for large result sets.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organizations Mobile AppsSNAPCHAT_GET_ORGANIZATIONS_MOBILE_APPSAcción

Tool to retrieve mobile apps associated with a Snapchat organization by organization ID. Use when you need to list iOS and Android apps registered for tracking and campaigns.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organizations Public ProfilesSNAPCHAT_GET_ORGANIZATIONS_PUBLIC_PROFILESAcción

Tool to retrieve organization public profiles by ID from Snapchat Marketing API. Use when you need to fetch public profile information for a specific organization.

Parámetros de entrada

organization_idstringObligatorio
Organization ID to retrieve public profiles from (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Ad Account PixelsSNAPCHAT_GET_PIXELSAcción

Tool to retrieve all Snap Pixels associated with an ad account. Use when you need to list conversion tracking pixels for a specific Snapchat ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Product FeedSNAPCHAT_GET_PRODUCT_FEEDSAcción

Tool to retrieve a product feed by ID from Snapchat Marketing API. Use when you need to get details about a specific product feed including its configuration, schedule, and metadata for dynamic product ads.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Product Feed UploadsSNAPCHAT_GET_PRODUCT_FEEDS_FEED_UPLOADSAcción

Tool to retrieve product feed upload history for a specific product feed. Use when you need to check the status, metrics, or processing details of product catalog uploads for dynamic product ads.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Product SetSNAPCHAT_GET_PRODUCT_SETSAcción

Tool to retrieve a specific product set by ID from Snapchat Marketing API. Use when you need to fetch details about a particular product set for dynamic product ads.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Audience SegmentSNAPCHAT_GET_SEGMENTAcción

Tool to retrieve a specific audience segment by its ID from Snapchat Marketing API. Use when you need to fetch detailed information about an existing segment including its status, size, and targeting availability.

Parámetros de entrada

segment_idstringObligatorio
The unique identifier of the audience segment to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting CarriersSNAPCHAT_GET_TARGETING_CARRIERSAcción

Tool to retrieve available mobile carrier targeting options from Snapchat Marketing API. Use when you need to get the list of carriers that can be used for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Connection TypesSNAPCHAT_GET_TARGETING_CONNECTION_TYPESAcción

Tool to retrieve available connection types for device targeting from Snapchat Marketing API. Use when you need to fetch the list of connection type options (WIFI, CELL) that can be used for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Advanced Demographics Targeting OptionsSNAPCHAT_GET_TARGETING_DEMOGRAPHICS_ADVANCED_DEMOGRAPHICSAcción

Tool to retrieve all available advanced demographics targeting options from Snapchat Marketing API. Use when you need to fetch the list of demographic segments available for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Demographics Age GroupSNAPCHAT_GET_TARGETING_DEMOGRAPHICS_AGE_GROUPAcción

Tool to retrieve all available age group targeting options from Snapchat Marketing API. Use when you need to fetch the predefined age brackets (13-17, 18-20, 21-24, 25-34, 35+) for demographic targeting in ad campaigns.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Gender Targeting OptionsSNAPCHAT_GET_TARGETING_DEMOGRAPHICS_GENDERAcción

Tool to retrieve all available gender targeting options from Snapchat Marketing API. Use when you need to fetch the list of gender categories available for ad targeting (MALE, FEMALE, OTHER).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Demographics LanguagesSNAPCHAT_GET_TARGETING_DEMOGRAPHICS_LANGUAGESAcción

Tool to retrieve all available language targeting options from Snapchat Marketing API. Use when you need to fetch language codes and names for demographic targeting in ad campaigns.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Device iOS OS VersionSNAPCHAT_GET_TARGETING_DEVICE_IOS_OS_VERSIONAcción

Tool to retrieve all available iOS OS version targeting options from Snapchat Marketing API. Use when you need to get the list of iOS versions that can be used for targeting with os_version_min and os_version_max parameters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Device Marketing NamesSNAPCHAT_GET_TARGETING_DEVICE_MARKETING_NAMESAcción

Tool to retrieve available device marketing names for targeting from Snapchat Marketing API. Use when you need to get the list of device makes and models that can be used for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Geo Postal CodesSNAPCHAT_GET_TARGETING_GEO_POSTAL_CODEAcción

Tool to retrieve postal code targeting options by country code from Snapchat Marketing API. Use when you need to get the list of postal codes available for ad targeting in a specific country.

Parámetros de entrada

country_codestringObligatorio
ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA') to retrieve postal codes for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Geo RegionSNAPCHAT_GET_TARGETING_GEO_REGIONAcción

Tool to retrieve region targeting options for a specific country from Snapchat Marketing API. Use when you need to get the list of regions (states, provinces, etc.) that can be used for ad targeting within a particular country.

Parámetros de entrada

country_codestringObligatorio
Two-letter ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA', 'GB') to retrieve regions for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Geo US Postal CodesSNAPCHAT_GET_TARGETING_GEO_US_POSTAL_CODEAcción

Tool to retrieve all US postal code targeting options from Snapchat Marketing API. Use when you need to get the list of US ZIP codes available for ad targeting with geographic hierarchy data.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Geo US RegionSNAPCHAT_GET_TARGETING_GEO_US_REGIONAcción

Tool to retrieve all available US region targeting options from Snapchat Marketing API. Use when you need to fetch the list of US states/regions available for geographic ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests DLXCSNAPCHAT_GET_TARGETING_INTERESTS_DLXCAcción

Tool to retrieve Oracle Datalogix DLXC interest targeting options from Snapchat Marketing API. Use when you need to fetch available DLXC interest categories for ad targeting. Note: This endpoint is deprecated as of September 27, 2024.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests DLXPSNAPCHAT_GET_TARGETING_INTERESTS_DLXPAcción

Tool to retrieve Oracle Datalogix DLXP interest targeting options from Snapchat Marketing API. Use when you need to fetch business dealer and service targeting options for ad campaigns. Note: This endpoint is deprecated.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests DLXSSNAPCHAT_GET_TARGETING_INTERESTS_DLXSAcción

Tool to retrieve all available Oracle Datalogix (DLXS) interest targeting options from Snapchat Marketing API. Use when you need to get the list of DLXS interests that can be used for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests NLNSNAPCHAT_GET_TARGETING_INTERESTS_NLNAcción

Tool to retrieve all available Nielsen interest targeting options from Snapchat Marketing API. Use when you need to get Nielsen-based interest categories for audience targeting in ad campaigns.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests PLCSNAPCHAT_GET_TARGETING_INTERESTS_PLCAcción

Tool to retrieve all available PLC (Placed Visitation Segments) targeting options from Snapchat Marketing API. Use when you need to get location-based interest segments for audience targeting in ad campaigns.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting Interests SCLSSNAPCHAT_GET_TARGETING_INTERESTS_SC_LSAcción

Tool to retrieve Snap Lifestyle Categories (SCLS) for interest targeting from Snapchat Marketing API. Use when you need to fetch lifestyle category options for interest-based ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Location Category LOI OptionsSNAPCHAT_GET_TARGETING_LOCATION_CATEGORIES_LOIAcción

Tool to retrieve all location category (LOI - Locations of Interest) targeting options from Snapchat Marketing API. Use when you need to fetch the list of venue types and business categories available for location-based ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting MetrosSNAPCHAT_GET_TARGETING_METROSAcción

Tool to retrieve metro/DMA targeting options by country code from Snapchat Marketing API. Use when you need to get the list of metro areas available for ad targeting in a specific country.

Parámetros de entrada

country_codestringObligatorio
ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA') to retrieve metro areas for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting OS TypesSNAPCHAT_GET_TARGETING_OS_TYPESAcción

Tool to retrieve available OS type targeting options from Snapchat Marketing API. Use when you need to get the list of operating system types (e.g., iOS, Android) that can be used for ad targeting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting OS VersionsSNAPCHAT_GET_TARGETING_OS_VERSIONSAcción

Tool to retrieve available OS versions for targeting from Snapchat Marketing API. Use when you need to get the list of iOS or Android versions that can be used for targeting with os_version_min and os_version_max parameters.

Parámetros de entrada

os_typestringObligatorioenum
Operating system type to retrieve versions for (iOS or ANDROID)
iOSANDROID

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting V1 Interests SCLSSNAPCHAT_GET_TARGETING_V1_INTERESTS_SC_LSAcción

Tool to retrieve all Snap Lifestyle Categories V1 targeting options from Snapchat Marketing API. Use when you need to fetch interest-based targeting categories for ad campaigns.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting V1 Interests ShpSNAPCHAT_GET_TARGETING_V1_INTERESTS_SHPAcción

Tool to retrieve first-party shopper segment targeting options from Snapchat Marketing API. Use when you need to get shopper segments for ad targeting based on consumer purchase behavior.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting VAC InterestsSNAPCHAT_GET_TARGETING_V1_INTERESTS_VACAcción

Tool to retrieve First-Party Visitation Segments (VAC interests) for targeting from Snapchat Marketing API. Use when you need to fetch venue categories based on locations users have visited (e.g., restaurants, retail stores).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Targeting V1 OptionsSNAPCHAT_GET_TARGETING_V1_OPTIONSAcción

Tool to retrieve all available targeting v1 options from Snapchat Marketing API. Use when you need to get the list of targeting dimensions available for ad targeting in a specific country.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Account RolesSNAPCHAT_LIST_ACCOUNT_ROLESAcción

Tool to retrieve all roles for a Snapchat Ad Account. Use when you need to view all member access permissions assigned within an account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Ad AccountsSNAPCHAT_LIST_AD_ACCOUNTSAcción

Tool to retrieve all ad accounts associated with an organization from Snapchat Marketing API. Use when you need to list or fetch all ad accounts for a specific organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Ads by AccountSNAPCHAT_LIST_ADS_BY_ACCOUNTAcción

Tool to retrieve all ads for a specific ad account from Snapchat Marketing API. Use when you need to list all ads associated with an ad account.

Parámetros de entrada

ad_account_idstringObligatorio
Unique identifier of the ad account to retrieve ads for (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Ads by Ad SquadSNAPCHAT_LIST_ADS_BY_AD_SQUADAcción

Tool to retrieve all ads for a specific ad squad from Snapchat Marketing API. Use when you need to list all ads associated with an ad squad.

Parámetros de entrada

ad_squad_idstringObligatorio
Unique identifier of the ad squad to retrieve ads for (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Ads by CampaignSNAPCHAT_LIST_ADS_BY_CAMPAIGNAcción

Tool to retrieve all ads for a specific campaign from Snapchat Marketing API. Use when you need to list or fetch all ads associated with a particular campaign.

Parámetros de entrada

campaign_idstringObligatorio
Unique identifier of the campaign to retrieve ads for (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Ad Squads by CampaignSNAPCHAT_LIST_AD_SQUADSAcción

Tool to retrieve all ad squads for a specific campaign. Use when you need to list or fetch ad squads belonging to a particular Snapchat campaign.

Parámetros de entrada

campaign_idstringObligatorio
Campaign ID to retrieve ad squads for. Must be a valid UUID of an existing campaign.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Billing CentersSNAPCHAT_LIST_BILLING_CENTERSAcción

Tool to retrieve all billing centers for a Snapchat Ads organization. Use when you need to fetch a complete list of billing centers associated with an organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CampaignsSNAPCHAT_LIST_CAMPAIGNSAcción

Tool to retrieve all campaigns for a specific ad account from Snapchat Marketing API. Use when you need to list all campaigns within an ad account.

Parámetros de entrada

sortstringenum
Sort order for campaigns list.
updated_at-desccreated_at-desc
ad_account_idstringObligatorio
Ad Account ID to retrieve campaigns from (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Catalog RolesSNAPCHAT_LIST_CATALOG_ROLESAcción

Tool to retrieve all roles for a Snapchat catalog. Use when you need to view all member access permissions assigned within a catalog.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CreativesSNAPCHAT_LIST_CREATIVESAcción

Tool to retrieve all creatives for a specific ad account from Snapchat Marketing API. Use when you need to list all creative assets within an ad account.

Parámetros de entrada

ad_account_idstringObligatorio
Ad Account ID to retrieve creatives from (UUID format). This is the unique identifier of your Snapchat ad account.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Funding SourcesSNAPCHAT_LIST_FUNDING_SOURCESAcción

Tool to retrieve all funding sources for a specific organization from Snapchat Marketing API. Use when you need to list all payment methods (credit cards, PayPal, lines of credit, coupons) available for an organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List InvoicesSNAPCHAT_LIST_INVOICESAcción

Tool to retrieve all invoices for an ad account from Snapchat Marketing API. Use when you need to fetch billing information for all invoices associated with a specific ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MediaSNAPCHAT_LIST_MEDIAAcción

Tool to retrieve all media files for a specific Snapchat ad account. Use when you need to list all media assets (images, videos, lenses, or playable ads) available in an ad account.

Parámetros de entrada

sortstringenum
Sort order for media listing.
created_at-asccreated_at-desc
typestringenum
Media type filter for listing.
VIDEOIMAGELENS_PACKAGEPLAYABLE
ad_account_idstringObligatorio
Ad Account ID (UUID format) for which to retrieve all media files.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Member RolesSNAPCHAT_LIST_MEMBER_ROLESAcción

Tool to retrieve all roles assigned to a member in Snapchat Marketing API. Use when you need to see all permissions a member has across organizations, ad accounts, and catalogs.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Organization MembersSNAPCHAT_LIST_MEMBERSAcción

Tool to retrieve all members of a Snapchat organization. Use when you need to view all users who have access to an organization, including their status (INVITED or MEMBER).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OrganizationsSNAPCHAT_LIST_ORGANIZATIONSAcción

Tool to retrieve all organizations that the authenticated user has access to from Snapchat Marketing API. Use when you need to list all organizations for the current user.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Organization PixelsSNAPCHAT_LIST_ORG_PIXELSAcción

Tool to retrieve all Snap Pixels for a specific organization from Snapchat Marketing API. Use when you need to list tracking pixels across all ad accounts within an organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Organization RolesSNAPCHAT_LIST_ORG_ROLESAcción

Tool to retrieve all roles for a Snapchat organization. Use when you need to view all member access permissions assigned within an organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Phone NumbersSNAPCHAT_LIST_PHONE_NUMBERSAcción

Tool to retrieve all verified phone numbers associated with a Snapchat ad account. Use when you need to list or fetch phone numbers for calling and texting features.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Audience SegmentsSNAPCHAT_LIST_SEGMENTSAcción

Tool to retrieve all audience segments for an ad account from Snapchat Marketing API. Use when you need to fetch a complete list of segments including customer lists, lookalikes, and engagement audiences.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Sponsored ContentSNAPCHAT_LIST_SPONSORED_CONTENTAcción

Tool to retrieve organic sponsored content from Snapchat Ads Library. Use when you need to list all available sponsored content from the library with pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TransactionsSNAPCHAT_LIST_TRANSACTIONSAcción

Tool to retrieve all transactions for an organization from Snapchat Marketing API. Use when you need to fetch transaction history including payments, refunds, and other billing activities. Supports filtering by time range and ad account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Ads Library Sponsored ContentSNAPCHAT_SEARCH_ADS_LIBRARY_SPONSORED_CONTENTAcción

Tool to search for sponsored content by creator name in Snapchat Ads Library. Use when you need to find ads associated with a specific creator.

Parámetros de entrada

limitinteger
Maximum number of results to return
cursorstring
Pagination cursor for retrieving next page of results
creator_namestringObligatorio
Name of the creator to search for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Catalog ProductsSNAPCHAT_SEARCH_CATALOG_PRODUCTSAcción

Tool to search a catalog for products given a provided filter. Use when you need to find specific products in a catalog based on attributes like brand, availability, price, or other properties.

Parámetros de entrada

limitinteger
Number of products to return per page. Must be between 50 and 1000. If not specified, the API default will be used.
filterobject
Filtering criteria using various product properties. Supports logical operators (AND, OR) with up to two nesting levels and maximum 10 fields per operator. Filterable properties include: AGE_GROUP, AVAILABILITY, BRAND, COLOR, CONDITION, GENDER, PRICE_AMOUNT, PRODUCT_TYPE, SIZE, TITLE, ID, ITEM_GROUP_ID, PRODUCT_SET_ID, CUSTOM_LABEL_0-4, GOOGLE_PRODUCT_CATEGORY, PRODUCT_STATUS, MEDIA_ELIGIBLE_AD_TYPE, PRICE_CURRENCY, SALE_PRICE_AMOUNT. Comparison operations: EQ, NEQ, GT, GTE, LT, LTE, CONTAINS, NOT_CONTAINS, I_CONTAINS, I_NOT_CONTAINS, STARTS_WITH, I_STARTS_WITH, IS_ANY, IS_NOT_ANY, I_IS_ANY, I_IS_NOT_ANY.
catalog_idstringObligatorio
The unique identifier of the catalog to search. This is the Catalog ID that you want to query for products.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Catalogs HotelsSNAPCHAT_SEARCH_CATALOGS_HOTELSAcción

Tool to search for hotels in a Snapchat catalog using filters and pagination. Use when you need to find specific hotels in a catalog by name, price, rating, location, or other attributes.

Parámetros de entrada

limitinteger
Number of results to return per page. Must be between 50 and 1000.
filterobject
Optional filter to narrow search results. Supports AND/OR logical operators with up to 2 levels of nesting. Filter operators include: EQ (equal), NEQ (not equal), GT (greater than), GTE (greater than or equal), LT (less than), LTE (less than or equal), CONTAINS, NOT_CONTAINS, I_CONTAINS (case-insensitive contains), I_NOT_CONTAINS, STARTS_WITH, I_STARTS_WITH, IS_ANY, IS_NOT_ANY, I_IS_ANY, I_IS_NOT_ANY. Filterable fields include: ID, NAME, BASE_PRICE_AMOUNT, SALE_PRICE_AMOUNT, BRAND, NEIGHBORHOOD, STAR_RATING, LOYALTY_PROGRAM, ACTIVITY, CUSTOM_LABEL_0 through CUSTOM_LABEL_4, LOCALITY, POSTAL_CODE, COUNTRY_CODE, NUMBER_OF_RATERS, GUEST_RATING_SCORE, PRODUCT_SET_ID, PRODUCT_STATUS, ELIGIBLE_AD_TYPE.
catalog_idstringObligatorio
The identifier for the catalog to search in.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Ad AccountSNAPCHAT_UPDATE_AD_ACCOUNTAcción

Tool to update an existing ad account within a Snapchat organization. Use when modifying ad account settings such as name, status, billing, or spend caps. Requires the ad account ID and organization ID. All account fields must be provided in the update request.

Parámetros de entrada

adaccountsobject[]Obligatorio
List of ad accounts to update (typically one account per request)
organization_idstringObligatorio
Organization ID that owns the ad account

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Ad SquadSNAPCHAT_UPDATE_AD_SQUADAcción

Tool to update an existing ad squad within a campaign. Use when modifying ad delivery targeting, budgets, placements, or other settings for an existing Snapchat ad squad.

Parámetros de entrada

adsquadsobject[]Obligatorio
List of ad squads to update. Each ad squad must include an 'id' field. At least one ad squad is required.
campaign_idstringObligatorio
Campaign ID that the ad squad belongs to. Must be a valid UUID of an existing campaign.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Billing CenterSNAPCHAT_UPDATE_BILLING_CENTERAcción

Tool to update one or more existing billing centers for a Snapchat Ads organization. Use when you need to modify billing center details such as name, email address, or billing address information. Requires the billing center ID along with organization ID and updated billing information.

Parámetros de entrada

billingcentersobject[]Obligatorio
List of billing centers to update (one or more)
organization_idstringObligatorio
The organization ID that owns the billing center(s) to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CampaignSNAPCHAT_UPDATE_CAMPAIGNAcción

Tool to update an existing advertising campaign in Snapchat Marketing API. Use when you need to modify campaign properties like name, status, budget, timing, or objectives.

Parámetros de entrada

namestring
Updated campaign name (max 375 characters). If not provided, the existing name is retained.
statusstringenum
Campaign status values.
ACTIVEPAUSED
end_timestring
Updated campaign end time in ISO 8601 format. If not specified, campaign runs indefinitely until manually stopped. If not provided, the existing end_time is retained.
buy_modelstringenum
Campaign buy model values.
AUCTIONRESERVED
objectivestringenum
Campaign objective values.
AWARENESSAPP_INSTALLSAPP_VISITSDRIVE_TRAFFICENGAGEMENTLEAD_GENERATIONPROMOTE_PLACESVIDEO_VIEWSBRAND_AWARENESSWEBSITE_CONVERSIONS
start_timestring
Updated campaign start time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). The campaign will not deliver before this time. If not provided, the existing start_time is retained.
campaign_idstringObligatorio
Unique identifier of the campaign to update (UUID format).
pacing_levelstring
Updated pacing level for budget optimization. Set to 'CAMPAIGN' to enable Smart Budgets at campaign level. If not provided, the existing pacing_level is retained.
ad_account_idstringObligatorio
Ad Account ID where the campaign exists. This is a UUID format identifier.
creation_statestring
Updated creation state of the campaign. Set to 'PUBLISHED' if needed. If not provided, the existing creation_state is retained.
measurement_specobject
Measurement specification for app-related campaigns.
shared_propertiesobject
Shared properties for Smart Budgets campaigns.
daily_budget_microinteger
Updated daily spend cap in micro-currency units (1,000,000 micro = 1 currency unit). If not set, the existing daily_budget_micro is retained.
objective_v2_propertiesobject
Objective V2 properties for campaign.
lifetime_spend_cap_microinteger
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Audience SegmentSNAPCHAT_UPDATE_SEGMENTAcción

Tool to update existing audience segments in Snapchat Ads. Use when you need to modify the name, description, or retention period of audience segments. Only these three fields can be updated; other segment properties are read-only.

Parámetros de entrada

segmentsobject[]Obligatorio
List of audience segments to update. Only name, description, and retention_in_days can be modified.
ad_account_idstringObligatorio
The ad account ID that owns the segments to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload Media MultipartSNAPCHAT_UPLOAD_MEDIA_MULTIPARTAcción

Tool to upload large media files using multipart upload in Snapchat Marketing API. Use when uploading media files larger than 32MB or when you need to upload in chunks for reliability. Start with INIT action to get upload session details.

Parámetros de entrada

actionstringObligatorioenum
Action type for multipart upload. INIT starts a new upload session, ADD uploads a file chunk, FINALIZE completes the upload.
INITADDFINALIZE
media_idstringObligatorio
Unique identifier of the media file to upload (UUID format). This media should be created first using Create Media action.
file_namestring
Name of the file being uploaded. Required for INIT action.
file_sizeinteger
Total file size in bytes. Required for INIT action. Maximum 1GB (1073741824 bytes).
number_of_partsinteger
Expected number of file chunks. Required for INIT action. Each part can be up to 32MB.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Validate Conversion EventSNAPCHAT_VALIDATE_CONVERSION_EVENTAcción

Tool to validate conversion events before sending them to Snapchat Conversion API. Use when testing pixel implementation or verifying event data format. Checks event structure, required fields, and data types without actually recording the events.

Parámetros de entrada

eventsobject[]Obligatorio
List of conversion events to validate (typically 1-100 events per request)
pixel_idstringObligatorio
Snap Pixel ID to validate events for. This must be a valid pixel ID from your Snapchat ad account.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not