Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Resources

Create a resource

Create a new resource (required scope resources:write)

post/v1/resources

Headers

Customer-Idinteger required

The customer identifier

Request body

referencestring nullable

The internal reference of the resource - should usually be unique

namestring required

The full name of the resource

groupIdinteger required

The unique identifier of the resource's group

mobilestring nullable

The mobile telephone number of the resource

maxTravelDistanceinteger nullable

The maximum number of kilometres the resource will travel from start location (as crow flies)

fuelCardstring nullable

The fuel card number associated to the resource

businessKeystring nullable

The number associated to the resources business key

privateKeystring nullable

The number associated to the resources private key

tachoCardstring nullable

The tachograph driver card number associated to the resource

isTrackedboolean

Indicates whether tracking data should be collected for this resource

isTrackedOutOfHoursboolean

Indicates whether out of working hour tracking data is private

Example request

{
  "reference": "XYZ12345",
  "name": "David Smith",
  "groupId": 441122,
  "mobile": "+447812 123112",
  "maxTravelDistance": 5,
  "fuelCard": "01234567891234",
  "businessKey": "1231231",
  "privateKey": "414221",
  "tachoCard": "DRI0RDW0000000100",
  "isTracked": true,
  "workingHours": [
    {
      "dayOfWeek": "sunday",
      "start": "09:00",
      "stop": "17:00",
      "startAtContactId": 1241551
    }
  ],
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

Created

idinteger

Identifier of the newly created record