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

# Batch import referral requests

> Import multiple referral requests at once.
Requires the `enableStandaloneReferralBooster` feature to be enabled.




## OpenAPI

````yaml /openapi.yaml post /referral-requests/batch
openapi: 3.0.3
info:
  title: RenovationFind API
  description: >
    Public REST API for RenovationFind vendor integrations.


    ## Authentication

    All endpoints require a Bearer token in the `Authorization` header.

    Tokens are issued from the RenovationFind Manager Portal.


    ```

    Authorization: Bearer <your_jwt_token>

    ```


    ## Rate Limiting

    API requests are rate-limited to **250 requests per 5 minutes** per vendor.

    When exceeded, the API returns `429 Too Many Requests` with a `Retry-After`
    header.


    ## Response Format

    All responses follow a consistent envelope:

    ```json

    {
      "success": true,
      "data": { ... },
      "message": "Optional message"
    }

    ```

    On error:

    ```json

    {
      "success": false,
      "error": "Error description"
    }

    ```
  version: 1.0.0
  contact:
    name: RenovationFind
    url: https://www.renovationfind.com
servers:
  - url: https://www.renovationfind.com/rest-api-v1
    description: Production
security:
  - BearerAuth: []
paths:
  /referral-requests/batch:
    post:
      tags:
        - Referral Requests
      summary: Batch import referral requests
      description: |
        Import multiple referral requests at once.
        Requires the `enableStandaloneReferralBooster` feature to be enabled.
      operationId: batchImportReferralRequests
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - referralsToImport
              properties:
                referralsToImport:
                  type: array
                  items:
                    type: object
                    required:
                      - firstName
                      - lastName
                    description: >
                      At least one of `emailTo` or `phone` must be provided.

                      Phone numbers are automatically normalized to xxx-xxx-xxxx
                      format.
                    properties:
                      firstName:
                        type: string
                        description: First name of the customer
                        example: John
                      lastName:
                        type: string
                        description: Last name of the customer
                        example: Doe
                      emailTo:
                        type: string
                        format: email
                        description: >-
                          Customer email address. At least one of emailTo or
                          phone is required.
                        example: john@example.com
                      phone:
                        type: string
                        description: >-
                          Customer phone number. At least one of emailTo or
                          phone is required. Automatically normalized to
                          xxx-xxx-xxxx.
                        example: '5551234567'
                      sendGift:
                        type: boolean
                        description: Whether to send a gift with the referral request
                        default: false
                      renewal:
                        type: boolean
                        description: Whether this is a renewal referral request
                        default: false
            example:
              referralsToImport:
                - firstName: John
                  lastName: Doe
                  emailTo: john@example.com
                  phone: '5551234567'
                - firstName: Jane
                  lastName: Smith
                  emailTo: jane@example.com
                  phone: '5559876543'
      responses:
        '201':
          description: Batch import accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
        '403':
          description: Account not enabled for this feature
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
        '429':
          description: Rate limit exceeded (250 requests per 5 minutes)
          headers:
            Retry-After:
              schema:
                type: integer
                example: 300
              description: Seconds to wait before retrying
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
              example:
                success: false
                error: >-
                  Rate limit exceeded. Maximum 250 requests per 5 minutes.
                  Please retry later.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````