Change Booking Status

Change Booking Status

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

Changes the current status of a venue booking.

200

{
  "success": true,
  "id": 1234,
}

400

{
    "errorCode": 400,
    "message": "The request contains invalid data",
    "specificCode": 24397,
    "additionalMessages": [
        "convertedStageId: *Value is required and can't be empty*"
    ]
}

500

{
  "errorCode": 500,
  "message": "An error has occurred",
  "specificCode": 24346,
  "additionalMessages": []
}

Request Details

Property	Type	Required	Description
id	integer	required	The unique id of the booking whose status will be changed.
venueId	integer	required	The unique id of the venue to which the booking belongs.
currentStatus	Current Status	required	The new status to assign the booking.
changedByUserId	integer	optional	The unique id of the user who changed the status of the booking. The user assigned to the api key will be used when this parameter is not set.
cancelStageId	integer	optional	The id of the stage to assign to the opportunity when cancelling a quote (i.e. changing from a prospective status to cancelled).
cancelReasonId	integer	optional	The id of the stage reason to assign to the opportunity/booking being cancelled. When cancelling a quote (i.e. changing from a prospective status to cancelled), the value must belong to the "cancelStageId" stage. When cancelling a booking, the value must belong to the "cancelled" stage.
cancelLostToCompetition	string	optional	A description of how the cancelled booking was lost to competition.
cancelClosedDate	date	optional	The date when booking was cancelled. Required when the booking status is changing to cancelled.
convertedStageId	integer	optional	The id of the stage to assign to the opportunity to which the booking belongs. Required when changing the status to anything but cancelled.
convertedStageReasonId	integer	optional	The id of the stage reason to assign to the opportunity to which the booking belongs. Can be set when changing the status to anything but cancelled.
marketplaceStageReasonType	Marketplace Stage Reason Type	optional	This is the official regretted reason that will be sent to the booker when the opportunity is regretted. Required when "convertedStageId" is the regretted stage.
convertedClosedDate	date	optional	The date when quote (ie. a prospective status) is being converted to booking (ie. Tentative or Confirmed). Required when booking is being closed (i.e. Prospective/ProspectiveHold to Tentative or Confirmed and lead stage is either won or lost).

Booking Status

The following booking status options are supported.

Value	Description
1	Prospective
2	Tentative
3	Confirmed
4	Cancelled
9	Prospective Hold

Marketplace Stage Reason Type

The following marketplace stage reason are supported

Value	Description
1	Accommodation unavailable
2	Accommodation capacity - too small
3	Conference/Event space unavailable
4	Conference/Event space capacity - too small
5	Conference/Event space capacity - too big
6	Facilities not suitable
7	No reason given