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 Note
  • Booking Note
  • Example Request
  • Returns
  • Throws
  • Booking Note Type
  • Template Applies To
  1. Venue
  2. Booking Data

Add or Update Booking Note

Add or Update Booking Note

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

Adds or updates the details of a venue booking note.

Booking Note

Property
Type
Required
Description

id

integer

optional

The unique id of the booking note to update. If property is omitted, it will create a new note

venueId

integer

required

The id of the venue to which the booking note belongs

bookingId

integer

required

The id of the booking to which the booking note will be assigned.

description

string

required

The description of the booking note.

isPrivate

bool

optional

Whether or not the booking note is accessible to all.

typeId

integer

optional

bookingDays

array

optional

The days of the booking. Required when typeId is one of 3 11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31,32,33,34,35,36,37

accommodationIds

array

optional

The array of an ids of the booking accommodation. Required when typeId = TYPE_BOOKING_ACCOMMODATION

sessionIds

array

optional

The array of an ids of the booking session. Required when typeId = TYPE_SESSION

menuIds

array

optional

The array of an ids of the booking session menu. Required when typeId = TYPE_SESSION_MENU

beverageIds

array

optional

The array of an ids of the booking beverage. Required when typeId = TYPE_SESSION_BEVERAGE

resourceIds

array

optional

The array of an ids of the booking resource. Required when typeId = TYPE_SESSION_RESOURCE

productIds

array

optional

The array of an ids of the booking product. Required when typeId = TYPE_SESSION_PRODUCT

applyToTemplates

array

optional

Example Request

{
    "id": 5,
    "venueId": 1,
    "bookingId": 110,
    "description": "test description",
    "typeId": 23,
    "bookingDays": [1,2],
    "applyToTemplates": [1,2]
}

Returns

Property
Description

success

Whether or not the booking attendee was added/updated

id

The unique id of the booking attendee that was added/updated

Throws

Code
Description

Specific Code: 24442

The booking note does not exist

Specific Code: 24443

An error has occurred

Specific Code: 24444

The request contains invalid data

Specific Code: 24445

The request contains invalid data

Booking Note Type

Type
Description

3

Billing Instructions

8

Accommodation

11

Couriers

12

VIP Guests

13

Security

14

Onsite Contractors

15

Signatories

16

Front Office

17

Transfers

18

Room Drops

19

Laguage Services

20

Group Profile

21

Lead

2

Session

4

Menu

5

Beverage

7

Products

6

Resources

22

Dietary Requirements

23

All Departments

24

Food & Beverages

25

Car Parking

26

Suppliers

27

Internet

29

Signage

30

Sales office

31

Bellman / Van Service

32

Reservations

33

Housekeeping

34

Engineering

35

Audio Visual

36

Set-up

37

Onsite Contat

Template Applies To

Type
Description

1

Beo

2

Quotes & Contracts

3

Resume

PreviousAdd or Update Booking AttendeeNextAdd or Update Booking Session

Last updated 8 months ago

The of the booking note.

The in booking notes.

type
'Template Applies To'