# Snapchat Ads

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

App · 26 actions. Web page: https://docs.lodol.com/docs/integrations/snapchat-ads

## Actions

### 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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Audience (`audience_id`, text, required): The customer list audience. Pick one, or give its id from an earlier step.
- Identify people by (`identifier_type`, text): 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 (`identifiers`, list, required): 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**

- `accepted` (number): How many Snapchat says it took
- `audience_id` (text): The audience
- `audience_name` (text): The audience's name
- `identifier_type` (text): EMAIL, PHONE or MOBILE_AD_ID
- `sent` (number): How many distinct people were sent to add
- `skipped` (number): Entries left out because they weren't valid or were repeats

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad squad (`ad_squad_id`, text, required): The ad squad. Pick one, or give its id from an earlier step.
- Creative (`creative_id`, text, required): The creative: the video or image with its headline, made in Ads Manager. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): A name to know it by in Ads Manager, up to 375 characters.
- Status (`status`, text): Paused (the default) until you turn it on, or active right away. One of: `PAUSED`, `ACTIVE`. Default: `PAUSED`.

**Outputs**

- `ad` (object): An ad
- `warnings` (list): Settings Snapchat suggests checking; empty when there are none

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): A name to know it by in Ads Manager, up to 375 characters.
- Countries (`countries`, list, required): Where the ads are shown. Pick one or more.
- Daily budget (`daily_budget`, number): 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_budget`, number): 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_goal`, text): 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_strategy`, text): 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_amount`, number): 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 (`status`, text): Paused (the default) until you turn it on, or active right away. One of: `PAUSED`, `ACTIVE`. Default: `PAUSED`.
- Start (`start_time`, date and time): When it starts delivering. Leave empty to start now.
- End (`end_time`, date and time): When it stops. Leave empty to run until you stop it.
- Placements (`placements`, list): 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_age`, number): Only people this age or older, 13 to 35. Leave empty for 13. From 13 to 35.
- Oldest age (`max_age`, number): Only people this age or younger, 13 to 55. Leave empty for no limit. From 13 to 55.
- Gender (`gender`, text): Only women, or only men. Leave empty for everyone. One of: `FEMALE` (Women), `MALE` (Men).
- Language (`language`, text): Only people who use Snapchat in this language. Snapchat asks for one when you pick more than one country.
- Audiences (`audience_ids`, list): Only people in these customer list audiences. Leave empty for anyone.
- Snap Pixel (`pixel_id`, text): 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_squad` (object): An ad squad
- `warnings` (list): Settings Snapchat suggests checking; empty when there are none

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): A name to know it by in Ads Manager, up to 375 characters.
- Description (`description`, text): A note on who is in it.
- Keep people for (days) (`retention_in_days`, number): How many days people stay in it, up to 9999. Leave empty to keep them for good. From 1 to 9999.

**Outputs**

- `audience` (object): A customer list audience
- `warnings` (list): Settings Snapchat suggests checking; empty when there are none

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): A name to know it by in Ads Manager, up to 375 characters.
- Objective (`objective`, text): 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 (`status`, text): Paused (the default) until you turn it on, or active right away. One of: `PAUSED`, `ACTIVE`. Default: `PAUSED`.
- Start (`start_time`, date and time): When it starts delivering. Leave empty to start now.
- End (`end_time`, date and time): When it stops. Leave empty to run until you stop it.
- Daily budget (`daily_budget`, number): 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_cap`, number): The most the campaign spends in total, in the ad account's currency. Snapchat's minimum is 20.

**Outputs**

- `campaign` (object): A campaign
- `warnings` (list): Settings Snapchat suggests checking; empty when there are none

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad (`ad_id`, text, required): The ad. Pick one, or give its id from an earlier step.

**Outputs**

- `ad_id` (text): The ad deleted
- `deleted` (true/false): True once deleted
- `name` (text): The ad's name

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad squad (`ad_squad_id`, text, required): The ad squad. Pick one, or give its id from an earlier step.

**Outputs**

- `ad_squad_id` (text): The ad squad deleted
- `deleted` (true/false): True once deleted
- `name` (text): The ad squad's name

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Audience (`audience_id`, text, required): The customer list audience. Pick one, or give its id from an earlier step.

**Outputs**

- `audience_id` (text): The audience deleted
- `deleted` (true/false): True once deleted
- `name` (text): The audience's name

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.

**Outputs**

- `campaign_id` (text): The campaign deleted
- `deleted` (true/false): True once deleted
- `name` (text): The campaign's name

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad (`ad_id`, text, required): The ad. Pick one, or give its id from an earlier step.

**Outputs**

- `ad` (object): An ad

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad squad (`ad_squad_id`, text, required): The ad squad. Pick one, or give its id from an earlier step.

**Outputs**

- `ad_squad` (object): An ad squad

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.

**Outputs**

- `campaign` (object): A campaign

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Creative (`creative_id`, text, required): The creative: the video or image with its headline, made in Ads Manager. Pick one, or give its id from an earlier step.

**Outputs**

- `creative` (object): A creative
- `preview_expires_at` (text): When the preview link stops working
- `preview_url` (text): A preview page anyone can open; empty if Snapchat has none

**Example output**

```json
{
  "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**

- `user` (object): The signed-in Snapchat member

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text): Stats for this campaign. Leave campaign, ad squad and ad empty for the whole ad account.
- Ad squad (`ad_squad_id`, text): Stats for this ad squad instead.
- Ad (`ad_id`, text): Stats for this ad instead.
- Show (`granularity`, text): 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_date`, date): First day to count, in the ad account's time zone. Leave both dates empty for everything so far (total only).
- To (`end_date`, date): Last day to count, included.
- Figures (`metrics`, list): 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 (`breakdown`, text): 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**

- `breakdown` (list): The figures for each campaign, ad squad or ad
- `end_date` (text): Last day counted; empty for everything so far
- `finalized_data_end_time` (text): Figures before this time are final; later ones may still change
- `granularity` (text): TOTAL, DAY or HOUR
- `id` (text): Its id
- `level` (text): What the stats are for: ad_account, campaign, ad_squad or ad
- `metrics` (list): The figures asked Snapchat for
- `note` (text): Anything to know about the figures
- `start_date` (text): First day counted; empty for everything so far
- `stats` (object): The totals, for a total without a breakdown
- `timeseries` (list): The figures day by day or hour by hour

**Example output**

```json
{
  "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_accounts` (list): The ad accounts
- `count` (number): How many

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text): Only ad squads in this campaign. Leave empty for the whole ad account.
- Status (`status`, text): Only active ones, or only paused ones. Leave empty for both. One of: `ACTIVE` (Active only), `PAUSED` (Paused only).
- Most to return (`limit`, number): How many to return at most, newest changes first. Defaults to 100. From 1 to 1000.

**Outputs**

- `ad_squads` (list): The ad squads
- `count` (number): How many were returned
- `has_more` (true/false): True when there were more than the limit

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text): Only ads in this campaign.
- Ad squad (`ad_squad_id`, text): Only ads in this ad squad.
- Status (`status`, text): Only active ones, or only paused ones. Leave empty for both. One of: `ACTIVE` (Active only), `PAUSED` (Paused only).
- Review (`review_status`, text): Only approved, waiting or rejected ads. Leave empty for all. One of: `APPROVED`, `PENDING` (Waiting for review), `REJECTED`.
- Most to return (`limit`, number): How many to return at most, newest changes first. Defaults to 100. From 1 to 1000.

**Outputs**

- `ads` (list): The ads
- `count` (number): How many were returned
- `has_more` (true/false): True when there were more than the limit

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Most to return (`limit`, number): How many to return at most, newest changes first. Defaults to 100. From 1 to 1000.

**Outputs**

- `audiences` (list): The audiences
- `count` (number): How many were returned
- `has_more` (true/false): True when there were more than the limit

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Status (`status`, text): Only active ones, or only paused ones. Leave empty for both. One of: `ACTIVE` (Active only), `PAUSED` (Paused only).
- Most to return (`limit`, number): How many to return at most, newest changes first. Defaults to 100. From 1 to 1000.

**Outputs**

- `campaigns` (list): The campaigns
- `count` (number): How many were returned
- `has_more` (true/false): True when there were more than the limit

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Review (`review_status`, text): Only approved, waiting or rejected creatives. Leave empty for all. One of: `APPROVED`, `PENDING_REVIEW` (Waiting for review), `DISAPPROVED` (Rejected).
- Most to return (`limit`, number): How many to return at most, newest changes first. Defaults to 100. From 1 to 1000.

**Outputs**

- `count` (number): How many were returned
- `creatives` (list): The creatives
- `has_more` (true/false): True when there were more than the limit

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.
- Status (`status`, text, required): Paused stops the campaign's ads; active lets them run. One of: `PAUSED`, `ACTIVE`.

**Outputs**

- `campaign` (object): A campaign
- `changed` (true/false): False if the campaign was already that way

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Audience (`audience_id`, text, required): The customer list audience. Pick one, or give its id from an earlier step.
- Identify people by (`identifier_type`, text): 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 (`identifiers`, list, required): 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**

- `accepted` (number): How many Snapchat says it took
- `audience_id` (text): The audience
- `audience_name` (text): The audience's name
- `identifier_type` (text): EMAIL, PHONE or MOBILE_AD_ID
- `sent` (number): How many distinct people were sent to remove
- `skipped` (number): Entries left out because they weren't valid or were repeats

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad (`ad_id`, text, required): The ad. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Status (`status`, text): Pause it, or make it active. Leave empty to keep it as it is. One of: `PAUSED`, `ACTIVE`.

**Outputs**

- `ad` (object): An ad
- `changed` (list): The fields that changed; empty when nothing needed to

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Ad squad (`ad_squad_id`, text, required): The ad squad. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Status (`status`, text): Pause it, or make it active. Leave empty to keep it as it is. One of: `PAUSED`, `ACTIVE`.
- Daily budget (`daily_budget`, number): A new daily budget, in the ad account's currency. Leave empty to keep it.
- Lifetime budget (`lifetime_budget`, number): A new lifetime budget, in the ad account's currency. Leave empty to keep it.
- Bid (`bid_amount`, number): A new bid, in the ad account's currency. Leave empty to keep it.
- End (`end_time`, date and time): A new end. Leave empty to keep it.
- Countries (`countries`, list): 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_squad` (object): An ad squad
- `changed` (list): The fields that changed; empty when nothing needed to

**Example output**

```json
{
  "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_id`, text, required): The ad account. Pick one, or give its id from an earlier step.
- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Start (`start_time`, date and time): A new start. Leave empty to keep it.
- End (`end_time`, date and time): A new end. Leave empty to keep it.
- Daily budget (`daily_budget`, number): A new daily budget, in the ad account's currency. Leave empty to keep it.
- Lifetime spending limit (`lifetime_spend_cap`, number): 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**

- `campaign` (object): A campaign
- `changed` (list): The fields that changed; empty when nothing needed to

**Example output**

```json
{
  "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"
  ]
}
```
