Update a resource

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

Path Parameters

resourceId int64 required

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

reference string

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

name string

The full name of the resource
Optional: Omit to retain current value

groupId int64

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

email string

The email address of the resource
Optional: Omit to retain current value

mobile string

The mobile telephone number of the resource
Optional: Omit to retain current value

timeZoneId string

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

maxTravelDistance int32 nullable

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

fuelCard string

The fuel card number associated to the resource
Optional: Omit to retain current value

businessKey string

The number associated to the resources business key
Optional: Omit to retain current value

privateKey string

The number associated to the resources private key
Optional: Omit to retain current value

tachoCard string

The tachograph driver card number associated to the resource
Optional: Omit to retain current value

isTracked boolean

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

isTrackedOutOfHours boolean

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

workingHours object[]
The resources working hours / shifts, expressed relative to timeZoneId. If this field is supplied it will overwrite any existing working hours in the resource
Optional: Omit to retain current value
Array [
dayOfWeek DayOfWeek required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
Possible values:
• sunday
• monday
• tuesday
• wednesday
• thursday
• friday
• saturday
start time required
The 24H format time of day that the resource starts their shift (hh:mm)
stop time required
The 24H format time of day that the resource stops their shift (hh:mm)
startAtContactId int64 nullable
The unique identifier of the contact (location) that the resource starts this shift from
]
customFields object[]
Custom fields associated with the resource. Omit or use an empty list to retain current values
Optional: Omit to retain current value
Array [
definitionId int64 required
The unique identifier of the associated custom field definition
value string nullable
The value of this custom field. If set to null, any existing value will be unset
]

Responses

• 204
• 400
• 403
• 404
• 422
• 500

---

No Content

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Not Found

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...