Edit - Trucker user

PUT 
/api/trucker/:id

Edit a trucker user associated with your company. Keep in mind that the email and tax ID cannot be repeated.

Request

Path Parameters

id stringrequired

Header Parameters

apikey stringrequired

Apikey of a company linked to a user

application/json

Body

name stringrequired

Name of the trucker.

email stringrequired

Trucker email (Must be unique)

phone string

Trucker's phone.

taxid stringrequired

Truck driver's identity document (Must be unique).

Responses

200

Example response

application/json

Schema

Schema

status integer
data object

_id string

position object

Array of services and their last known position

deliveries object[]

role string

Account role ("driver", "dev", "manager" or "admin")

status boolean

Account status (Locked or active in boolean).

reason string

Account blocking reason.

emailVerified boolean

Boolean that indicates whether the email is verified.

phone string

Trucker's phone.

country string

Country of residence of the trucker.

timezone string

Trucker time zone.

image string

Trucker image.

recovery_token string

Password recovery token.

i18n string

Language of the trucker user.

deleted boolean

Boolean indicating whether the user has been deleted.

name string

Name of the trucker.

lastname string

Truck driver's last name.

email string

Trucker email (Must be unique)

taxid string

Truck's identity document (Must be unique).

password string

Hashed password of the trucker account.

Example (from schema)

{
  "status": 0,
  "data": {
    "_id": "65e1fc46a39d32135b12c7e0",
    "position": {
      "deliveries": []
    },
    "role": "driver",
    "status": true,
    "reason": "NONE",
    "emailVerified": false,
    "phone": "34668936908",
    "country": "esp",
    "timezone": "europe/madrid",
    "image": "",
    "recovery_token": "XXX",
    "i18n": "es",
    "deleted": false,
    "name": "Name",
    "lastname": "Lastname",
    "email": "email@example.com",
    "taxid": "12345678A",
    "password": "XXX"
  }
}

Example 1

{
  "status": 200,
  "data": {
    "_id": "65e5ef1851342f8dec7aa2d1",
    "name": "Name",
    "image": "",
    "phone": "123456789",
    "taxid": "12345678A",
    "email": "email@example.com",
    "createdAt": "2024-03-04T15:56:08.868Z",
    "updatedAt": "2024-03-04T15:56:08.958Z"
  }
}

Loading...