---
title: "Submit a verified-stay review"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/createReview"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# Submit a verified-stay review

`POST` `/properties/{propertyCode}/reviews`

Operation ID: `createReview`

**Write.** For one of your reservations at this property with status `checked_out`. One review per reservation.

## Path parameters

- `propertyCode` (string, required) - Property code (case-insensitive).

## Header parameters

- `Idempotency-Key` (string, optional) - Optional. Makes the request safe to retry for 24 hours.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - Published review.
- `403` - The API is in read-only mode.
- `404` - Not found, or owned by another partner.
- `409` - Inventory or state conflict.
- `422` - Invalid input or a booking rule violation.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /properties/{propertyCode}/reviews:
    post:
      tags:
        - Reviews
      operationId: createReview
      summary: Submit a verified-stay review
      description: "**Write.** For one of your reservations at this property with
        status `checked_out`. One review per reservation."
      x-write: true
      parameters:
        - $ref: "#/components/parameters/PropertyCode"
        - $ref: "#/components/parameters/IdempotencyKey"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReviewRequest"
      responses:
        "201":
          description: Published review.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Review"
        "403":
          $ref: "#/components/responses/WritesDisabled"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
        "422":
          $ref: "#/components/responses/ValidationFailed"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    PropertyCode:
      name: propertyCode
      in: path
      required: true
      description: Property code (case-insensitive).
      schema:
        type: string
        examples:
          - KTNYC
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: Optional. Makes the request safe to retry for 24 hours.
      schema:
        type: string
        maxLength: 255
        examples:
          - 8e03978e-40d5-43e8-bc93-6894a57f9324
  schemas:
    ReviewRequest:
      type: object
      required:
        - confirmation_number
        - overall_rating
        - category_ratings
        - title
        - body
        - reviewer_name
        - traveler_type
      properties:
        confirmation_number:
          type: string
        overall_rating:
          type: integer
          minimum: 1
          maximum: 10
        category_ratings:
          type: object
          required:
            - cleanliness
            - comfort
            - location
            - service
            - value
          properties:
            cleanliness:
              type: integer
              minimum: 1
              maximum: 10
            comfort:
              type: integer
              minimum: 1
              maximum: 10
            location:
              type: integer
              minimum: 1
              maximum: 10
            service:
              type: integer
              minimum: 1
              maximum: 10
            value:
              type: integer
              minimum: 1
              maximum: 10
        title:
          type: string
          maxLength: 120
        body:
          type: string
          minLength: 20
          maxLength: 5000
        reviewer_name:
          type: string
          maxLength: 60
          description: Display name
          e.g. first name and initial.: null
        traveler_type:
          $ref: "#/components/schemas/TravelerType"
        language:
          type: string
          default: en
    Review:
      type: object
      properties:
        id:
          type: string
          examples:
            - rev_01jbx4z7a6b5c4d3e2f1g0h9j8
        overall_rating:
          type: integer
          minimum: 1
          maximum: 10
        category_ratings:
          type: object
          properties:
            cleanliness:
              type: integer
            comfort:
              type: integer
            location:
              type: integer
            service:
              type: integer
            value:
              type: integer
        title:
          type: string
        body:
          type: string
        reviewer_name:
          type: string
          examples:
            - Sofia M.
        traveler_type:
          $ref: "#/components/schemas/TravelerType"
        language:
          type: string
        stayed_on:
          type: string
          description: Year and month of the stay.
          examples:
            - 2026-08
        is_verified_stay:
          type: boolean
        management_response:
          type:
            - string
            - "null"
        published_at:
          type: string
          format: date-time
    TravelerType:
      type: string
      enum:
        - solo
        - couple
        - family
        - business
        - friends
    Problem:
      type: object
      description: RFC 9457 problem details. Extra members (e.g. `available_units`,
        `restrictions`, `reasons`) may be present.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
      additionalProperties: true
    ValidationProblem:
      allOf:
        - $ref: "#/components/schemas/Problem"
        - type: object
          properties:
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            restrictions:
              type: array
              items:
                type: string
  responses:
    WritesDisabled:
      description: The API is in read-only mode.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/writes-disabled
            title: Write operations are disabled
            status: 403
            detail: The Kong Hotels partner API is currently read-only. POST requests will
              be enabled in a later phase.
            instance: /quotes
            request_id: 0b7e2c9a-5d41-4e8b-a1f3-6c9d8e7f6a5b
    NotFound:
      description: Not found, or owned by another partner.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/not-found
            title: Resource not found
            status: 404
            detail: Property not found.
            instance: /properties/KXXXX
            request_id: 9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d
    Conflict:
      description: Inventory or state conflict.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          examples:
            roomUnavailable:
              value:
                type: https://developers.konghotels.example/problems/room-unavailable
                title: Room unavailable
                status: 409
                detail: Tower King is not available for the requested stay.
                instance: /quotes
                request_id: 3c2b1a0f-9e8d-4c7b-6a5f-4e3d2c1b0a9f
                available_units: 0
                restrictions:
                  - stop_sell
            invalidState:
              value:
                type: https://developers.konghotels.example/problems/invalid-state
                title: Invalid state for this operation
                status: 409
                detail: Reservation KH4DEMO06 is cancelled and can no longer be changed.
                instance: /reservations/KH4DEMO06/cancel
                request_id: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b
    ValidationFailed:
      description: Invalid input or a booking rule violation.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ValidationProblem"
          examples:
            validation:
              value:
                type: https://developers.konghotels.example/problems/validation-failed
                title: Validation failed
                status: 422
                detail: One or more fields are invalid.
                instance: /quotes
                request_id: 7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b
                errors:
                  check_out:
                    - The check out field must be a date after check in.
            bookingRule:
              value:
                type: https://developers.konghotels.example/problems/booking-rule-violation
                title: Booking rule violation
                status: 422
                detail: Rate plan ADV cannot be sold for these dates.
                instance: /quotes
                request_id: 8f7e6d5c-4b3a-4f2e-9d1c-0b9a8f7e6d5c
                restrictions:
                  - min_advance_purchase
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```