openapi: 3.2.0
info:
  title: Hostfully Reviews Bulk API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Reviews-Bulk
paths:
  /api/v3.3/reviews-bulk:
    post:
      tags:
      - Reviews-Bulk
      summary: Create reviews in bulk. The max number of reviews allowed is 100
      operationId: post_4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewBulkAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewBulkApiResponseWrapper'
components:
  schemas:
    ReviewResponseApi3Dto:
      type: object
      properties:
        content:
          type: string
        author:
          type: string
        responseDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
    ReviewBulkApiResponseWrapper:
      type: object
      properties:
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/ReviewApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    ReviewResponseAddingApi3Dto:
      type: object
      properties:
        content:
          type: string
        author:
          type: string
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    ReviewAddingApi3Dto:
      required:
      - author
      - content
      - date
      - propertyUid
      - title
      type: object
      properties:
        propertyUid:
          type: string
        leadUid:
          type: string
        author:
          type: string
        title:
          type: string
        content:
          type: string
        rating:
          type: integer
          format: int32
        date:
          type: string
          format: date
        source:
          type: string
        privateFeedback:
          type: string
        reviewResponse:
          $ref: '#/components/schemas/ReviewResponseAddingApi3Dto'
        ratingCategories:
          type: array
          items:
            $ref: '#/components/schemas/ReviewRatingCategoryApi3Dto'
    ReviewBulkAddingApi3Dto:
      type: object
      properties:
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/ReviewAddingApi3Dto'
    ReviewRatingCategoryApi3Dto:
      type: object
      properties:
        category:
          type: string
          enum:
          - ACCURACY
          - CLEANLINESS
          - CHECKIN
          - COMMUNICATION
          - LOCATION
          - VALUE
        rate:
          type: integer
          format: int32
        comment:
          type: string
    ReviewApi3Dto:
      type: object
      properties:
        uid:
          type: string
        author:
          type: string
        title:
          type: string
        content:
          type: string
        rating:
          type: integer
          format: int32
        date:
          type: string
          format: date
        propertyUid:
          type: string
        leadUid:
          type: string
        source:
          type: string
        privateFeedback:
          type: string
        reviewResponse:
          $ref: '#/components/schemas/ReviewResponseApi3Dto'
        ratingCategories:
          type: array
          items:
            $ref: '#/components/schemas/ReviewRatingCategoryApi3Dto'
        updatedUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true