/settings/auto-dispatch

patch

https://api.dev.orbit.do/v5/settings/auto-dispatch

Update automatic dispatch settings for the tenant. Requires update access to CompanyProfile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

isEnabled

boolean

required

Master switch for automatic dispatch. When false, a newly created tour is not dispatched automatically regardless of the other settings.

mode

string

enum

Defaults to simple

'simple' sends instant callouts to carriers qualified by smartDispatchConfig; 'sequence' runs ranked matching Sequences, falling back to sequenceId for legacy configuration. Defaults to 'simple'.

Allowed:

sequenceId

string

Legacy default Sequence id (UUID) used when mode is 'sequence' and no Sequence has a rank; ignored otherwise.

graceSeconds

integer

0 to 600

Defaults to 30

Seconds to wait after a new unassigned tour before automatic dispatch starts. The value must be between 0 and 600; omitted values use 30.

noResultRecipientUserId

string

Fallback recipient for the automatic-dispatch no-result notification added in ORB-3145. Must be an active operator user in this tenant.

smartDispatchConfig

object

required

Responses

400

Invalid settings or no-result recipient

401

Unauthorized

403

Forbidden

404

Tenant not found

200Updated automatic dispatch settings