API ReferenceProject Field

Create Project Field

Creates a new ProjectField within your Workspace.

A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace.

Headers

AuthorizationstringRequired

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

x-integration-namestringOptional

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

Request

Information about the ProjectField to create

namestringRequired

The name of this Field

typeenumRequired

The type of the Field.

Attempting to create a field with any Type other than these will return an error.

For Dropdown Field types, specify the list of choices in the Options field.

Valid options are:

  • string
  • number
  • date
  • bool
  • currency
  • dropdown-single
  • dropdown-multi
optionslist of stringsOptional

A list of options for use of this ProjectField. 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.

shortIdstringOptionalformat: "^[a-zA-Z0-9_]+$"

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.

statusCodeobjectOptional

The HTTP code of the response.

dataobjectOptional

Represents either a ProjectField or a TaskField, depending on the value of the EntityType for this object.

A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each 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.