Connectors
Dispatch Platform connector

create_account

Create a customer account 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
namestringRequired

Account or customer name.

refstringRequired

Unique account reference.

typestringOptional

Account payment type.

CASHINVOICECARD

name_aliasstringOptional

Account alias or group name.

activeintegerOptional

Whether the account is active.

01

priorityintegerOptional

Booking priority from 1 to 5.

profilestringOptional

Booking-source profile.

DISPATCHWEBAPPINCARSTREET

notesstringOptional

Existing internal notes to preserve.

driver_notesstringOptional

Instructions shown to drivers.

addressstringOptional

Invoice address.

primary_contact_namestringOptional

Primary contact name.

primary_contact_phonestringOptional

Primary contact phone number.

emailstringOptional

Invoice email address.

authorization_limitnumberOptional

Authorized amount for the benefit period.

authorization_unitsintegerOptional

Authorized trip units for the benefit period.

max_trip_amountnumberOptional

Maximum authorized amount per trip.

authorization_startstringOptional

Authorization period start date.

authorization_endstringOptional

Authorization period end date.

par_numberstringOptional

Prior Authorization Request number.

mod_codesarrayOptional

Billing modifier codes.

case_workerstringOptional

Case worker name.

date_of_birthstringOptional

Customer date of birth.

watchbooleanOptional

Whether the account needs special monitoring.

office_notesstringOptional

Free-text office notes.

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