Update a driver profile

PUT

/drivers/{userId}

curl --request PUT \
  --url https://example.com/drivers/example \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "routingPreferences": "example", "preferredName": "example", "usualVehicleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "licenceNumber": "example", "licenceExpiresOn": "2026-04-15", "homeAddressLine1": "example", "homeAddressLine2": "example", "homeAddressCity": "example", "homeAddressPostcode": "example", "shiftStart": "07:30", "shiftEnd": "07:30", "breakMinutes": 1, "deliveryWindowHours": 1, "anyDeliveryArea": true }'

Update the operational details used to plan and insure a driver: their preferred name, usual vehicle, default start location, loading yard and end location, delivery area (including an explicit any-area choice), shift, optional home address, and driving licence details. The driver and vehicle actually used on a given day remain on the round.

Authorizations

• sessionCookie
  drivers:write
• apiKey
  drivers:write

Parameters

Path Parameters

userId

required

string

Request Body^required

Media typeapplication/json

object

routingPreferences

string

<= 2000 characters

preferredName

string | null

>= 1 characters <= 120 characters

usualVehicleId

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

startLocationId

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

endLocationId

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

yardId

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

licenceNumber

string | null

>= 1 characters <= 80 characters

licenceExpiresOn

string | null format: date

homeAddressLine1

string | null

>= 1 characters <= 200 characters

homeAddressLine2

string | null

>= 1 characters <= 200 characters

homeAddressCity

string | null

>= 1 characters <= 120 characters

homeAddressPostcode

string | null

>= 5 characters <= 8 characters

shiftStart

string | null

/^([01]\d|2[0-3]):[0-5]\d$/

Example

07:30

shiftEnd

string | null

/^([01]\d|2[0-3]):[0-5]\d$/

Example

07:30

breakMinutes

integer | null

<= 240

deliveryWindowHours

Any of:

number

number

Allowed values: 1

number

number

Allowed values: 2

number

number

Allowed values: 3

number

number

Allowed values: 4

number

number

Allowed values: 6

number

number

Allowed values: 8

null

null

anyDeliveryArea

boolean

Responses

200

Saved

Media typeapplication/json

object

routingPreferences

string

<= 2000 characters

userId

required

string

accountName

required

string

role

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string

Allowed values: owner admin driver technical

name

required

string

preferredName

required

string | null

email

string format: email

usualVehicleId

required

UUID v7

string | null format: uuid

usualVehicleName

required

string | null

startLocationId

required

UUID v7

string | null format: uuid

endLocationId

required

UUID v7

string | null format: uuid

yardId

required

UUID v7

string | null format: uuid

yardName

required

string | null

shiftStart

required

string | null

/^([01]\d|2[0-3]):[0-5]\d$/

shiftEnd

required

string | null

/^([01]\d|2[0-3]):[0-5]\d$/

breakMinutes

required

integer | null

deliveryWindowHours

required

Any of:

number

number

Allowed values: 1

number

number

Allowed values: 2

number

number

Allowed values: 3

number

number

Allowed values: 4

number

number

Allowed values: 6

number

number

Allowed values: 8

null

null

anyDeliveryArea

required

boolean

patchIds

required

Array<string>

licenceNumber

required

string | null

licenceExpiresOn

required

string | null format: date

homeAddressLine1

string | null

homeAddressLine2

string | null

homeAddressCity

string | null

homeAddressPostcode

string | null

updatedAt

required

string format: date-time

Example

{
  "role": "owner",
  "usualVehicleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "shiftStart": "07:30",
  "shiftEnd": "07:30",
  "deliveryWindowHours": 1,
  "patchIds": [
    "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  ]
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}