Connectors
Dispatch Platform connector

create_driver

Create a driver 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
refstringRequired

Unique driver reference.

first_namestringRequired

Driver first name.

last_namestringRequired

Driver last name.

namestringOptional

Full name, derived from first and last name if omitted.

activestringOptional

Whether the driver is active.

01

a_k_astringOptional

Driver alias or nickname.

mobilestringOptional

Mobile number.

phonestringOptional

Phone number.

emailstringOptional

Driver email address.

addressstringOptional

Driver postal address.

psvstringOptional

PSV licence details.

psv_expirystringOptional

PSV expiry in ISO 8601 format.

badge_typestringOptional

Driver badge type.

licencestringOptional

Driving licence details.

licence_expirystringOptional

Licence expiry in ISO 8601 format.

imeistringOptional

Driver device IMEI.

start_datestringOptional

Driver start date or Unix timestamp.

school_badge_expirystringOptional

School badge expiry in ISO 8601 format.

ni_numberstringOptional

National Insurance identifier.

frequencystringOptional

Payment or update frequency.

si_idstringOptional

SI identifier.

passwordstringOptional

Driver app login password.

vehicle_idstringOptional

Vehicle ID to associate with the driver.

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