Reddit Lead Generation Forms API

openapi: 3.2.0
info:
  title: Reddit Advertising Lead Generation Forms 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:
- name: Lead Generation Forms
  description: Information about lead generation forms.
paths:
  /ad_accounts/{ad_account_id}/lead_gen_forms:
    get:
      description: 'Retrieve the lead generation forms in an ad account.

        Rate Limit


        See the rate limits for Leads


        Policy Slug: ads-leads


        Window: 60 seconds


        Quota: 20 requests'
      operationId: list_lead_gen_forms
      summary: List Lead Generation Forms
      parameters:
      - description: The ad account ID.
        in: path
        name: ad_account_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/components_parameters_page_token'
      - $ref: '#/components/parameters/components_parameters_page_size'
      responses:
        '200':
          description: A list of lead generation forms.
          content:
            application/json:
              schema:
                type: object
                title: ListLeadGenFormsResponse
                additionalProperties: false
                required:
                - data
                - pagination
                properties:
                  data:
                    type: array
                    title: LeadGenFormsList
                    items:
                      $ref: '#/components/schemas/components_schema_lead_gen_form'
                  pagination:
                    $ref: '#/components/schemas/components_schema_pagination'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
      - RedditAPIKey:
        - adsread
      tags:
      - Lead Generation Forms
    post:
      deprecated: true
      description: 'Create a lead generation form for an ad account. Use a form to collect responses from people who interact with an associated lead generation ad.


        > **Note:** Starting September 30, 2026 at 00:00 UTC, this operation returns `410 Gone`. Set up an offsite lead generation campaign instead.


        Rate Limit


        See the rate limits for Leads


        Policy Slug: ads-leads


        Window: 60 seconds


        Quota: 20 requests'
      operationId: create_lead_gen_form
      summary: Create Lead Generation Form
      parameters:
      - description: The ad account ID.
        in: path
        name: ad_account_id
        required: true
        schema:
          type: string
      requestBody:
        description: Data for the lead generation form.
        required: true
        content:
          application/json:
            schema:
              type: object
              title: CreateLeadGenFormRequest
              additionalProperties: false
              required:
              - data
              properties:
                data:
                  required:
                  - name
                  - privacy_link
                  - prompt
                  - questions
                  $ref: '#/components/schemas/components_schema_lead_gen_form'
      responses:
        '201':
          description: A lead generation form.
          content:
            application/json:
              schema:
                type: object
                title: CreateLeadGenFormResponse
                additionalProperties: false
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/components_schema_lead_gen_form'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '410':
          $ref: '#/components/responses/Gone'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
      - RedditAPIKey:
        - adsedit
      tags:
      - Lead Generation Forms
  /lead_gen_forms/{lead_gen_form_id}:
    get:
      description: 'Retrieve a lead generation form.

        Rate Limit


        See the rate limits for Leads


        Policy Slug: ads-leads


        Window: 60 seconds


        Quota: 20 requests'
      operationId: get_lead_gen_form
      summary: Get Lead Generation Form
      parameters:
      - description: The form ID.
        in: path
        name: lead_gen_form_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The lead generation form.
          content:
            application/json:
              schema:
                type: object
                title: LeadGenFormsResponse
                additionalProperties: false
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/components_schema_lead_gen_form'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
      - RedditAPIKey:
        - adsread
      tags:
      - Lead Generation Forms
components:
  schemas:
    components_schema_modified_at:
      title: Modified At
      description: When this entity was last changed ([ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)).
      example: '2023-03-27T21:18:39Z'
      type: string
      format: date-time
      readOnly: true
    components_errors_403:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Access not granted for listing profiles.
            code:
              type: integer
              description: The error code.
              examples:
              - 403
    components_errors_401:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad bearer token provided.
            code:
              type: integer
              description: The error code.
              examples:
              - 401
    components_schema_lead_gen_form:
      title: Lead Gen Form
      type: object
      additionalProperties: false
      properties:
        ad_account_id:
          $ref: '#/components/schemas/id-2'
          description: The ad account ID.
        id:
          description: The form's ID.
          examples:
          - '142154364526'
          type: string
          readOnly: true
        name:
          description: The form's name. Shown only in the Ads Manager.
          examples:
          - My Form
          type: string
        privacy_link:
          description: The privacy policy URL. Must start with `https`.
          examples:
          - https://www.example.com/privacy
          type: string
        prompt:
          description: The text shown at the top of your form and beside your ad's CTA.
          examples:
          - Fill out this form to get a free quote.
          type: string
        questions:
          description: 'A list of questions the user can fill out. At least one question must be required.

            > **Note:** Company emails and names aren''t validated by Reddit. Set up the [Reddit Leads Ads Zapier integration](https://business.reddithelp.com/s/article/set-up-the-reddit-lead-ads-zapier-integration) for validation.

            '
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/components_schema_lead_gen_form_question'
        created_at:
          $ref: '#/components/schemas/components_schema_created_at'
        modified_at:
          $ref: '#/components/schemas/components_schema_modified_at'
    components_schema_created_at:
      description: When this entity was created ([ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)).
      example: '2023-03-27T21:18:39Z'
      type: string
      format: date-time
      readOnly: true
    components_errors_500:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 500
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Internal Server Error
    id-2:
      description: The ad account ID.
      examples:
      - t2_123456
      type: string
      pattern: ^(t2|a2)_.*
      readOnly: true
    components_errors_410:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Theme ID has expired
            code:
              type: integer
              description: The error code.
              examples:
              - 410
    components_errors_429:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 429
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Too Many Requests
    components_schema_pagination:
      type: object
      additionalProperties: false
      properties:
        next_url:
          description: 'The full URL for the next page. If not available, the current page is the final page.

            > **Important:** The URL should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs.

            '
          example: https://ads-api.reddit.com/api/v3?page.token=nextToken
          type:
          - string
          - 'null'
          readOnly: true
        previous_url:
          description: 'The full URL for the previous page. If not available, the current page is the first page.

            > **Important:** The URL should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs.

            '
          example: https://ads-api.reddit.com/api/v3?page.token=previousToken
          type:
          - string
          - 'null'
          readOnly: true
    components_errors_404:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Member ID not found
            code:
              type: integer
              description: The error code.
              examples:
              - 404
    components_errors_400:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 400
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad request.
            fields:
              title: FieldsList
              type: array
              items:
                type: object
                required:
                - field
                - message
                additionalProperties: false
                properties:
                  field:
                    title: FieldName
                    type: string
                    description: The field that caused the error.
                    examples:
                    - field_name
                  message:
                    type: string
                    description: A human friendly error message.
                    examples:
                    - Invalid value.
              description: The fields that caused the error.
    components_schema_lead_gen_form_question:
      title: Lead Gen Form Question
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          description: The question type to show on the form.
          enum:
          - EMAIL
          - FIRST_NAME
          - LAST_NAME
          - PHONE_NUMBER
          - POSTAL_CODE
          - JOB_TITLE
          - COMPANY
          - COMPANY_EMAIL
          examples:
          - EMAIL
        required:
          description: Whether this question must be answered.
          examples:
          - true
          type:
          - boolean
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_400'
    TooManyRequests:
      description: Too many requests. See [Rate Limiting](/docs/v3/guides/quick-start/rate-limiting) for header details and best practices.
      headers:
        RateLimit-Policy:
          description: The rate limit policies that apply to this request (IETF "RateLimit header fields for HTTP" draft). Each comma-separated policy is keyed by a public policy name and lists its quota `q` and window in seconds `w`.
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";q=3000;w=900,"custom-audience-ingestion-burst";q=500;w=60'
        RateLimit:
          description: 'The current rate limit state for each applicable policy (IETF "RateLimit header fields for HTTP" draft): remaining quota `r` and seconds until the window resets `t`. On a 429 the exhausted policy reports `r=0`.'
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";r=0;t=42,"custom-audience-ingestion-burst";r=0;t=5'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_429'
    ServerError:
      description: Server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_500'
    Forbidden:
      description: Insufficient authentication scopes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_403'
    NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_404'
    Unauthorized:
      description: No bearer token or a bad bearer token was provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_401'
    Gone:
      description: The specified resource is no longer available and will not return.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_410'
  parameters:
    components_parameters_page_token:
      description: The token for the page to retrieve.
      in: query
      name: page.token
      schema:
        type: string
    components_parameters_page_size:
      description: The number of items to be returned by page.
      in: query
      name: page.size
      allowEmptyValue: true
      schema:
        type: integer
        maximum: 1000
  securitySchemes:
    RedditAPIKey:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.reddit.com/api/v1/authorize
          refreshUrl: https://www.reddit.com/api/v1/access_token
          tokenUrl: https://www.reddit.com/api/v1/access_token
          scopes:
            adsconversions: Post conversion events through the API
            adsread: Read advertising data through my account.
            adsedit: Write advertising data through my account.
            adsdatadeletion: Delete advertising data through my account.
      description: Reddit OAuth2 Security Key