Create Task Field

POST

Creates a new TaskField 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

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

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
  • DropdownSingle
  • DropdownMulti
optionslist of stringsOptional

A list of options for use of this TaskField. This is only valid if the Type value is set to Dropdown.

When a custom TaskField of type DropDown is shown to a user in the application, they will be able to choose one of the Options in this list.

shortIdstringOptional

The short Id of this field - human readable identity

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

Returns the id of a specific ChangeSet

Query Task Fields
Built with