Snapchat Ads
App · 26 actions
Run your Snapchat ads: create and update campaigns, ad squads and ads, pause or activate them, preview creatives, keep customer list audiences in sync, and report spend and results.
Actions
| Action | What it does |
|---|---|
| Add people to audience | Add people to a customer list audience by email, phone number or mobile ad id. |
| Create ad | Put a creative from your Creative Library into an ad squad as an ad. |
| Create ad squad | Create an ad squad in a campaign: who sees the ads, where, what to optimize for, the bid and the budget. |
| Create audience | Create an empty customer list audience to fill with 'Add people to audience' and target from an ad squad. |
| Create campaign | Create a campaign in an ad account. |
| Delete ad | Delete an ad. |
| Delete ad squad | Delete an ad squad. |
| Delete audience | Delete a customer list audience. |
| Delete campaign | Delete a campaign. |
| Get ad | Get one ad with its status, creative and review result, including why Snapchat rejected it if it did. |
| Get ad squad | Get one ad squad with its budget, bid, optimization goal, placement and targeting. |
| Get campaign | Get one campaign with its status, objective, budgets and dates. |
| Get creative | Get one creative with its headline, brand name and review result, and a preview link anyone can open for 90 days, no login needed. |
| Get signed-in member | Get the Snapchat Business member the connection signed in as: name, email, Snapchat username and organization. |
| Get stats | Get impressions, swipe ups, spend, video views, reach and conversions for an ad account, campaign, ad squad or ad: a total, day by day or hour by hour, optionally for each campaign, ad squad or ad inside it. |
| List ad accounts | List every ad account you can reach, across your organizations, with its currency, time zone and your roles on it. |
| List ad squads | List the ad squads in an ad account, or in one campaign, most recently changed first, with their budgets, bids and targeting. |
| List ads | List the ads in an ad account, campaign or ad squad, most recently changed first, with their status and review result (and why Snapchat rejected one). |
| List audiences | List an ad account's audiences, with about how many Snapchatters each matched and whether ads can target it yet. |
| List campaigns | List an ad account's campaigns, most recently changed first, with their status, budgets and dates. |
| List creatives | List the creatives in an ad account's Creative Library, with their type and review result. |
| Pause or activate campaign | Pause a campaign so it stops spending, or make it active again. |
| Remove people from audience | Remove people from a customer list audience by email, phone number or mobile ad id, such as when they unsubscribe. |
| Update ad | Rename an ad, or pause or activate it. |
| Update ad squad | Change an ad squad's name, status, budget, bid, end or countries. |
| Update campaign | Change a campaign's name, dates, daily budget or lifetime spending limit. |
Add people to audience
Add people to a customer list audience by email, phone number or mobile ad id. Lodol normalises and hashes them, as Snapchat requires, so only the hashes leave Lodol.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Audience
audience_idtextRequired - The customer list audience. Pick one, or give its id from an earlier step.
- Identify people by
identifier_typetext - What the list holds. Defaults to email addresses.One of:
EMAIL(Email addresses),PHONE(Phone numbers),MOBILE_AD_ID(Mobile ad ids (IDFA or Android advertising id)). Default:EMAIL. - People
identifierslistRequired - The email addresses, phone numbers (with the country code) or mobile ad ids, as a list or one per line. Lodol hashes them before sending, as Snapchat requires.
Outputs
acceptednumber- How many Snapchat says it took
audience_idtext- The audience
audience_nametext- The audience's name
identifier_typetext- EMAIL, PHONE or MOBILE_AD_ID
sentnumber- How many distinct people were sent to add
skippednumber- Entries left out because they weren't valid or were repeats
Example output
{
"accepted": 2,
"audience_id": "5677923948298240",
"audience_name": "all the sams in the world",
"identifier_type": "EMAIL",
"sent": 2,
"skipped": 0
}Create ad
Put a creative from your Creative Library into an ad squad as an ad. The ad's type follows from the creative. It starts paused unless you say otherwise, and Snapchat reviews it before it runs.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad squad
ad_squad_idtextRequired - The ad squad. Pick one, or give its id from an earlier step.
- Creative
creative_idtextRequired - The creative: the video or image with its headline, made in Ads Manager. Pick one, or give its id from an earlier step.
- Name
nametextRequired - A name to know it by in Ads Manager, up to 375 characters.
- Status
statustext - Paused (the default) until you turn it on, or active right away.One of:
PAUSED,ACTIVE. Default:PAUSED.
Outputs
adobject- An ad
warningslist- Settings Snapchat suggests checking; empty when there are none
Example output
{
"ad": {
"ad_squad_id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"created_at": "2026-10-17T20:14:57.012Z",
"creative_id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"id": "e8d6217f-32ab-400f-9e54-39a86a7963e4",
"name": "Ad One",
"render_type": "STATIC",
"review_status": "PENDING",
"review_status_reasons": [],
"status": "PAUSED",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"warnings": []
}Create ad squad
Create an ad squad in a campaign: who sees the ads, where, what to optimize for, the bid and the budget. It starts paused unless you say otherwise.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
- Name
nametextRequired - A name to know it by in Ads Manager, up to 375 characters.
- Countries
countrieslistRequired - Where the ads are shown. Pick one or more.
- Daily budget
daily_budgetnumber - The most the ad squad spends a day, in the ad account's currency (such as 20). Snapchat's minimum is 5. Give this or a lifetime budget.
- Lifetime budget
lifetime_budgetnumber - The most the ad squad spends in total, in the ad account's currency. Needs an end. Give this or a daily budget.
- Optimize for
optimization_goaltext - The result Snapchat shows the ads to get. Defaults to impressions.One of:
IMPRESSIONS(Impressions (default)),SWIPES(Swipe ups),VIDEO_VIEWS(Video views (2 seconds)),VIDEO_VIEWS_15_SEC(Video views (15 seconds)),STORY_OPENS(Story opens),LANDING_PAGE_VIEW(Landing page views),PIXEL_PAGE_VIEW(Page views (Snap Pixel)),PIXEL_ADD_TO_CART(Adds to cart (Snap Pixel)),PIXEL_SIGNUP(Sign ups (Snap Pixel)),PIXEL_PURCHASE(Purchases (Snap Pixel)), and 5 more. Default:IMPRESSIONS. - Bid strategy
bid_strategytext - How Snapchat bids for you. Defaults to automatic.One of:
AUTO_BID(Automatic: Snapchat sets the bid (default)),LOWEST_COST_WITH_MAX_BID(Lowest cost, up to a maximum bid),TARGET_COST(Target cost per result). Default:AUTO_BID. - Bid
bid_amountnumber - The most (or, for target cost, the average) to pay per result, in the ad account's currency, such as 2.50.Only when Bid strategy is Lowest cost, up to a maximum bid or Target cost per result.
- Status
statustext - Paused (the default) until you turn it on, or active right away.One of:
PAUSED,ACTIVE. Default:PAUSED. - Start
start_timedate and time - When it starts delivering. Leave empty to start now.
- End
end_timedate and time - When it stops. Leave empty to run until you stop it.
- Placements
placementslist - Where in Snapchat the ads run. Leave empty for automatic placement, which Snapchat recommends.One or more of:
INTERSTITIAL_USER(Between friends' stories),INTERSTITIAL_CONTENT(Between publisher and creator stories),INSTREAM(Within publisher stories),PUBLIC_STORIES_INSTREAM(Within creator stories),INTERSTITIAL_SPOTLIGHT(Between Spotlight videos),FEED(Discover feed (Story ads only)),CHAT_FEED(Chat tab). - Youngest age
min_agenumber - Only people this age or older, 13 to 35. Leave empty for 13.From 13 to 35.
- Oldest age
max_agenumber - Only people this age or younger, 13 to 55. Leave empty for no limit.From 13 to 55.
- Gender
gendertext - Only women, or only men. Leave empty for everyone.One of:
FEMALE(Women),MALE(Men). - Language
languagetext - Only people who use Snapchat in this language. Snapchat asks for one when you pick more than one country.
- Audiences
audience_idslist - Only people in these customer list audiences. Leave empty for anyone.
- Snap Pixel
pixel_idtext - The Snap Pixel on your website that counts the results.Only when Optimize for is Page views (Snap Pixel), Adds to cart (Snap Pixel), Sign ups (Snap Pixel) or Purchases (Snap Pixel).
Outputs
ad_squadobject- An ad squad
warningslist- Settings Snapchat suggests checking; empty when there are none
Example output
{
"ad_squad": {
"bid": 1.0,
"bid_micro": 1000000,
"bid_strategy": "LOWEST_COST_WITH_MAX_BID",
"billing_event": "IMPRESSION",
"campaign_id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"created_at": "2026-10-17T20:14:57.012Z",
"daily_budget": 20.0,
"daily_budget_micro": 20000000,
"delivery_constraint": "DAILY_BUDGET",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"lifetime_budget": 0.0,
"lifetime_budget_micro": 0,
"name": "Ad Squad Uno",
"optimization_goal": "IMPRESSIONS",
"pixel_id": "",
"placement_v2": {
"config": "AUTOMATIC"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"targeting": {
"geos": [
{
"country_code": "us"
}
]
},
"type": "SNAP_ADS",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"warnings": []
}Create audience
Create an empty customer list audience to fill with 'Add people to audience' and target from an ad squad.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Name
nametextRequired - A name to know it by in Ads Manager, up to 375 characters.
- Description
descriptiontext - A note on who is in it.
- Keep people for (days)
retention_in_daysnumber - How many days people stay in it, up to 9999. Leave empty to keep them for good.From 1 to 9999.
Outputs
audienceobject- A customer list audience
warningslist- Settings Snapchat suggests checking; empty when there are none
Example output
{
"audience": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"approximate_number_users": 0,
"created_at": "2026-10-17T20:14:57.012Z",
"description": "all the sams in the world",
"id": "5677923948298240",
"name": "all the sams in the world",
"retention_in_days": 180,
"source_type": "FIRST_PARTY",
"status": "ACTIVE",
"targetable_status": "NOT_READY",
"updated_at": "2026-10-17T20:14:57.012Z",
"upload_status": "NO_UPLOAD"
},
"warnings": []
}Create campaign
Create a campaign in an ad account. It starts paused unless you say otherwise; add ad squads and ads to it before turning it on.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Name
nametextRequired - A name to know it by in Ads Manager, up to 375 characters.
- Objective
objectivetext - What the campaign is for. Defaults to awareness and engagement.One of:
AWARENESS_AND_ENGAGEMENT(Awareness and engagement (default)),TRAFFIC,SALES,APP_PROMOTION(App promotion),LEADS. Default:AWARENESS_AND_ENGAGEMENT. - Status
statustext - Paused (the default) until you turn it on, or active right away.One of:
PAUSED,ACTIVE. Default:PAUSED. - Start
start_timedate and time - When it starts delivering. Leave empty to start now.
- End
end_timedate and time - When it stops. Leave empty to run until you stop it.
- Daily budget
daily_budgetnumber - The most the campaign spends a day, in the ad account's currency (such as 50 for 50.00). Snapchat's minimum is 20.
- Lifetime spending limit
lifetime_spend_capnumber - The most the campaign spends in total, in the ad account's currency. Snapchat's minimum is 20.
Outputs
campaignobject- A campaign
warningslist- Settings Snapchat suggests checking; empty when there are none
Example output
{
"campaign": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"buy_model": "AUCTION",
"created_at": "2026-10-17T20:14:57.012Z",
"creation_state": "PUBLISHED",
"daily_budget": 50.0,
"daily_budget_micro": 50000000,
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"lifetime_spend_cap": 500.0,
"lifetime_spend_cap_micro": 500000000,
"name": "Badger Tunneling Campaign",
"objective": "BRAND_AWARENESS",
"objective_v2_properties": {
"objective_v2_type": "AWARENESS_AND_ENGAGEMENT"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"warnings": []
}Delete ad
Delete an ad. Snapchat can't bring it back; the creative stays.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad
ad_idtextRequired - The ad. Pick one, or give its id from an earlier step.
Outputs
ad_idtext- The ad deleted
deletedtrue/false- True once deleted
nametext- The ad's name
Example output
{
"ad_id": "e8d6217f-32ab-400f-9e54-39a86a7963e4",
"deleted": true,
"name": "Ad One"
}Delete ad squad
Delete an ad squad. Snapchat can't bring it back.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad squad
ad_squad_idtextRequired - The ad squad. Pick one, or give its id from an earlier step.
Outputs
ad_squad_idtext- The ad squad deleted
deletedtrue/false- True once deleted
nametext- The ad squad's name
Example output
{
"ad_squad_id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"deleted": true,
"name": "Ad Squad Uno"
}Delete audience
Delete a customer list audience. Snapchat can't bring it back.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Audience
audience_idtextRequired - The customer list audience. Pick one, or give its id from an earlier step.
Outputs
audience_idtext- The audience deleted
deletedtrue/false- True once deleted
nametext- The audience's name
Example output
{
"audience_id": "5677923948298240",
"deleted": true,
"name": "all the sams in the world"
}Delete campaign
Delete a campaign. Snapchat can't bring it back, so pause it instead if you might need it again.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaign_idtext- The campaign deleted
deletedtrue/false- True once deleted
nametext- The campaign's name
Example output
{
"campaign_id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"deleted": true,
"name": "Badger Tunneling Campaign"
}Get ad
Get one ad with its status, creative and review result, including why Snapchat rejected it if it did.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad
ad_idtextRequired - The ad. Pick one, or give its id from an earlier step.
Outputs
adobject- An ad
Example output
{
"ad": {
"ad_squad_id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"created_at": "2026-10-17T20:14:57.012Z",
"creative_id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"id": "e8d6217f-32ab-400f-9e54-39a86a7963e4",
"name": "Ad One",
"render_type": "STATIC",
"review_status": "PENDING",
"review_status_reasons": [],
"status": "PAUSED",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
}
}Get ad squad
Get one ad squad with its budget, bid, optimization goal, placement and targeting.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad squad
ad_squad_idtextRequired - The ad squad. Pick one, or give its id from an earlier step.
Outputs
ad_squadobject- An ad squad
Example output
{
"ad_squad": {
"bid": 1.0,
"bid_micro": 1000000,
"bid_strategy": "LOWEST_COST_WITH_MAX_BID",
"billing_event": "IMPRESSION",
"campaign_id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"created_at": "2026-10-17T20:14:57.012Z",
"daily_budget": 20.0,
"daily_budget_micro": 20000000,
"delivery_constraint": "DAILY_BUDGET",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"lifetime_budget": 0.0,
"lifetime_budget_micro": 0,
"name": "Ad Squad Uno",
"optimization_goal": "IMPRESSIONS",
"pixel_id": "",
"placement_v2": {
"config": "AUTOMATIC"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"targeting": {
"geos": [
{
"country_code": "us"
}
]
},
"type": "SNAP_ADS",
"updated_at": "2026-10-17T20:14:57.012Z"
}
}Get campaign
Get one campaign with its status, objective, budgets and dates.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaignobject- A campaign
Example output
{
"campaign": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"buy_model": "AUCTION",
"created_at": "2026-10-17T20:14:57.012Z",
"creation_state": "PUBLISHED",
"daily_budget": 50.0,
"daily_budget_micro": 50000000,
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"lifetime_spend_cap": 500.0,
"lifetime_spend_cap_micro": 500000000,
"name": "Badger Tunneling Campaign",
"objective": "BRAND_AWARENESS",
"objective_v2_properties": {
"objective_v2_type": "AWARENESS_AND_ENGAGEMENT"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"updated_at": "2026-10-17T20:14:57.012Z"
}
}Get creative
Get one creative with its headline, brand name and review result, and a preview link anyone can open for 90 days, no login needed.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Creative
creative_idtextRequired - The creative: the video or image with its headline, made in Ads Manager. Pick one, or give its id from an earlier step.
Outputs
creativeobject- A creative
preview_expires_attext- When the preview link stops working
preview_urltext- A preview page anyone can open; empty if Snapchat has none
Example output
{
"creative": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"brand_name": "Example Inc",
"call_to_action": "",
"created_at": "2026-10-17T20:14:57.012Z",
"headline": "For all Citrus Fans",
"id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"name": "Creative Creative",
"packaging_status": "SUCCESS",
"review_status": "APPROVED",
"shareable": true,
"top_snap_media_id": "a7bee653-1865-41cf-8cee-8ab85a205837",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"preview_expires_at": "2026-01-13T23:29:13.709Z",
"preview_url": "https://ad-preview.snapchat.com/?creative_id=3411c824-650f-48ae-bdc8-37398b6168e2&expires_at=1768346953709&signature=MGQCMH5i7LrKXWNZv7HsjN73uR"
}Get signed-in member
Get the Snapchat Business member the connection signed in as: name, email, Snapchat username and organization.
Inputs
None.
Outputs
userobject- The signed-in Snapchat member
Example output
{
"user": {
"created_at": "2026-10-17T20:14:57.012Z",
"display_name": "Honey Badger",
"email": "honey.badger@hooli.com",
"id": "a22b5575-9052-437e-96c1-db781d62d203",
"member_status": "MEMBER",
"organization_id": "40d6719b-da09-410b-9185-0cc9c0dfed1d",
"snapchat_username": "honey_badger",
"updated_at": "2026-10-17T20:14:57.012Z"
}
}Get stats
Get impressions, swipe ups, spend, video views, reach and conversions for an ad account, campaign, ad squad or ad: a total, day by day or hour by hour, optionally for each campaign, ad squad or ad inside it. Snapchat updates stats about every 15 minutes.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtext - Stats for this campaign. Leave campaign, ad squad and ad empty for the whole ad account.
- Ad squad
ad_squad_idtext - Stats for this ad squad instead.
- Ad
ad_idtext - Stats for this ad instead.
- Show
granularitytext - One total, or figures day by day (up to 31 days) or hour by hour (up to 7 days). Defaults to the total.One of:
TOTAL(Total for the period (default)),DAY(Day by day),HOUR(Hour by hour). Default:TOTAL. - From
start_datedate - First day to count, in the ad account's time zone. Leave both dates empty for everything so far (total only).
- To
end_datedate - Last day to count, included.
- Figures
metricslist - Which figures to report. Defaults to impressions, swipe ups and amount spent.One or more of:
impressions,swipes(Swipe ups),spend(Amount spent),video_views(Video views),view_completion(Videos watched to the end),uniques(People reached),frequency(Average views per person),swipe_up_percent(Swipe up rate),story_opens(Story opens),landing_page_views(Landing page views), and 5 more. Default:["impressions", "swipes", "spend"]. - Break down
breakdowntext - Figures for each campaign (of an ad account), ad squad (of a campaign) or ad inside it. Leave empty for one set of figures.One of:
campaign(By campaign (for a whole ad account)),adsquad(By ad squad (for a campaign)),ad(By ad).
Outputs
breakdownlist- The figures for each campaign, ad squad or ad
end_datetext- Last day counted; empty for everything so far
finalized_data_end_timetext- Figures before this time are final; later ones may still change
granularitytext- TOTAL, DAY or HOUR
idtext- Its id
leveltext- What the stats are for: ad_account, campaign, ad_squad or ad
metricslist- The figures asked Snapchat for
notetext- Anything to know about the figures
start_datetext- First day counted; empty for everything so far
statsobject- The totals, for a total without a breakdown
timeserieslist- The figures day by day or hour by hour
Example output
{
"breakdown": [],
"end_date": "2026-07-30",
"finalized_data_end_time": "2026-08-28T12:00:00.000Z",
"granularity": "TOTAL",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"level": "campaign",
"metrics": [
"impressions",
"swipes",
"spend"
],
"note": "",
"start_date": "2026-07-01",
"stats": {
"impressions": 42062270,
"spend": 4230230000,
"spend_amount": 4230.23,
"swipes": 11759
},
"timeseries": []
}List ad accounts
List every ad account you can reach, across your organizations, with its currency, time zone and your roles on it.
Inputs
None.
Outputs
ad_accountslist- The ad accounts
countnumber- How many
Example output
{
"ad_accounts": [
{
"created_at": "2026-10-17T20:14:57.012Z",
"currency": "USD",
"id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"name": "Hooli Test Ad Account",
"organization_id": "40d6719b-da09-410b-9185-0cc9c0dfed1d",
"organization_name": "Hooli Inc",
"roles": [
"admin"
],
"status": "ACTIVE",
"timezone": "America/Los_Angeles",
"type": "PARTNER",
"updated_at": "2026-10-17T20:14:57.012Z"
}
],
"count": 1
}List ad squads
List the ad squads in an ad account, or in one campaign, most recently changed first, with their budgets, bids and targeting.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtext - Only ad squads in this campaign. Leave empty for the whole ad account.
- Status
statustext - Only active ones, or only paused ones. Leave empty for both.One of:
ACTIVE(Active only),PAUSED(Paused only). - Most to return
limitnumber - How many to return at most, newest changes first. Defaults to 100.From 1 to 1000.
Outputs
ad_squadslist- The ad squads
countnumber- How many were returned
has_moretrue/false- True when there were more than the limit
Example output
{
"ad_squads": [
{
"bid": 1.0,
"bid_micro": 1000000,
"bid_strategy": "LOWEST_COST_WITH_MAX_BID",
"billing_event": "IMPRESSION",
"campaign_id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"created_at": "2026-10-17T20:14:57.012Z",
"daily_budget": 20.0,
"daily_budget_micro": 20000000,
"delivery_constraint": "DAILY_BUDGET",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"lifetime_budget": 0.0,
"lifetime_budget_micro": 0,
"name": "Ad Squad Uno",
"optimization_goal": "IMPRESSIONS",
"pixel_id": "",
"placement_v2": {
"config": "AUTOMATIC"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"targeting": {
"geos": [
{
"country_code": "us"
}
]
},
"type": "SNAP_ADS",
"updated_at": "2026-10-17T20:14:57.012Z"
}
],
"count": 1,
"has_more": false
}List ads
List the ads in an ad account, campaign or ad squad, most recently changed first, with their status and review result (and why Snapchat rejected one).
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtext - Only ads in this campaign.
- Ad squad
ad_squad_idtext - Only ads in this ad squad.
- Status
statustext - Only active ones, or only paused ones. Leave empty for both.One of:
ACTIVE(Active only),PAUSED(Paused only). - Review
review_statustext - Only approved, waiting or rejected ads. Leave empty for all.One of:
APPROVED,PENDING(Waiting for review),REJECTED. - Most to return
limitnumber - How many to return at most, newest changes first. Defaults to 100.From 1 to 1000.
Outputs
adslist- The ads
countnumber- How many were returned
has_moretrue/false- True when there were more than the limit
Example output
{
"ads": [
{
"ad_squad_id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"created_at": "2026-10-17T20:14:57.012Z",
"creative_id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"id": "e8d6217f-32ab-400f-9e54-39a86a7963e4",
"name": "Ad One",
"render_type": "STATIC",
"review_status": "PENDING",
"review_status_reasons": [],
"status": "PAUSED",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
}
],
"count": 1,
"has_more": false
}List audiences
List an ad account's audiences, with about how many Snapchatters each matched and whether ads can target it yet.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Most to return
limitnumber - How many to return at most, newest changes first. Defaults to 100.From 1 to 1000.
Outputs
audienceslist- The audiences
countnumber- How many were returned
has_moretrue/false- True when there were more than the limit
Example output
{
"audiences": [
{
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"approximate_number_users": 0,
"created_at": "2026-10-17T20:14:57.012Z",
"description": "all the sams in the world",
"id": "5677923948298240",
"name": "all the sams in the world",
"retention_in_days": 180,
"source_type": "FIRST_PARTY",
"status": "ACTIVE",
"targetable_status": "NOT_READY",
"updated_at": "2026-10-17T20:14:57.012Z",
"upload_status": "NO_UPLOAD"
}
],
"count": 1,
"has_more": false
}List campaigns
List an ad account's campaigns, most recently changed first, with their status, budgets and dates.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Status
statustext - Only active ones, or only paused ones. Leave empty for both.One of:
ACTIVE(Active only),PAUSED(Paused only). - Most to return
limitnumber - How many to return at most, newest changes first. Defaults to 100.From 1 to 1000.
Outputs
campaignslist- The campaigns
countnumber- How many were returned
has_moretrue/false- True when there were more than the limit
Example output
{
"campaigns": [
{
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"buy_model": "AUCTION",
"created_at": "2026-10-17T20:14:57.012Z",
"creation_state": "PUBLISHED",
"daily_budget": 50.0,
"daily_budget_micro": 50000000,
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"lifetime_spend_cap": 500.0,
"lifetime_spend_cap_micro": 500000000,
"name": "Badger Tunneling Campaign",
"objective": "BRAND_AWARENESS",
"objective_v2_properties": {
"objective_v2_type": "AWARENESS_AND_ENGAGEMENT"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"updated_at": "2026-10-17T20:14:57.012Z"
}
],
"count": 1,
"has_more": false
}List creatives
List the creatives in an ad account's Creative Library, with their type and review result.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Review
review_statustext - Only approved, waiting or rejected creatives. Leave empty for all.One of:
APPROVED,PENDING_REVIEW(Waiting for review),DISAPPROVED(Rejected). - Most to return
limitnumber - How many to return at most, newest changes first. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many were returned
creativeslist- The creatives
has_moretrue/false- True when there were more than the limit
Example output
{
"count": 1,
"creatives": [
{
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"brand_name": "Example Inc",
"call_to_action": "",
"created_at": "2026-10-17T20:14:57.012Z",
"headline": "For all Citrus Fans",
"id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"name": "Creative Creative",
"packaging_status": "SUCCESS",
"review_status": "APPROVED",
"shareable": true,
"top_snap_media_id": "a7bee653-1865-41cf-8cee-8ab85a205837",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
}
],
"has_more": false
}Pause or activate campaign
Pause a campaign so it stops spending, or make it active again. Nothing changes if it is already that way.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
- Status
statustextRequired - Paused stops the campaign's ads; active lets them run.One of:
PAUSED,ACTIVE.
Outputs
campaignobject- A campaign
changedtrue/false- False if the campaign was already that way
Example output
{
"campaign": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"buy_model": "AUCTION",
"created_at": "2026-10-17T20:14:57.012Z",
"creation_state": "PUBLISHED",
"daily_budget": 50.0,
"daily_budget_micro": 50000000,
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"lifetime_spend_cap": 500.0,
"lifetime_spend_cap_micro": 500000000,
"name": "Badger Tunneling Campaign",
"objective": "BRAND_AWARENESS",
"objective_v2_properties": {
"objective_v2_type": "AWARENESS_AND_ENGAGEMENT"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"changed": true
}Remove people from audience
Remove people from a customer list audience by email, phone number or mobile ad id, such as when they unsubscribe. They are hashed the same way.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Audience
audience_idtextRequired - The customer list audience. Pick one, or give its id from an earlier step.
- Identify people by
identifier_typetext - What the list holds. Defaults to email addresses.One of:
EMAIL(Email addresses),PHONE(Phone numbers),MOBILE_AD_ID(Mobile ad ids (IDFA or Android advertising id)). Default:EMAIL. - People
identifierslistRequired - The email addresses, phone numbers (with the country code) or mobile ad ids, as a list or one per line. Lodol hashes them before sending, as Snapchat requires.
Outputs
acceptednumber- How many Snapchat says it took
audience_idtext- The audience
audience_nametext- The audience's name
identifier_typetext- EMAIL, PHONE or MOBILE_AD_ID
sentnumber- How many distinct people were sent to remove
skippednumber- Entries left out because they weren't valid or were repeats
Example output
{
"accepted": 2,
"audience_id": "5677923948298240",
"audience_name": "all the sams in the world",
"identifier_type": "EMAIL",
"sent": 2,
"skipped": 0
}Update ad
Rename an ad, or pause or activate it. Only what you fill in changes.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad
ad_idtextRequired - The ad. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Status
statustext - Pause it, or make it active. Leave empty to keep it as it is.One of:
PAUSED,ACTIVE.
Outputs
adobject- An ad
changedlist- The fields that changed; empty when nothing needed to
Example output
{
"ad": {
"ad_squad_id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"created_at": "2026-10-17T20:14:57.012Z",
"creative_id": "c1e6e929-acec-466f-b023-852b8cacc18f",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"id": "e8d6217f-32ab-400f-9e54-39a86a7963e4",
"name": "Ad One",
"render_type": "STATIC",
"review_status": "PENDING",
"review_status_reasons": [],
"status": "ACTIVE",
"type": "SNAP_AD",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"changed": [
"status"
]
}Update ad squad
Change an ad squad's name, status, budget, bid, end or countries. Only the fields you fill in change.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Ad squad
ad_squad_idtextRequired - The ad squad. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Status
statustext - Pause it, or make it active. Leave empty to keep it as it is.One of:
PAUSED,ACTIVE. - Daily budget
daily_budgetnumber - A new daily budget, in the ad account's currency. Leave empty to keep it.
- Lifetime budget
lifetime_budgetnumber - A new lifetime budget, in the ad account's currency. Leave empty to keep it.
- Bid
bid_amountnumber - A new bid, in the ad account's currency. Leave empty to keep it.
- End
end_timedate and time - A new end. Leave empty to keep it.
- Countries
countrieslist - New countries to show the ads in, replacing the current ones. Changing them sends the ads back for review. Leave empty to keep them.
Outputs
ad_squadobject- An ad squad
changedlist- The fields that changed; empty when nothing needed to
Example output
{
"ad_squad": {
"bid": 1.0,
"bid_micro": 1000000,
"bid_strategy": "LOWEST_COST_WITH_MAX_BID",
"billing_event": "IMPRESSION",
"campaign_id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"created_at": "2026-10-17T20:14:57.012Z",
"daily_budget": 30.0,
"daily_budget_micro": 30000000,
"delivery_constraint": "DAILY_BUDGET",
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "69cde0e6-0ccb-4982-8fce-1fa33507f213",
"lifetime_budget": 0.0,
"lifetime_budget_micro": 0,
"name": "Ad Squad Uno",
"optimization_goal": "IMPRESSIONS",
"pixel_id": "",
"placement_v2": {
"config": "AUTOMATIC"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"targeting": {
"geos": [
{
"country_code": "us"
}
]
},
"type": "SNAP_ADS",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"changed": [
"daily_budget_micro"
]
}Update campaign
Change a campaign's name, dates, daily budget or lifetime spending limit. Only the fields you fill in change.
Inputs
- Ad account
ad_account_idtextRequired - The ad account. Pick one, or give its id from an earlier step.
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Start
start_timedate and time - A new start. Leave empty to keep it.
- End
end_timedate and time - A new end. Leave empty to keep it.
- Daily budget
daily_budgetnumber - A new daily budget, in the ad account's currency. Leave empty to keep it.
- Lifetime spending limit
lifetime_spend_capnumber - A new lifetime spending limit, in the ad account's currency. It can't go below 1.1 times what the campaign has spent. Leave empty to keep it.
Outputs
campaignobject- A campaign
changedlist- The fields that changed; empty when nothing needed to
Example output
{
"campaign": {
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"buy_model": "AUCTION",
"created_at": "2026-10-17T20:14:57.012Z",
"creation_state": "PUBLISHED",
"daily_budget": 50.0,
"daily_budget_micro": 50000000,
"delivery_status": [
"INVALID_NOT_ACTIVE"
],
"end_time": "2026-12-22T21:42:02.392Z",
"id": "7c074b60-3ae7-4975-bc1d-5785cc0be2c8",
"lifetime_spend_cap": 500.0,
"lifetime_spend_cap_micro": 500000000,
"name": "Badger Tunneling Campaign V2",
"objective": "BRAND_AWARENESS",
"objective_v2_properties": {
"objective_v2_type": "AWARENESS_AND_ENGAGEMENT"
},
"start_time": "2026-11-22T21:42:02.392Z",
"status": "PAUSED",
"updated_at": "2026-10-17T20:14:57.012Z"
},
"changed": [
"name"
]
}