> ## 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.

# Sync CFS records to contests

> Trigger a sync of Customer Feedback System (Full RMS Drip) records into the vendor contest pipeline.
This is an asynchronous operation — returns immediately after initiating the sync.
Returns `200 OK` if there are no unsynced records to process.
Returns `409 Conflict` if a sync is already in progress for this vendor.
Requires the `enableVendorContests` feature to be enabled.




## OpenAPI

````yaml /openapi.yaml post /contests/sync-from-cfs
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:
  /contests/sync-from-cfs:
    post:
      tags:
        - Vendor Contests
      summary: Sync CFS records to contests
      description: >
        Trigger a sync of Customer Feedback System (Full RMS Drip) records into
        the vendor contest pipeline.

        This is an asynchronous operation — returns immediately after initiating
        the sync.

        Returns `200 OK` if there are no unsynced records to process.

        Returns `409 Conflict` if a sync is already in progress for this vendor.

        Requires the `enableVendorContests` feature to be enabled.
      operationId: syncFullRmsDripToVendorContests
      responses:
        '200':
          description: No unsynced CFS records to process
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
              example:
                success: true
                message: No unsynced CFS records to process.
        '202':
          description: Sync initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
              example:
                success: true
                message: >-
                  Sync initiated successfully. Processing will complete in the
                  background.
        '403':
          description: Vendor contests not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
        '409':
          description: Sync already in progress
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
              example:
                success: false
                error: >-
                  A sync is already in progress. You will be notified when it
                  completes.
        '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

````