---
title: "Withdraw a group request"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/cancelGroupRequest"
---

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

# Withdraw a group request

`POST` `/group-requests/{groupReference}/cancel`

Operation ID: `cancelGroupRequest`

**Write.**

## Path parameters

- `groupReference` (string, required)

## Responses

- `200` - Cancelled group request.
- `403` - The API is in read-only mode.
- `404` - Not found, or owned by another partner.
- `409` - Inventory or state conflict.

## 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:
  /group-requests/{groupReference}/cancel:
    post:
      tags:
        - Group Requests
      operationId: cancelGroupRequest
      summary: Withdraw a group request
      description: "**Write.**"
      x-write: true
      parameters:
        - $ref: "#/components/parameters/GroupReference"
      responses:
        "200":
          description: Cancelled group request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/GroupRequest"
        "403":
          $ref: "#/components/responses/WritesDisabled"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    GroupReference:
      name: groupReference
      in: path
      required: true
      schema:
        type: string
        examples:
          - GRP-8K2M4Q
  schemas:
    GroupRequest:
      allOf:
        - type: object
          properties:
            reference:
              type: string
              examples:
                - GRP-8K2M4Q
            status:
              $ref: "#/components/schemas/GroupRequestStatus"
            property_code:
              type: string
            currency:
              type: string
            cancelled_at:
              type:
                - string
                - "null"
              format: date-time
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        - $ref: "#/components/schemas/GroupRequestFields"
    GroupRequestStatus:
      type: string
      enum:
        - received
        - under_review
        - proposal_sent
        - accepted
        - declined
        - cancelled
    GroupRequestFields:
      type: object
      properties:
        event_type:
          type: string
          enum:
            - corporate
            - conference
            - wedding
            - sports_team
            - tour_group
            - other
        group_name:
          type: string
        contact:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
            email:
              type: string
              format: email
            phone:
              type:
                - string
                - "null"
            organisation:
              type:
                - string
                - "null"
        check_in:
          type: string
          format: date
        check_out:
          type: string
          format: date
          description: At most 30 nights after check_in.
        rooms_requested:
          type: integer
          minimum: 10
          maximum: 500
        attendees:
          type:
            - integer
            - "null"
        room_preferences:
          type: array
          items:
            type: object
            required:
              - room_type_code
              - rooms
            properties:
              room_type_code:
                type: string
              rooms:
                type: integer
        needs_meeting_space:
          type: boolean
          default: false
        budget_per_night:
          type:
            - number
            - "null"
          description: Per room
          in the property currency.: null
        notes:
          type:
            - string
            - "null"
    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
  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
  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."
```