Connectors
Dispatch Platform connector

create_booking

Create a booking in the approved synthetic demo cluster.
POSTWriteDemo cluster only

This write is restricted to an approved synthetic demo cluster. It is not generally available and must not be used with a production tenant.

Parameters

Parameter Type Required Notes
datestringOptional

Pickup date and time in ISO 8601 format. Omit for ASAP.

namestringRequired

Passenger name.

phonestringRequired

Passenger phone number.

addressobjectRequired

destinationobjectRequired

paymentobjectOptional

sourcestringOptional

Booking source.

APPDISPATCHACCOUNTWEBNETWORKAPPNETWORKWEBIVR

account_idintegerOptional

Account ID for the booking.

vehicle_typestringOptional

Required vehicle type key.

vehicle_groupstringOptional

Generic vehicle group.

instructionsstringOptional

Instructions for the driver.

driver_idintegerOptional

Driver ID to preassign.

vehicle_idintegerOptional

Vehicle ID to preassign.

vehicle_refstringOptional

Vehicle reference to preassign.

site_idintegerOptional

Operational site ID.

planned_dropoff_datestringOptional

Planned dropoff date and time in ISO 8601 format.

idempotency_keystringOptional

Unique key used to prevent duplicate booking creation.

This page documents the restricted write contract. No example payload or response body is included.