Create Project Field

POST

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

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

Request

This endpoint expects an object.
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
shortIdstringOptional
The short Id of this field - human readable identity
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.

Response

This endpoint returns an object
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

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.

Built with