Skip to navigation
API ReferenceResource

Create Resource

Create a new Resource within your Workspace.

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.

Headers

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

Request

The details for the new Resource to create
firstNamestringRequired1-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.
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.
colorNamestring or nullOptional
Collaboration Color for this resource. eg. teal, cyan, lightblue, blurple, purple, pink, orange, gray
languagestring or nullOptional
Language code for this Resource.
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 for this resource. If omitted, the workspace default (or 8 hours) is applied.

workingDaysobject or nullOptional

Per-day working hours (Monday … Sunday). When omitted, no resource-specific calendar is created and the workspace calendar applies. Set only the days you need; they merge over the workspace defaults.

countrystring or nullOptionalDeprecated

Deprecated - this property is no longer being used. Please pass in Country data on the CountryCode property.

A text field indicating the country in which this Resource is located. This value is not constrained to the list of known ISO 3166 country names or codes.

rolestring or nullOptionalDeprecated

Deprecated - this property is no longer being used. Please pass in Role data on the RoleId property

The Role privileges associated with this Resource.

Applies to personnel Resources only.

teamslist of strings or nullOptionalDeprecated

Deprecated - this property is no longer being used. Please pass in Team data on the TeamIds property

The list of ResourceTeams to which this Resource belongs.

skillslist of strings or nullOptionalDeprecated

Deprecated - this property is no longer being used. Please pass in Skill data on the SkillIds property

The list of ResourceSkills possessed by this Resource.

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.