API ReferenceResource

Create Resource

POST

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.

Headers

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

Request

This endpoint expects an object.
firstName
stringRequired

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.
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.
country
stringOptionalDeprecated

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.

role
stringOptionalDeprecated

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.

teams
list of stringsOptionalDeprecated

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.

skills
list of stringsOptionalDeprecated

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

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.
Built with