Locations represent physical spaces that the Organization owns, uses, or wants to associate with Events.
Venues are parent Locations, like a building or campus. Each Venue can have many children Spaces, like rooms or areas.
Create a Location
Creates a Venue or Space based on the provided fields.
Note that this endpoint supports creating both Venues and Spaces. The type of Location to create is determined by the type field in the request body.
Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: orgId, name, color +1 more | |
| type = object · requires: orgId, name, color +2 more |
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisVenue.typeinteger · enum · requiredThe type of the Location -
VenueorSpace0 =
VENUE, 1 =SPACEEnum values:01namestring · requiredcolorstring · requiredHex color code (no
#)pricesobject · requiredA map of
PriceTierids to prices.
coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
detailsstring · htmlSupports basic HTML tags and formatting.
addressobjectA physical address.
Responses
The newly created Venue or Space.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: venue | |
| type = object · requires: space |
venueobject · required
Retrieve a Location
Retrieves the Location with the given id. The returned Location will be either a Venue or a Space, depending on which Location is retrieved.
path Parameters
locationIdstring · uuid · requiredThe id of the
VenueorSpace.
Responses
The requested Venue or Space.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: venue | |
| type = object · requires: space |
venueobject · required
Update a Location
Updates the specified Venue or Space by setting the values of the fields passed. Any fields not passed will remain unchanged. By design, you cannot change a Location's id, nor its type.
You must provide the appropriate payload based on the type of the Location you are updating; for example, if you are updating a Venue, you must provide an UpdateVenueInput payload.
path Parameters
locationIdstring · uuid · requiredThe id of the
VenueorSpace.
Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
namestringcolorstringHex color code (no
#)coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
pricesobjectA map of
PriceTierids to prices.detailsstring · htmlSupports basic HTML tags and formatting.
addressobjectA physical address.
Responses
The updated Venue or Space.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: venue | |
| type = object · requires: space |
venueobject · required