Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Resources

Update a resource

Update the details of a single resource (required scope resources:write)

patch/v1/resources/{resourceId}

Path parameters

resourceIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

referencestring

The internal reference of the resource - should usually be unique<br/><br/>Optional: Omit to retain current value

namestring

The full name of the resource<br/><br/>Optional: Omit to retain current value

groupIdinteger

The unique identifier of the resource's group<br/><br/>Optional: Omit to retain current value

emailstring

The email address of the resource<br/><br/>Optional: Omit to retain current value

mobilestring

The mobile telephone number of the resource<br/><br/>Optional: Omit to retain current value

timeZoneIdstring

The id of the timezone that the resource operates in<br/><br/>Optional: Omit to retain current value

maxTravelDistanceinteger nullable

The maximum number of kilometres the resource will travel from start location (as crow flies)<br/><br/>Optional: Omit to retain current value or provide null to unset

fuelCardstring

The fuel card number associated to the resource<br/><br/>Optional: Omit to retain current value

businessKeystring

The number associated to the resources business key<br/><br/>Optional: Omit to retain current value

privateKeystring

The number associated to the resources private key<br/><br/>Optional: Omit to retain current value

tachoCardstring

The tachograph driver card number associated to the resource<br/><br/>Optional: Omit to retain current value

isTrackedboolean

Indicates whether tracking data should be collected for this resource<br/><br/>Optional: Omit to retain current value

isTrackedOutOfHoursboolean

Indicates whether out of working hour tracking data is private<br/><br/>Optional: Omit to retain current value

Example request

{
  "reference": "XYZ12345",
  "name": "David Smith",
  "groupId": 441122,
  "email": "david.smith@example.com",
  "mobile": "+447812 123112",
  "timeZoneId": "GMT Standard Time",
  "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

No Content