Resource

Update Resource

PUT

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.

Path parameters

resourceIdstringRequired
The id of the resource

Request

This endpoint expects an object.
firstName
stringOptional
The first name of the person Resource. Applies to personnel Resources only.
lastName
stringOptional
The last name of the person Resource. Applies to personnel Resources only.
email
stringOptional
The email address of this Resource. Note that this email cannot be changed once it has been assigned.
hourlyRate
doubleOptional
The basic hourly rate for this Resource.
phone
stringOptional
The phone number associated with this Resource.
city
stringOptional
The city where this Resource is located.
state
stringOptional
The state or region where this Resource is located. This value is not constrained to a list of known states or regions.
countryCode
stringOptional
A text field indicating the country in which this Resource is located. This value must be one of the following: US, NZ, AU.
notes
stringOptional
Free-form text notes about this Resource. You may use this field to store extra information about the Resource.
roleId
stringOptional
The Role Id associated with this Resource. Applies to personnel Resources only.
teamIds
list of stringsOptional
The list of ResourceTeams to which this Resource belongs.
skillIds
list of stringsOptional
The list of ResourceSkills possessed by this Resource.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
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.
PUT
$curl -X PUT /api/data/resources/resourceId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "id": "id",
14    "firstName": "firstName",
15    "lastName": "lastName",
16    "email": "email",
17    "hourlyRate": 1.1,
18    "phone": "phone",
19    "city": "city",
20    "state": "state",
21    "country": "country",
22    "notes": "notes",
23    "approver": {
24      "id": "id",
25      "name": "name"
26    },
27    "teams": [
28      {}
29    ],
30    "skills": [
31      {}
32    ],
33    "onlineDateTime": "2024-01-15T09:30:00Z",
34    "role": "role",
35    "isActive": true
36  }
37}
Built with