Add a new driver

x-ms-visibility: "important"

Create a new driver with specified details.

application/json

Request Body required

Details of the driver to be added.

name string
externalId string
homeSiteId int64 nullable
payerId int64 nullable

Responses

• 201
• 400
• 401
• 500

---

The ID of the created driver.

application/json

Schema

Example (from schema)

---

Schema

id int64
externalId string
name string
homeSiteId int64 nullable
payerId int64 nullable
homeSiteName string
tags object[]
Array [
id int64
idTag string
expiringDate date-time
startDate date-time nullable
lastUpdated date-time nullable
tokenName string
invoicable boolean nullable
driverId int64
]
externalUserIds object[]
Array [
referenceType string
referenceId string
externalId string
effectiveFrom date-time nullable
]

{
  "id": 0,
  "externalId": "string",
  "name": "string",
  "homeSiteId": 0,
  "payerId": 0,
  "homeSiteName": "string",
  "tags": [
    {
      "id": 0,
      "idTag": "string",
      "expiringDate": "2025-08-26T05:08:33.422Z",
      "startDate": "2025-08-26T05:08:33.422Z",
      "lastUpdated": "2025-08-26T05:08:33.422Z",
      "tokenName": "string",
      "invoicable": true,
      "driverId": 0
    }
  ],
  "externalUserIds": [
    {
      "referenceType": "string",
      "referenceId": "string",
      "externalId": "string",
      "effectiveFrom": "2025-08-26T05:08:33.422Z"
    }
  ]
}

Details of the validation error.

application/json

Schema

Example (from schema)

---

Schema

type string
title string
status int32 nullable
detail string
instance string
extensions object
property name* object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {}
}

No description

An unexpected error occurred.

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

Loading...