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

# Update vendor review settings

> Updates review platform enablement, custom SMS/email messages,
primary Google review label, and additional Google review locations (max 5).




## OpenAPI

````yaml /openapi-manager.yaml put /vendors/{vendorId}/review-settings
openapi: 3.0.3
info:
  title: RenovationFind Manager API
  description: >
    Internal REST API for RenovationFind manager operations.


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

    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"
    }

    ```


    ## Partial Updates

    All PATCH endpoints accept partial payloads. Only provided (non-null) fields
    are applied;

    omitted fields remain unchanged. Date fields use `dd/MM/yyyy` format.
  version: 1.0.0
  contact:
    name: RenovationFind
    url: https://www.renovationfind.com
servers:
  - url: https://www.renovationfind.com/rest-manager-api-v1
    description: Production
security:
  - BearerAuth: []
paths:
  /vendors/{vendorId}/review-settings:
    put:
      tags:
        - Review Settings
      summary: Update vendor review settings
      description: >
        Updates review platform enablement, custom SMS/email messages,

        primary Google review label, and additional Google review locations (max
        5).
      operationId: updateVendorReviewSettings
      parameters:
        - name: vendorId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: |
                Update review settings. All fields are optional.
                Review locations array replaces existing locations (max 5).
              properties:
                googleReviewEnabled:
                  type: boolean
                facebookReviewEnabled:
                  type: boolean
                bbbReviewEnabled:
                  type: boolean
                otherReviewEnabled:
                  type: boolean
                otherReviewSiteName:
                  type: string
                customSMSMessage:
                  type: string
                  maxLength: 500
                customEmailMessage:
                  type: string
                  maxLength: 2000
                primaryGoogleReviewLabel:
                  type: string
                  maxLength: 100
                reviewLocations:
                  type: array
                  maxItems: 5
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                        maxLength: 100
                      googleUrl:
                        type: string
                        maxLength: 255
      responses:
        '200':
          description: Settings updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        format: int64
                      googleReviewEnabled:
                        type: boolean
                      facebookReviewEnabled:
                        type: boolean
                      bbbReviewEnabled:
                        type: boolean
                      otherReviewEnabled:
                        type: boolean
                      otherReviewSiteName:
                        type: string
                      customSMSMessage:
                        type: string
                        description: Custom SMS message for review requests (max 500 chars)
                      customEmailMessage:
                        type: string
                        description: >-
                          Custom HTML email message for review requests (max
                          2000 chars)
                      primaryGoogleReviewLabel:
                        type: string
                        description: >-
                          Label for the primary Google review location (max 100
                          chars)
                      reviewLocations:
                        type: array
                        description: Additional Google review locations (max 5)
                        maxItems: 5
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              format: int64
                            label:
                              type: string
                              maxLength: 100
                              description: Location name (e.g. "Vancouver", "Burnaby")
                            googleUrl:
                              type: string
                              maxLength: 255
                              description: Google review URL for this location
                  message:
                    type: string
        '404':
          description: Vendor not found
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````