Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Events

Create a new event

Creates a new event associated with an existing group profile or without any profile association.

post/events/v2/events

Headers

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

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

Request body

namestring required

Event name

profileIdstring nullable

GPS Profile ID to link to this event

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

Event status (default: lead)

sourceIdstring required

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'

Transaction routing mode (default: none)

transactionTypesstring[] nullable

Transaction types to route (required when transactionMode is post_into_group)

folioConfigIdstring nullable

Folio configuration ID

enableAggregateAllotmentBlockboolean

Enable aggregate allotment block feature

aggregateAllotmentBlockPackageIdstring nullable

Package ID for aggregate allotment block

segmentIdstring nullable

Market segment ID

Example request

{
  "name": "Smith Wedding Reception",
  "profileId": "987123456489",
  "status": "lead",
  "sourceId": "ss-123456",
  "startDate": "2025-06-15",
  "endDate": "2025-06-17",
  "transactionMode": "none",
  "transactionTypes": [
    "accommodation",
    "products"
  ],
  "folioConfigId": "456",
  "aggregateAllotmentBlockPackageId": "123",
  "segmentId": "5"
}

Response

Event created

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