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.

Request

This endpoint expects an object.
namestringRequired

The name of this Field

typestringRequired

The type of the Field. Valid types are the following:

  • Text
  • Number
  • Date
  • Currency
  • Dropdown

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

For Dropdown Field, specify the list of choices in the Options field. TODO - This object needs to support a list of options, in case dropdown is selected

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

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.