Skip to navigation
API ReferenceResource

Update Resource

Updates an existing Resource based on information you provide.

A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user.

Authentication

AuthorizationBearer

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

Path parameters

resourceIdstringRequiredformat: "uuid"
The id of the resource

Headers

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

Request

The information to update the resource
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.

emailstring or nullOptional

The email address of this Resource.

Note that this email cannot be changed once it has been assigned.

hourlyRatedouble or nullOptional>=0
The basic hourly rate for this Resource.
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.

roleIdstring or nullOptionalformat: "uuid"

The Role Id associated with this Resource.

Applies to personnel Resources only.

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.
isActiveboolean or nullOptional

Active/Inactive the 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.

clearAvatarboolean or nullOptional
When true, removes the resource's custom avatar so the default initials are shown.
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.
dataobjectOptional
A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user.