API ReferenceTask Field

Create Task Field

Creates a new TaskFields for a specific Project within your Workspace. A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project.

Path parameters

projectIdstringRequired
The unique identifier of the Project within which to create this TaskField

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringOptional
The name of the TaskField
typestringOptional

The type of this TaskField. Valid types are the following:

  • Text
  • Number
  • Date
  • Checkbox
  • Currency
  • Dropdown

Response

This endpoint returns an object.
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
Returns the id of a specific ChangeSet