> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Reddit Ads

> Reddit Ads API for managing advertising campaigns, conversions, and account data on Reddit

Reddit Ads API for managing advertising campaigns, conversions, and account data on Reddit.

`reddit-ads` · **83 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth reddit-ads
run auth reddit-ads --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run reddit-ads          # common commands
run reddit-ads --all    # every command
```

```ts theme={"theme":"github-dark"}
import { redditAds } from "@boxd/run";
```

## Common tools

| Tool                             | What it does                                                                                                                                                             |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `do-geolocation-validations`     | Tool to validate a list of geolocations for use in Reddit Ads targeting.                                                                                                 |
| `get-ad-account`                 | Tool to retrieve details for a specific Reddit ad account by ID.                                                                                                         |
| `get-ad-group`                   | Tool to get an ad group by its ID from Reddit Ads API. Use when you need to retrieve details about a specific ad group.                                                  |
| `get-app-last-fired-at`          | Tool to retrieve the last time mobile conversion events were fired for a specific app ID.                                                                                |
| `get-report`                     | Tool to generate a metrics report for ad performance based on specified fields and breakdowns.                                                                           |
| `get-business`                   | Tool to get business details by ID from the Reddit Ads API. Use when you need to retrieve information about a specific business entity including its...                  |
| `get-campaign`                   | Retrieve a specific Reddit Ads campaign by its ID. Returns comprehensive campaign information including objective, status, budget, targeting, and optimization settings. |
| `get-channel-planning-reach`     | Tool to retrieve estimated reach data for a given set of targeting parameters.                                                                                           |
| `get-child-funding-instruments`  | Tool to retrieve a list of Funding Instrument Allocations for a parent funding instrument.                                                                               |
| `get-custom-audience`            | Tool to retrieve a custom audience by ID from Reddit Ads API.                                                                                                            |
| `get-lead-gen-form`              | Tool to retrieve details for a specific lead generation form by ID from Reddit Ads.                                                                                      |
| `get-me`                         | Tool to get the authenticated member's information from the Reddit Ads API.                                                                                              |
| `get-pixel-last-fired-at`        | Tool to retrieve the last time conversion events were fired for a specific conversion pixel.                                                                             |
| `get-post`                       | Tool to retrieve a promoted or organic Reddit post by its ID.                                                                                                            |
| `get-product-catalog`            | Tool to retrieve a specific product catalog by ID from the Reddit Ads API.                                                                                               |
| `get-product-feed`               | Tool to retrieve metadata for a specific product feed by ID.                                                                                                             |
| `get-product-set`                | Tool to retrieve metadata for a specific product set by ID from the Reddit Ads API.                                                                                      |
| `get-profile`                    | Tool to retrieve details for a specific profile by ID from the Reddit Ads API.                                                                                           |
| `get-saved-audience`             | Tool to retrieve a saved audience by ID from Reddit Ads API.                                                                                                             |
| `get-sk-ad-network-availability` | Tool to get SKAdNetwork IDs availability quota for an iOS app.                                                                                                           |
| `list-ad-accounts-by-business`   | Tool to get a list of ad accounts under a business on Reddit Ads.                                                                                                        |
| `list-ad-groups`                 | Tool to list ad groups for a Reddit ad account. Use when you need to retrieve ad groups for campaign management.                                                         |
| `list-campaigns`                 | Tool to list campaigns by ad account with pagination support.                                                                                                            |
| `list-carriers`                  | Tool to retrieve all available carriers from Reddit Ads API for targeting purposes.                                                                                      |
| `list-communities`               | Tool to list targetable communities matched by their names. Use when you need to find Reddit communities (subreddits) available for ad targeting.                        |

<Accordion title="All 83 tools" icon="list">
  | Tool                                    | What it does                                                                                                                                                             |
  | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `create-ad-group`                       | Tool to create a new ad group within a Reddit Ads campaign. Use when setting up ad groups with specific bidding strategies, budget goals, and targeting criteria.        |
  | `create-batch-products`                 | Tool to create or update multiple products in a catalog in a single batch operation.                                                                                     |
  | `create-campaign`                       | Tool to create a new Reddit Ads campaign for the specified ad account.                                                                                                   |
  | `create-custom-audience`                | Tool to create a new Custom Audience in Reddit Ads. Use when you need to create a custom audience for targeted advertising campaigns.                                    |
  | `create-lead-gen-form`                  | Tool to create a new lead generation form in Reddit Ads. Use when you need to set up a lead gen form to collect user information such as emails...                       |
  | `create-post`                           | Tool to create a new Reddit post for a specified profile. Use when you need to create promotional content including text, images, videos, or carousel posts.             |
  | `create-product-catalog`                | Tool to create a new product catalog. Use when you need to set up a product catalog for Reddit Ads.                                                                      |
  | `create-product-feed`                   | Tool to create a new feed for a product catalog. Use when setting up product feeds for Reddit catalog sales campaigns.                                                   |
  | `create-product-set`                    | Tool to create a new product set in a product catalog. Use when you need to define a subset of products from a catalog using filter rules for targeted advertising.      |
  | `create-saved-audience`                 | Tool to create a saved audience for a Reddit Ads ad account with targeting criteria.                                                                                     |
  | `create-structured-post-creation-job`   | Tool to create a structured post creation job on Reddit Ads.                                                                                                             |
  | `delete-custom-audience`                | Tool to delete a Custom Audience by ID from Reddit Ads. Use when you need to permanently remove a custom audience.                                                       |
  | `delete-product-catalog`                | Tool to delete a product catalog by ID from Reddit Ads. Use when you need to permanently remove a catalog.                                                               |
  | `delete-product-feed`                   | Tool to delete a feed in a catalog by ID from Reddit Ads. Use when you need to permanently remove a product feed.                                                        |
  | `delete-products`                       | Tool to delete multiple products from a Reddit Ads product catalog in a single request.                                                                                  |
  | `delete-product-set`                    | Tool to delete a product set by ID from Reddit Ads. Use when you need to permanently remove a product set.                                                               |
  | `do-geolocation-validations`            | Tool to validate a list of geolocations for use in Reddit Ads targeting.                                                                                                 |
  | `do-keyword-validations`                | Tool to validate a list of keywords for targeting and check their brand safety status.                                                                                   |
  | `generate-inspiration-creative-summary` | Tool to get AI-generated summary of best practices followed by an inspiration creative ad.                                                                               |
  | `get-ad-account`                        | Tool to retrieve details for a specific Reddit ad account by ID.                                                                                                         |
  | `get-ad-account-history`                | Get changelog history for a Reddit ad account with filtering options.                                                                                                    |
  | `get-ad-group`                          | Tool to get an ad group by its ID from Reddit Ads API. Use when you need to retrieve details about a specific ad group.                                                  |
  | `get-app-last-fired-at`                 | Tool to retrieve the last time mobile conversion events were fired for a specific app ID.                                                                                |
  | `get-report`                            | Tool to generate a metrics report for ad performance based on specified fields and breakdowns.                                                                           |
  | `get-business`                          | Tool to get business details by ID from the Reddit Ads API. Use when you need to retrieve information about a specific business entity including its...                  |
  | `get-campaign`                          | Retrieve a specific Reddit Ads campaign by its ID. Returns comprehensive campaign information including objective, status, budget, targeting, and optimization settings. |
  | `get-channel-planning-reach`            | Tool to retrieve estimated reach data for a given set of targeting parameters.                                                                                           |
  | `get-child-funding-instruments`         | Tool to retrieve a list of Funding Instrument Allocations for a parent funding instrument.                                                                               |
  | `get-custom-audience`                   | Tool to retrieve a custom audience by ID from Reddit Ads API.                                                                                                            |
  | `get-lead-gen-form`                     | Tool to retrieve details for a specific lead generation form by ID from Reddit Ads.                                                                                      |
  | `get-me`                                | Tool to get the authenticated member's information from the Reddit Ads API.                                                                                              |
  | `get-pixel-last-fired-at`               | Tool to retrieve the last time conversion events were fired for a specific conversion pixel.                                                                             |
  | `get-post`                              | Tool to retrieve a promoted or organic Reddit post by its ID.                                                                                                            |
  | `get-product-catalog`                   | Tool to retrieve a specific product catalog by ID from the Reddit Ads API.                                                                                               |
  | `get-product-feed`                      | Tool to retrieve metadata for a specific product feed by ID.                                                                                                             |
  | `get-product-set`                       | Tool to retrieve metadata for a specific product set by ID from the Reddit Ads API.                                                                                      |
  | `get-profile`                           | Tool to retrieve details for a specific profile by ID from the Reddit Ads API.                                                                                           |
  | `get-saved-audience`                    | Tool to retrieve a saved audience by ID from Reddit Ads API.                                                                                                             |
  | `get-sk-ad-network-availability`        | Tool to get SKAdNetwork IDs availability quota for an iOS app.                                                                                                           |
  | `get-structured-post`                   | Tool to retrieve a structured post by its ID from the Reddit Ads API.                                                                                                    |
  | `list3rd-party-audiences`               | Tool to retrieve all available 3rd party audiences from Reddit Ads API for targeting purposes.                                                                           |
  | `list-ad-accounts-by-business`          | Tool to get a list of ad accounts under a business on Reddit Ads.                                                                                                        |
  | `list-ad-groups`                        | Tool to list ad groups for a Reddit ad account. Use when you need to retrieve ad groups for campaign management.                                                         |
  | `list-ads`                              | Tool to list ads by ad account on Reddit Ads platform. Use when you need to retrieve advertising campaigns for a specific ad account.                                    |
  | `list-campaigns`                        | Tool to list campaigns by ad account with pagination support.                                                                                                            |
  | `list-carriers`                         | Tool to retrieve all available carriers from Reddit Ads API for targeting purposes.                                                                                      |
  | `list-catalog-imports`                  | Tool to retrieve all imports for a catalog. Use when you need to list import history and status for a specific product catalog.                                          |
  | `list-communities`                      | Tool to list targetable communities matched by their names. Use when you need to find Reddit communities (subreddits) available for ad targeting.                        |
  | `list-communities-suggestions`          | Tool to fetch suggested communities for given community names from Reddit Ads API.                                                                                       |
  | `list-devices`                          | Tool to retrieve all available devices from Reddit Ads API for targeting purposes.                                                                                       |
  | `list-funding-instruments`              | Tool to list funding instruments (payment methods) for a Reddit Ads ad account.                                                                                          |
  | `list-geolocations`                     | Tool to fetch a list of geolocations from Reddit Ads API. Use when you need geographic targeting options.                                                                |
  | `list-industries`                       | Tool to retrieve all available industries from Reddit Ads API.                                                                                                           |
  | `list-interests`                        | Tool to retrieve all available interests from Reddit Ads API for targeting purposes.                                                                                     |
  | `list-lead-gen-forms`                   | Tool to list lead generation forms for a Reddit Ads ad account.                                                                                                          |
  | `list-my-businesses`                    | Tool to retrieve details of businesses associated with the provided access token.                                                                                        |
  | `list-pixels-by-ad-account`             | Tool to list pixels by ad account. Use when you need to retrieve conversion pixels for a specific Reddit Ads account.                                                    |
  | `list-pixels-by-business`               | Tool to list all pixels associated with a specific business.                                                                                                             |
  | `list-posts`                            | Tool to list up to 1,000 of the most recent posts for a specified profile.                                                                                               |
  | `list-product-catalogs`                 | Tool to retrieve details for all product catalogs belonging to a business.                                                                                               |
  | `list-product-feeds`                    | Tool to retrieve metadata for all feeds in a product catalog.                                                                                                            |
  | `list-product-sets`                     | Tool to retrieve all product sets in a catalog. Use when you need to list product sets for a specific catalog ID.                                                        |
  | `list-products-in-product-catalog`      | Tool to retrieve all products in a Reddit Ads product catalog.                                                                                                           |
  | `list-products-in-product-set`          | Tool to retrieve all products in a Reddit Ads product set. Use when you need to list products within a specific product set, with optional filtering...                  |
  | `list-profiles-by-ad-account`           | Tool to list profiles by ad account from Reddit Ads API. Use when you need to retrieve all profiles associated with a specific ad account.                               |
  | `list-profiles-by-business`             | Tool to list profiles by business. Use when you need to retrieve all profiles associated with a specific business.                                                       |
  | `list-saved-audiences`                  | Tool to list saved audiences for a Reddit ad account. Use when you need to retrieve saved audience configurations with their targeting details.                          |
  | `list-structured-posts`                 | Tool to list structured posts for a profile or retrieve up to 10 specific structured posts by ID.                                                                        |
  | `list-time-zones`                       | Tool to retrieve all available time zones from Reddit Ads API for campaign scheduling.                                                                                   |
  | `list-user-custom-audiences`            | Tool to list all Custom Audiences under an ad account. Use when you need to retrieve custom audiences for targeting in Reddit Ads campaigns.                             |
  | `query-ad-accounts`                     | Tool to query ad accounts by business with optional filtering by actors, assets, roles, or custom filter string.                                                         |
  | `query-funding-instruments-by-business` | Query funding instruments (credit lines) by business with pagination support.                                                                                            |
  | `search-communities`                    | Tool to search for Reddit communities based on their name or topic.                                                                                                      |
  | `update-ad-account`                     | Tool to update a Reddit ad account configuration. Use when you need to modify account settings like name, attribution windows, excluded...                               |
  | `update-business`                       | Tool to update a business by ID in Reddit Ads. Use when you need to modify business settings such as name, industry, country, or contact information.                    |
  | `update-campaign`                       | Tool to update a campaign by ID in Reddit Ads. Use when you need to modify campaign settings such as name, status, budget, or targeting parameters.                      |
  | `update-custom-audience-users`          | Tool to update users in a Reddit Ads Custom Audience by adding or removing user identifiers.                                                                             |
  | `update-post`                           | Tool to update a Reddit post by ID. Use when you need to modify post settings like enabling/disabling comments.                                                          |
  | `update-product-catalog`                | Tool to update a product catalog's name or attached Pixel IDs in Reddit Ads.                                                                                             |
  | `update-product-feed`                   | Tool to update a product feed's metadata in Reddit Ads. Use when you need to modify feed properties such as name, URL, mode, authentication...                           |
  | `update-product-set`                    | Tool to update a product set's name and filter rules in Reddit Ads.                                                                                                      |
  | `update-saved-audience`                 | Tool to update a saved audience by ID in Reddit Ads. Use when you need to modify saved audience settings such as name, targeting criteria, or status.                    |
  | `update-structured-post`                | Tool to update a structured post by ID. Only allow\_comments can be updated on an existing structured post.                                                              |
</Accordion>

[Open Reddit Ads in the console →](https://app.boxd.sh/integrations/detail/reddit_ads)
