Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Events

Update an existing event

Updates an event. Only provided fields are updated. For profileId: omit to keep, null to clear, string to replace.

patch/events/v2/events/{eventId}

Path parameters

eventIdstring required

Event ID or event code

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

eventIdstring

Event ID or event code (e.g., "12345" or "g162795")

profileIdstring nullable

GPS Profile ID. Omit to keep unchanged, send null to clear, or send string to replace.

namestring nullable

Event name

status'lead' | 'proposal' | 'tentative' | 'qualified' | 'definite' | 'open' | 'closed' | 'closed_lost' | 'canceled' nullable

Event status

sourceIdstring nullable

Source ID for the event booking source

startDatestring nullable

Event start date (YYYY-MM-DD). NOTE: Informational only - effective event dates are calculated from linked reservations.

endDatestring nullable

Event end date (YYYY-MM-DD). NOTE: Informational only - effective event dates are calculated from linked reservations.

transactionMode'none' | 'post_into_group' nullable

Transaction routing mode

transactionTypesstring[] nullable

Transaction types to route (required when transactionMode is post_into_group)

folioConfigIdstring nullable

Folio configuration ID

enableAggregateAllotmentBlockboolean nullable

Enable aggregate allotment block feature

aggregateAllotmentBlockPackageIdstring nullable

Package ID for aggregate allotment block

segmentIdstring nullable

Market segment ID

Example request

{
  "eventId": "12345",
  "profileId": "987123456489",
  "name": "Smith Wedding Reception - Updated",
  "status": "definite",
  "sourceId": "ss-123456",
  "startDate": "2025-06-15",
  "endDate": "2025-06-17",
  "transactionMode": "post_into_group",
  "transactionTypes": [
    "accommodation",
    "products"
  ],
  "folioConfigId": "456",
  "enableAggregateAllotmentBlock": true,
  "aggregateAllotmentBlockPackageId": "123",
  "segmentId": "5"
}

Response

Event updated

successboolean required

Success status

Example response

{
  "success": true,
  "data": {
    "id": "12345",
    "eventCode": "g162795",
    "profileId": "987123456489",
    "name": "Smith Wedding Reception",
    "status": "definite",
    "sourceId": "ss-693577",
    "sourceName": "Website/Booking Engine",
    "startDate": "2025-06-15",
    "endDate": "2025-06-17",
    "transactionMode": "post_into_group",
    "transactionTypes": [
      "accommodation",
      "products"
    ],
    "folioConfigId": "456",
    "enableAggregateAllotmentBlock": true,
    "aggregateAllotmentBlockPackageId": "123",
    "segmentId": "5",
    "allotmentBlockCount": 2,
    "reservationsCount": 15,
    "roomsHeld": 20,
    "roomsPickedUp": 15,
    "roomsRemaining": 5,
    "total": {
      "amount": "12439",
      "currencyCode": "USD"
    },
    "grandTotal": {
      "amount": "12439",
      "currencyCode": "USD"
    },
    "paidValue": {
      "amount": "12439",
      "currencyCode": "USD"
    },
    "balanceDue": {
      "amount": "12439",
      "currencyCode": "USD"
    },
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-20T14:45:00Z"
  }
}