Skip to navigation
API ReferenceResource

Bulk Update Resources

Updates a list of existing Resources in a single API call.

Each entry identifies the Resource to update via its ResourceId and supplies the fields to change. Only fields that are sensible to update across many Resources at once are accepted; see ResourceBulkUpdateDto for the supported fields. The whole request is validated before any changes are applied - if any entry fails validation, no Resources are updated and the individual failures are returned in the AdditionalErrors of the result.

Authentication

AuthorizationBearer

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

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The list of Resources to update
resourceIdstringRequiredformat: "uuid"
The unique identifier of the Resource to update.
firstNamestring or nullOptional<=100 characters
The first name of the person Resource. Applies to personnel Resources only.
lastNamestring or nullOptional<=100 characters
The last name of the person Resource. Applies to personnel Resources only.
phonestring or nullOptional
The phone number associated with this Resource.
citystring or nullOptional
The city where this Resource is located.
statestring or nullOptional
The state or region where this Resource is located. This value is not constrained to a list of known states or regions.
countryCodestring or nullOptional

A text field indicating the country in which this Resource is located. This value must be one of the following: US, NZ, AU.

notesstring or nullOptional

Free-form text notes about this Resource. You may use this field to store extra information about the Resource.

teamIdslist of strings or nullOptional
The list of ResourceTeams to which this Resource belongs.
skillIdslist of strings or nullOptional
The list of ResourceSkills possessed by this Resource.
approverIdstring or nullOptionalformat: "uuid"
The Approver Id associated with this Resource. Applies to personnel Resources only.
colorNamestring or nullOptional
Collaboration Color for this resource. eg. teal, cyan, lightblue, blurple, purple, pink, orange, gray
languagestring or nullOptional

Translation Language for this resource.

e.g. en-US, en-GB, fr-FR, es-ES

publicAvatarIdinteger or nullOptional1-42

Public avatar image index (1-42). The avatar URL is generated as /assets/images/avatars/{index:000}.png. Only numeric public avatars are accepted; custom URLs are not supported.

defaultPlannedHoursdouble or nullOptional

Default planned effort in hours. When set, updates the resource; when omitted, existing value is unchanged.

workingDaysobject or nullOptional

Per-day working hours. When non-null, updates or creates the resource calendar; set only days to change—they merge over workspace defaults.

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
datalist of objectsOptional
If the API call succeeded, this will contain the results.