API Reference

Create a new event

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

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

Body Params
string
required
length ≤ 255

Event name

string | null

GPS Profile ID to link to this event

string
enum

Event status (default: lead)

string
required

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
enum

Transaction routing mode (default: none)

Allowed:
transactionTypes
array of strings | null

Transaction types to route (required when transactionMode is post_into_group)

transactionTypes
string | null

Folio configuration ID

boolean

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