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

# Import referrals

> Records referrals between bookings you've already imported, in the background as a job you poll. See [how imports work](/api-reference/imports).

## How to use it

- Each row names the `referredBookingId`, whose entries count as referral progress, and the `referralCodeOwnerBookingId`, whose referral code gets the credit. The owner booking's referral code is reused, or created if it has none.
- Both bookings must be yours, and their events must be covered by the same active referral program.
- Each entry counts towards one referral at most.
- No bookings or participants are created, and no booking or referral threshold emails are sent.

> [!WARNING]
>
> This endpoint is restricted and not generally available: organizations that have not been enabled receive a `403`. Contact your Let's Do This representative if you'd like access.


## OpenAPI

````yaml /openapi.json post /v0/referrals/import
openapi: 3.1.0
info:
  title: Let's Do This API
  version: 0.1.0
  description: >
    The full reference — getting started, pagination, error responses, rate
    limits and the changelog — lives at

    [partner-help.letsdothis.com/api-reference](https://partner-help.letsdothis.com/api-reference/overview).

    This page is the interactive OpenAPI view of the same specification.


    # Authentication


    Create an API key from **Settings** → **Credentials** in your Let's Do This
    account and send it as a bearer token:


    ```bash

    curl --request GET \
     --url "https://api.letsdothis.com/v0/participants" \
     --header "Authorization: Bearer YOUR-API-KEY"
    ```


    Keep the key secret: it identifies your organization, so do not ship it in a
    website or native app. If a key is exposed,

    revoke it from the same section and create a replacement.


    # OpenAPI schema


    Download the [OpenAPI schema](https://api.letsdothis.com/documentation/json)
    to use with Postman or an OpenAPI client

    generator.
servers:
  - url: https://api.letsdothis.com
    description: Production
  - url: https://api.staging.letsdothis.com
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Events
    x-group: Events
    description: Events that participants can register for.
  - name: EventOccurrences
    x-group: Event occurrences
    description: >-
      Event occurrences scoped to the organizer associated with your Public API
      credentials. Unlike the public Events catalog, results are limited to your
      own events.
  - name: Races
    x-group: Races
    description: >-
      Races within an event occurrence. An event occurrence may have one or more
      races, for example a 5K and a 10K within the same race day.
  - name: Tickets
    x-group: Tickets
    description: Tickets that are available for events.
  - name: BookingForms
    x-group: Booking forms
    description: >-
      Booking forms define the questions a booker answers when registering for a
      ticket. A ticket usually references a single booking form, so expect zero
      or one, while a booking form may be shared across multiple tickets.
  - name: BookingFormFields
    x-group: Booking form fields
    description: >-
      Booking form fields are the individual questions on a booking form — their
      type, label, options, and whether an answer is required. A field can be
      reused across multiple forms.
  - name: Bookings
    x-group: Bookings
    description: >-
      Bookings are the transaction record for a registration. A booking may
      contain one or more participants (entries).
  - name: Membership
    x-group: Memberships
    description: >-
      Membership schemes, purchased policies and the seats on them, owned by
      your organizer. Policies are billing contracts; a seat is one person's
      place on a policy.
  - name: Participant
    x-group: Participants
    description: Participants are users who successfully booked an event.
  - name: LineItem
    x-group: Line items
    description: Financial details related to individual items within transactions.
  - name: AddOns
    x-group: Add-ons
    description: >-
      Your add-on products, such as merchandise or extras, that participants buy
      with their entry. Imported products keep the ids you gave them.
  - name: DiscountCodes
    x-group: Discount codes
    description: >-
      Discount codes participants enter at checkout to reduce the price of a
      booking.
  - name: Credits
    x-group: Credits
    description: >-
      Credits are balances participants can spend at checkout, identified by
      their email address.
  - name: Referrals
    x-group: Referrals
    description: >-
      Referral programs, the referrers registered on them, and asynchronous
      imports of historical referrals.
  - name: Teams
    x-group: Teams
    description: >-
      Teams group participants of an event occurrence under a team program.
      Teams can be imported for participants whose bookings were imported.
  - name: Application
    x-group: Applications
    description: >-
      Applications are created when a user applies for tickets that are set up
      to require an application process, such as balloted or "Good For Age"
      entries.
  - name: Partner
    x-group: Partners
    description: >-
      Partners that were created by the organization who can have Reserved
      Entries assigned to them.
  - name: ReservedEntries
    x-group: Reserved entries
    description: >-
      Reserved Entries are entries that are reserved for a partner. After being
      assigned, the partner can then allocate these entries to participants.
  - name: Timing
    x-group: Timing
    description: >-
      Timing providers push bib numbers and bib-pack shipments back to Let's Do
      This for the startlist entries they received. Available to select timing
      partners only.
  - name: Identity
    x-group: API key
    description: >-
      What your API key can reach. Available to every key, including scoped
      ones.
paths:
  /v0/referrals/import:
    post:
      tags:
        - Referrals
      summary: Import referrals
      description: >-
        Records referrals between bookings you've already imported, in the
        background as a job you poll. See [how imports
        work](/api-reference/imports).


        ## How to use it


        - Each row names the `referredBookingId`, whose entries count as
        referral progress, and the `referralCodeOwnerBookingId`, whose referral
        code gets the credit. The owner booking's referral code is reused, or
        created if it has none.

        - Both bookings must be yours, and their events must be covered by the
        same active referral program.

        - Each entry counts towards one referral at most.

        - No bookings or participants are created, and no booking or referral
        threshold emails are sent.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferralImportRequest'
      responses:
        '202':
          description: >-
            The batch passed the check and was accepted. Poll the job with
            `jobId` to see each row's result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralImportAccepted'
        '400':
          description: >-
            The request is malformed, or the `Idempotency-Key` header is
            invalid. `message` says which.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 400
                  error:
                    type: string
                  message:
                    type: string
        '409':
          description: >-
            This `Idempotency-Key` was already used with a different request
            body. Use a new key for each new batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 409
                  error:
                    type: string
                  message:
                    type: string
        '413':
          description: The batch is too large. Split it into smaller batches.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 413
                  error:
                    type: string
                  message:
                    type: string
        '422':
          description: >-
            Nothing was imported because at least one row has a problem.
            `summary` and `errors` list every problem; fix them and send the
            batch again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralImportValidationFailure'
        '429':
          description: >-
            Too many requests. Wait the number of seconds in `retry-after` when
            the response has it, or back off for a few seconds, then retry.
          headers:
            retry-after:
              schema:
                type: integer
              description: Seconds to wait before retrying the request.
            x-ratelimit-limit:
              schema:
                type: integer
              description: Requests permitted in the current window.
            x-ratelimit-remaining:
              schema:
                type: integer
              description: Requests still permitted in the current window.
            x-ratelimit-reset:
              schema:
                type: integer
              description: Seconds until the current window resets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 429
                  error:
                    type: string
                  message:
                    type: string
components:
  schemas:
    ReferralImportRequest:
      title: ReferralImportRequest
      type: object
      properties:
        referrals:
          type: array
          items:
            $ref: '#/components/schemas/ReferralImportRow'
          description: The referrals to import.
          minItems: 1
          maxItems: 1000
      required:
        - referrals
      additionalProperties: false
      description: >-
        An asynchronous referral import request: the whole batch is accepted or
        none of it.
      example:
        referrals:
          - referredBookingId: 65f708192a3b4c5d6e7f80
            referralCodeOwnerBookingId: 65f708192a3b4c5d6e7f70
    ReferralImportAccepted:
      title: ReferralImportAccepted
      type: object
      properties:
        jobId:
          type: string
          description: The id of the queued import job.
        status:
          type: string
          enum:
            - queued
      required:
        - jobId
        - status
      additionalProperties: false
      example:
        jobId: 66393a4b5c6d7e8f901a2b3c
        status: queued
    ReferralImportValidationFailure:
      title: ReferralImportValidationFailure
      type: object
      properties:
        error:
          type: string
          enum:
            - validation_failed
        message:
          type: string
          description: A human summary of the failure.
        totalRows:
          type: number
          description: How many rows the batch contained.
        rowsWithErrors:
          type: number
          description: How many rows had at least one error.
        errorCount:
          type: number
          description: How many errors were found in total.
        summary:
          type: array
          items:
            $ref: '#/components/schemas/ReferralImportErrorSummary'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ReferralImportRowErrors'
        truncated:
          type: boolean
          description: Whether `errors` was capped. `summary` is never capped.
      required:
        - error
        - message
        - totalRows
        - rowsWithErrors
        - errorCount
        - summary
        - errors
        - truncated
      additionalProperties: false
      description: >-
        The batch failed the check, so nothing was imported. `summary` groups
        every problem by type, most common first, and is never cut short.
        `errors` lists problems row by row and can be cut short for a large
        batch; `truncated` is then `true`.
    ReferralImportRow:
      title: ReferralImportRow
      type: object
      properties:
        referredBookingId:
          type: string
          description: >-
            The id of the booking whose start-list entries count as referral
            progress. Re-importing the same booking returns the original
            referrals, reported as `alreadyImported`.
          minLength: 1
          maxLength: 255
        referralCodeOwnerBookingId:
          type: string
          description: >-
            The id of the booking whose referral code gets the credit. If the
            booking has no referral code yet, the import creates one.
          minLength: 1
          maxLength: 255
      required:
        - referredBookingId
        - referralCodeOwnerBookingId
      additionalProperties: false
      description: One booking credited to another booking's referral code.
    ReferralImportErrorSummary:
      title: ReferralImportErrorSummary
      type: object
      properties:
        code:
          type: string
        fieldId:
          type: string
          description: The row field the class relates to, when field-scoped.
        count:
          type: number
          description: How many times this class occurred across the batch.
        message:
          type: string
          description: A representative message for the class.
        examples:
          type: array
          items:
            $ref: '#/components/schemas/ReferralImportErrorLocator'
          description: The first few occurrences, located.
      required:
        - code
        - count
        - message
        - examples
      additionalProperties: false
      description: One validation problem class, aggregated across the batch.
    ReferralImportRowErrors:
      title: ReferralImportRowErrors
      type: object
      properties:
        referredBookingId:
          type: string
          description: The `referredBookingId` of the row.
        rowIndex:
          type: number
          description: The zero-based position of the row in `referrals`.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ReferralImportErrorDetail'
      required:
        - rowIndex
        - errors
      additionalProperties: false
      description: The per-row detail of a failed validation, grouped by row.
    ReferralImportErrorLocator:
      title: ReferralImportErrorLocator
      type: object
      properties:
        referredBookingId:
          type: string
          description: The `referredBookingId` of the offending row.
        rowIndex:
          type: number
          description: The zero-based position of the offending row in `referrals`.
        value:
          type: string
          description: The offending submitted value, when one exists.
      required:
        - rowIndex
      additionalProperties: false
      description: Where in the batch a validation error occurred.
    ReferralImportErrorDetail:
      title: ReferralImportErrorDetail
      type: object
      properties:
        code:
          type: string
        fieldId:
          type: string
        message:
          type: string
      required:
        - code
        - message
      additionalProperties: false
      description: One occurrence of a validation error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.