Reddit Custom Audiences API

openapi: 3.2.0
info:
  title: Reddit Advertising Custom Audiences API
  version: '3'
  x-logo:
    url: https://www.redditstatic.com/desktop2x/img/favicon/favicon-32x32.png
  description: '## Ads API terms


    By accessing or using the Ads API and/or associated Reddit Data, you are agreeing that you have read, and that you Agree to comply with and to be bound by, the Ads API Terms and all applicable laws and regulations in their entirety without limitation or qualification. The Ads API Terms apply to and govern your access to and use of the Ads API and Reddit Data, constitute a legally binding agreement between you and Reddit, and include certain terms that are defined in the Advertising Platform Terms, Developer Terms, and User Agreement. You may use the Ads API and Reddit Data only in accordance with the Ads API Terms. Use of the Conversions API is subject to the Advertiser Measurement Program Terms in addition to the same agreements as the Ads API. If you do not agree to the Ads API Terms, and Advertiser Measurement Program Terms as applicable, then you must not access or use the Ads API, Conversions API, or Reddit Data. **Note:** The Reddit Ads API is open to all developers and **does not require allowlisting or approval from Reddit to access**. Get started with the API. API partners working on behalf of advertisers can request support by contacting us. See our supported partners. ## Overview


    The Reddit Ads API lets advertisers tap into the Reddit Ads Platform to build and manage advertising campaigns and accounts programmatically. By integrating Reddit Ads API into your tooling, you can streamline workflows, reduce operational overhead, and accelerate the creation, optimization, and reporting of Reddit campaigns without needing to step into the Reddit Ads Manager directly. All API applications must be authenticated with OAuth2 by creating a developer application and obtaining access and refresh tokens. !v3 ERD diagram


    Here are two popular ways to use the Reddit Ads API:


    - **Postman:** A visual client that makes it simpler to set up and start testing requests and responses. This is the fastest way to familiarize yourself with the API if you prefer a point-and-click approach. You can explore our Postman collections. - **Programmatic access:** Use your preferred programming language or command-line tools to create automations and integrations. This approach is ideal if you want to embed API calls into your workflows or build custom tools. ### User agents


    Rate-limiting issues often occur if you haven''t set your user agent to a unique descriptor. Many default user agents (like `“Python/urllib”` or `“Java”`) are drastically limited to encourage unique and descriptive user-agent strings. We recommend following this format for your client''s user agent string:


    ```

    {{Target platform}}:{{Unique app ID}}:{{Version string}} (by /u/{{Your Reddit username}})

    ```


    > **Note:** Including your version number helps us block old buggy or broken versions of your app safely. Just remember to update this string when you update your version number. Example


    ```

    User-Agent: android:com.example.myredditapp:v1.2.3 (by /u/kemitche)

    ```


    > **Important:** Never lie about your user agent! Don''t pretend to be popular browsers or other bots. We''ll ban anyone caught in the act. ### Pagination


    Paginated endpoints respond with a `pagination` object containing up to 2 fields:


    > **Important:** The URLs for these fields should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs. - **`next_url`:** The full URL to access the next page of the response. If not available, the current page is the final page. - **`previous_url`:** The full URL to access the previous page of the response. If not available, the current page is the first page. All endpoints that return a list, such as `List Campaigns` and `Get a Report`, will be paginated. ### Response types


    Response | Description

    --- | ---

    200 | Successfully processed the request. 400 | Request was invalid. See the client error message for specifics. 401 | No bearer token or a bad bearer token was provided. Check your application authentication.'
servers:
- url: https://ads-api.reddit.com/api/v3
  description: Reddit AdsAPI Production
tags:


# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/reddit/openapi/reddit-custom-audiences-api-openapi.yml