API Reference

Update an existing event

patch
https://api.cloudbeds.com/events/v2/events/

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

Path Params
string
required

Event ID or event code

Body Params
string

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

string | null

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

string | null

Event name

string | null
enum

Event status

string | null

Source ID for the event booking source

string | null

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

string | null

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

string | null
enum

Transaction routing mode

Allowed:
transactionTypes
array of strings | null

Transaction types to route (required when transactionMode is post_into_group)

transactionTypes
string | null

Folio configuration ID

boolean | null

Enable aggregate allotment block feature

string | null

Package ID for aggregate allotment block

string | null

Market segment ID

Headers
string
required

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

Responses

Updated 3 months ago

Language
Credentials
OAuth2
Missing 1 required scope
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago