iVvy Developer API
  • API Documentation
  • Getting Started
    • Obtaining Keys
    • Creating the request
      • Method/URI Header
      • Request Headers
        • Standard Headers
        • Custom Headers
      • Signing the request
      • Query Parameters
    • Test Ping
    • Interpreting the response
      • Collections
      • Pagination
      • Filtering
      • Exceptions
      • Response Headers
      • Dates
    • Batch
      • Run
      • Progress
      • Result
      • Restart
      • Repost
    • Use Cases
      • CRM Systems
      • Financial Accounting Systems
      • Point Of Sale
      • Property Management Systems
  • Contacts & Companies
    • Get Contact List
    • Get Contact
    • Get Contact Note List
    • Add or Update Contact
    • Get Contact Custom Field Definition
    • Get Company Custom Field Definition
    • Get Subscription Group List
    • Add Contacts To Subscription Group
    • Remove Contacts From Subscription Group
    • Get Company List
    • Get Company
    • Get Company Note List
    • Add or Update Company
    • Add or Update Lead
    • Add or Update Contact Note
    • Add or Update Company Note
  • Event
    • Add or Update Event
    • Get Event List
    • Get Event
    • Get Registration
    • Get Registration List
    • Get Attendee
    • Get Attendee List
    • Get Invited Contact List
    • Invite Contacts
    • Get Sponsorship List
    • Get Speaker List
    • Get Session List
    • Create Login Token
  • Venue
    • Venue Setup Data
      • Get Venue
      • Get Venue List
      • Get Venue Room List
      • Get Venue Room Option List
      • Get Venue Rate Plan List
      • Get Venue Rate Plan Rate List
      • Get Venue Rate Plan Room Rate List
      • Get Resource List
      • Get Resource Availability
      • Get Menu List
      • Get Beverage Package List
      • Get Function Space List
      • Get Space Blockout List
      • Get Function Space Category List
      • Get Function Space Availability
      • Get Function Space Hire Plan Rate List
      • Get Function Space Hire Plan Rate
      • Get Cost Center List
      • Get Session Type List
      • Get Revenue Template List
      • Get Tax List
      • Add or Update Function Space
      • Get Event Type List
      • Add or Update Function Space Category
      • Add or Update Guest Room
      • Get Booking Custom Field List
      • Get Space Hire Plans
      • Get Venue Package List
      • Get Venue Package
    • Booking Data
      • Convert Lead To Opportunity
      • Add or Update Opportunity
      • Get Booking
      • Get Booking List
      • Get Booking List For Account
      • Get Booking Notes
      • Get Booking Session List
      • Get Booking Session Menu List
      • Get Booking Changelog List
      • Get Booking Attendee (By Hash)
      • Get Booking Attendee List
      • Get Booking Release Schedule
      • Add or Update Booking
      • Change Booking Status
      • Add Items To Booking
      • Add Payment To Booking
      • Add Refund To Booking
      • Add or Update Booking Attendee
      • Add or Update Booking Note
      • Add or Update Booking Session
      • Add or Update Booking Session Beverage
      • Add or Update Booking Session Menu
      • Add or Update Booking Session Resource
      • Remove Booking Session
      • Remove Booking Session Beverage
      • Remove Booking Session Menu
      • Remove Booking Session Resource
      • Get Space Blockout List
      • Add or Update Blockout Space
      • Remove Blockout Space
      • Get Booking Tax List
      • Add or Update Opportunity Note
      • Upload Booking Document
    • Booking Accommodation Data
      • Get Booking Accommodation List
      • Add or Update Booking Accommodation
      • Remove Booking Accommodation
      • Get Booking Room Reservation List
      • Add or Update Booking Room Reservation
      • Update Room Reservation Guest Contact
      • Remove Booking Room Reservation
      • Confirm Booking Room Reservation
      • Cancel Booking Room Reservation
      • Change Status of Booking Room Reservation
      • Add or Update Room Counts
      • Add or Update Room Dynamic Rates
      • Remove Room Dynamic Rates
      • Add or Update Rate Plan Booking Rules
  • Partner
    • Get Venue List
    • Get Venue
  • Invoice
    • Get Invoice List
    • Get Invoice
    • Get Options
    • Add Payment
    • Get Credit Note List
    • Get Credit Note
  • Account
    • Add or Update Cost Center
    • Get Cost Center List
    • Get Email Log List
    • Add Error Report
    • Get Account User List
  • CRM
    • Get Lead List
    • Get Opportunity List
    • Get Opportunity Note List
    • Get Task List
    • Get Activity List
    • Get Lead Stage List
    • Get Lead Type List
    • Get Lead Quality List
    • Get Lead Source List
    • Get Lead Channel List
    • Get Lead Note List
    • Add or Update Activity Purpose
    • Add or Update Activity
    • Add or Update Task
    • Add or Update Lead Quality
    • Add or Update Lead Stage
    • Add or Update Lead Channel
    • Add or Update Lead Type
    • Add or Update Lead Source
    • Add or Update Lead Note
  • Notifications
    • Company Endpoint
    • Contact Endpoint
    • CRM Endpoint
    • Invoice Endpoint
    • Booking Endpoint
    • Event Endpoint
  • Development Reference
    • Calculating md5
    • HMAC-SHA1
    • JSON Encoding
    • Timestamp Format
    • Date Format
    • Time Format
    • Address Format
    • URLEncoding
    • Timezone List
  • Announcements
    • Room Reservation Contact Changes
    • Contact Customfield Changes
    • Booking Accommodation API Changes
Powered by GitBook
On this page
  • Add or Update Booking Session
  • Booking Session
  • Example Request
  • Returns
  • Throws
  1. Venue
  2. Booking Data

Add or Update Booking Session

Add or Update Booking Session

POST [PlatformAddress]/api/1.0/venue?action=addOrUpdateBookingSession

Adds or updates the details of a venue booking session. NOTE: The venue must have access to add or update booking session in order to call this api action.

{
  "success": true,
  "id": 8821,
  "warnings": null
}
{
  "errorCode": 400,
  "message": "The request contains invalid data",
  "specificCode": 24337,
  "additionalMessages": [
      "costcenterId: *Value is required and can't be empty*"
  ]
}
{
  "errorCode": 500,
  "message": "An error has occurred",
  "specificCode": 24335,
  "additionalMessages": []
}

Booking Session

Property
Type
Required
Description

id

integer

optional

The unique id of the booking session to update. A new booking session will be created if this parameter is not present.

spaceVenueId

integer

required

The id of the venue to which the booking session belongs.

bookingId

integer

required

The id of the booking to which the new booking session will be assigned.

contactId

integer

required

The id of the booking to which the new booking session will be assigned.

name

string

required

The booking session name. Required when adding a new booking session.

minAttendeesGuaranteed

integer

optional

The total attendees of the booking session. Required when adding new booking session.

agreedAttendees

integer

optional

The agreed attendees of the booking session.

expectedAttendees

integer

optional

The expected attendees of the booking session.

guaranteedAttendees

integer

optional

The guaranteed attendees of the booking session.

setAttendees

integer

optional

The set attendees of the booking session.

actualAttendees

integer

optional

The actual attendees of the booking session.

spaceId

integer

optional

The id of the space to which the booking session belongs.

spaceLayout

integer

optional

The id of the space layout to which the booking session belongs.

layoutType

integer

optional

customLayoutName

string

optional

The name of custom space layout.

startDate

date

required

Start date of the sesion.

startTime

string

optional

The start time of the booking session. Format is HH:mm:ss

endTime

string

optional

The end time of the booking session. Format is HH:mm:ss

setupTime

integer

optional

The setup time (in mins) of the booking session.

setdownTime

integer

optional

The setdown time (in mins) of the booking session

includeInPackage

boolean

optional

Whether or not the booking session is included in booking package.

bookingPackageId

integer

optional

The id of the booking package to which the booking session belongs. Required when includeInPackage is true

tariffId

integer

optional

The tariff id to which the booking session belongs. Required when includeInPackage is true

roomHireType

integer

optional

The room hire type to which the booking session belongs. Required when includeInPackage is true

costcenterId

integer

optional

The id of the cost center to which the booking session belongs. Required when adding new booking session

cost

double

optional

The price of the booking session. Required when includeInPackage is false

excludedTaxIds

array

optional

The array of tax Ids which are excluded to apply on the booking session. Required when includeInPackage is false

sessionTypeId

integer

optional

The session type id to which the session belogns

overridePax

bool

optional

Whether or not to over ride max pax of the space

isSignageVisible

bool

optional

isSignageVisible

signage

string

optional

Signage of the booking session

Example Request

{
  "venueId": 1,
  "bookingId": 15722,
  "spaceVenueId": 1,
  "name": "test",
  "contactId": 10,
  "minAttendeesGuaranteed": 10,
  "spaceId": 3,
  "spaceLayout": 0,
  "customLayoutName": "test",
  "startDate": "2020-10-28",
  "startTime": "10:00:00",
  "endTime": "11:00:00",
  "setupTime": "60",
  "setdownTime": "60",
  "includeInPackage": 0,
  "bookingPackageId": 2018,
  "tariffId": "1",
  "roomHireType": "1",
  "costcenterId": "4",
  "cost": "400",
  "excludedTaxIds": []
}

Returns

Property
Description

success

Whether or not the session is added/updated to the booking

id

The unique id of the Booking Session

Throws

Code
Description

Specific Code: 24360

The booking does not exist

Specific Code: 24361

The session does not exist

Specific Code: 24362

An error has occurred

Specific Code: 24363

The request contains invalid data

Specific Code: 24364

The request contains invalid data

PreviousAdd or Update Booking NoteNextAdd or Update Booking Session Beverage

Last updated 1 month ago

The of the space layout to which the booking session belongs. (This key will only consider when you don't pass spaceLayout key in request data)

type