Skip to main content
POST
/
customer
/
{customerId}
/
driver
Add Driver
curl --request POST \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/driver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "active": true,
  "activeDate": "2023-11-07T05:31:56Z",
  "groupId": "<string>",
  "groupName": "<string>",
  "tags": [
    "<string>"
  ],
  "keys": [
    {
      "value": "<string>",
      "type": "<string>",
      "isPrivateMode": true
    }
  ]
}
'
{
  "id": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "active": true,
  "activeDate": "2023-11-07T05:31:56Z",
  "groupId": "<string>",
  "groupName": "<string>",
  "tags": [
    "<string>"
  ],
  "keys": [
    {
      "value": "<string>",
      "type": "<string>",
      "isPrivateMode": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

Body

application/json
​
id
string

Unique, unchangeable system generated identifier (alphanumeric) of the driver.

​
customerId
string

MCF customer identifier (alphanumeric).

​
name
string

Name of the driver.

​
active
boolean

Boolean (true / false) to indicate if this is an active driver.

​
activeDate
string<date-time>

The date this driver was set to be active.
UTC, in the format of YYYY-MM-DDThh:mm:ss.
Not included if the driver is inactive (i.e.
active = false)

​
groupId
string

Unique, unchangeable system generated identifier (alphanumeric) of the group assigned to this driver.

​
groupName
string

Name of the group assigned to this driver.

​
tags
string[]

Comma separated list of tags for the driver.

​
keys
object[]

Array of driver keys.

Response

Driver was successfully created.

​
id
string

Unique, unchangeable system generated identifier (alphanumeric) of the driver.

​
customerId
string

MCF customer identifier (alphanumeric).

​
name
string

Name of the driver.

​
active
boolean

Boolean (true / false) to indicate if this is an active driver.

​
activeDate
string<date-time>

The date this driver was set to be active.
UTC, in the format of YYYY-MM-DDThh:mm:ss.
Not included if the driver is inactive (i.e.
active = false)

​
groupId
string

Unique, unchangeable system generated identifier (alphanumeric) of the group assigned to this driver.

​
groupName
string

Name of the group assigned to this driver.

​
tags
string[]

Comma separated list of tags for the driver.

​
keys
object[]

Array of driver keys.